Статьи о технической документации
Практические разборы: как написать техническое задание и руководство пользователя, как оформить отчет, титульный лист, таблицы и список литературы по ГОСТ, чем отличаются стадии и виды испытаний и что изменилось в новых стандартах.
Каждая статья опирается на тексты стандартов и шаблоны с этого сайта: по ссылкам можно сразу открыть нужный ГОСТ или скачать заготовку документа.
Требования и техническое задание
Требования и техническое заданиеКак написать техническое задание: структура, требования, примерПошаговый порядок написания ТЗ, типовая структура с пунктами, примеры формулировок требований и разбор типичных ошибок.
Требования и техническое заданиеФункциональные и нефункциональные требования: разница и примерыЧем функциональные требования отличаются от нефункциональных, как их формулировать и проверять, с примерами и таблицами.
Требования и техническое заданиеБизнес-требования: что это, как собрать и оформитьЧто такое бизнес-требования, как их собрать, оформить в виде документа и связать с функциональными требованиями и ТЗ.
Требования и техническое заданиеТЗ на разработку сайта: структура и примерИз чего состоит ТЗ на сайт, что включить в страницы, функции и приемку, с образцом фрагмента и списком ошибок.
Требования и техническое заданиеЧастное техническое задание (ЧТЗ): когда нужно и как составитьКогда нужно частное ТЗ на подсистему, чем оно отличается от общего задания, из чего состоит и как его согласовывать.
Требования и техническое заданиеГОСТ 34.602-2020: что изменилось в ТЗ на автоматизированную системуЧто изменилось в новой редакции стандарта на ТЗ для автоматизированных систем и как перейти на нее с ГОСТ 34.602-89.
Оформление документов по ГОСТ
Оформление документов по ГОСТТитульный лист по ГОСТ: как оформить для отчета и технического документаКакие элементы входят в титульный лист отчета и технического документа, как их расположить и какие ошибки встречаются чаще всего.
Оформление документов по ГОСТЛист утверждения: что это и как оформить по ГОСТСостав листа утверждения, код ЛУ, отличие от титульного листа и пошаговый порядок оформления.
Оформление документов по ГОСТОформление текстового документа по ГОСТ 2.105-2019: поля, шрифт, нумерацияПоля, шрифт, интервалы, нумерация страниц и разделов, перечисления и приложения по ГОСТ 2.105-2019.
Оформление документов по ГОСТОформление таблиц и рисунков по ГОСТ: нумерация, подписи, ссылкиПодписи, нумерация, ссылки и перенос таблиц, подписи и пояснения к рисункам по ГОСТ 2.105.
Оформление документов по ГОСТСписок литературы по ГОСТ Р 7.0.100-2018: правила и примерыСпособы расположения источников, образцы записей для книг, статей, сайтов и стандартов, оформление ссылок в тексте.
Оформление документов по ГОСТОтчет о НИР по ГОСТ 7.32-2017: структура и правила оформленияСтруктурные элементы отчета о НИР, реферат, ключевые слова, правила оформления и порядок подготовки по ГОСТ 7.32-2017.
Оформление документов по ГОСТОбозначение документов: децимальный номер ЕСКД и код по ГОСТ 19.103Как устроен децимальный номер ЕСКД и обозначение программного документа по ГОСТ 19.103-77, с разбором по частям.
Оформление документов по ГОСТБлок-схема алгоритма по ГОСТ 19.701-90: элементы и примерыКакие фигуры использует блок-схема по ГОСТ 19.701-90, как их соединять и как нарисовать схему цикла на примере.
Оформление документов по ГОСТГлоссарий и раздел "Термины и определения": как составитьКак составить глоссарий и раздел "Термины и определения": отбор терминов, формулировки, источники и пример таблицы.
Эксплуатационная документация
Эксплуатационная документацияКак написать руководство пользователя информационной системыСтруктура, порядок написания и примеры шагов для руководства пользователя программы или информационной системы.
Эксплуатационная документацияРуководство администратора: структура и что в нем описатьИз каких разделов состоит руководство администратора и что важно описать, чтобы систему можно было сопровождать без разработчика.
Эксплуатационная документацияЭксплуатационная документация: виды и состав для программ и системКакие документы входят в эксплуатационную документацию, чем они различаются и как определить минимальный комплект для своего проекта.
Эксплуатационная документацияПаспорт и формуляр системы: в чем разница и как заполнитьРазница между паспортом и формуляром, структура разделов и порядок заполнения с примером для информационной системы.
Стадии создания и испытания
Стадии создания и испытанияКак написать программу и методику испытаний (ПМИ)Структура ПМИ, таблица проверок с примером, нагрузочные требования и ошибки, которые чаще всего находит комиссия.
Стадии создания и испытанияОпытная эксплуатация информационной системы: порядок и документыКак подготовить, провести и завершить опытную эксплуатацию: программа, журнал, акты и критерии завершения.
Стадии создания и испытанияАкт приемки работ по разработке ПО: как составитьРеквизиты, пошаговое заполнение и образец формулировок акта приемки работ по разработке ПО.
Стадии создания и испытанияГОСТ Р 59793-2021: стадии создания АС вместо ГОСТ 34.601-90Стадии создания АС по ГОСТ Р 59793-2021, их отличия от ГОСТ 34.601-90 и документы каждой стадии.
Стадии создания и испытанияГОСТ Р 59792-2021: виды испытаний автоматизированных системВиды испытаний АС по ГОСТ Р 59792-2021, их цели, порядок проведения и документы по итогам.
Стадии создания и испытанияЭскизный и технический проект: чем отличаются и что входитЧем эскизный проект отличается от технического, какие документы входят в каждый и когда стадии объединяют.
Основы документирования
Основы документированияЕСПД и ЕСКД: в чем разница и какие стандарты применятьЧем ЕСПД отличается от ЕСКД, какие стандарты входят в каждую систему и как выбрать нужную.
Основы документированияТехнический писатель: чем занимается и как им статьЧем занимается технический писатель, какие навыки нужны и как стать техническим писателем без опыта.
Основы документированияВиды технической документации: проектная, рабочая, эксплуатационнаяКакие виды технической документации существуют, чем отличаются проектная, рабочая и эксплуатационная и что входит в комплект.