462 прочтения · 1 год назад
ГОСТ 34. Шаблоны 7 основных документов. Бери и применяй!
Если нужна Заказчику документация по ГОСТ 34, то существует 7 основных документа: - ТЗ — Техническое задание. - ПЗ — Пояснительная записка или Описание системы. - СР — Схема развертывания системы. - API — Описание протокола взаимодействия с внешними системами. - РА— Руководство системного администратора. - РП — Руководство пользователя. - ПМИ — Программа и методика испытаний. Шаблоны документов В шаблонах документов есть реальная обезличенная информация как пример заполнения, нужно ее отредактировать, либо заменить информацией по нужной системе. ТЗ — Техническое задание Техническое задание создает сама компания-заказчик программного обеспечения...
1,5K прочтений · 1 год назад
Как писать пояснительную записку к проекту
В этой статье я расскажу, как техническому писателю сделать один из основных проектных документов - пояснительную записку. Для того, чтобы сделать хороший документ, нужно понимать, о чем этот документ должен быть. Основное назначение пояснительной записки - описать проектируемый объект в целом: кратко о том, какой он должен быть и подробно о том, как это будет достигнуто. Выделим то, что должно быть именно в пояснительной записке любого вида проекта: Такое разделение документа на две части - логическое...