Рекомендации по выбору документов

Рекомендации по выбору документов

Предупреждение

Данный материал носит сугубо рекомендательный характер, отражая точку зрения отдельной группы специалистов на основе их опыта разработки технической документации, и не может претендовать на звание абсолютного характера. Тем не менее, мы рекомендуем ознакомиться с данным материалом.

Отдельные виды документов

В: Необходим основной документ для разработки ПО, в котором зафиксирован базовый функционал и концепция проектируемого ПО (минимум) или отражены функциональные возможности и алгоритмы ПО в детальном виде (максимум) 

О: Техническое задание (свободный/пользовательский формат) Technical specification for development

В: Необходим основной документ для конечного пользователя (инструкция), в котором описано использование ПО по назначению

О: Руководство пользователя (свободный/пользовательский формат) User guide

В: Необходим основной документ для конечного пользователя (инструкция), в котором описана установка и настройка ПО

О: Руководство администратора (свободный/пользовательский формат) Administration guide

В: Необходим основной документ, в котором описаны возможности и методы модификации и доработки ПО (в т.ч. для расширения функционала)

О: Руководство программиста (свободный/пользовательский формат) Programmer's guide

Комплекты документации

В: Необходим минимальный комплект документации для разработки ПО

О: Комплект:

– Техническое задание (свободный/пользовательский формат) Technical specification for development
– Пояснительная записка (свободный/пользовательский формат) Explanatory Note
– Программа и методика испытаний (свободный/пользовательский формат) Program and methods of testing
– Описание программного обеспечения (свободный/пользовательский формат) Program description

В: Необходим минимальный комплект документации для релиза ПО

О: Комплект:

– Руководство администратора (свободный/пользовательский формат) Administration guide
– Руководство пользователя (свободный/пользовательский формат) User guide
– Руководство программиста (свободный/пользовательский формат) Programmer's guide

или

– Быстрый старт (–) Quick start
– Замечания по версии (–) Release notes
– Краткое описание (–) Readme
– Справочник разработчика (–) Programming guide
– Справочное руководство (–) Reference guide
– Часто задаваемые вопросы (–) FAQ

В: Необходим комплект документации по ГОСТ 19 для сдачи госзаказчику

О: Комплект:

– Ведомость эксплуатационных документов (ГОСТ 19.507-79) List of operational documentation
– Пояснительная записка (ГОСТ 19.404-79) Exlanatory Note
– Программа и методика испытаний (ГОСТ 19.203-78) Program and methods of testing
– Руководство оператора (ГОСТ 19.505-79) Operator's guide
– Руководство программиста (ГОСТ 19.504-79) Programmer's guide
– Руководство системного программиста (ГОСТ 19.503-79) System programmer's guide
– Спецификация (ГОСТ 19.202-78) Specifications
– Формуляр (ГОСТ 19.501-78) Technical and operation data card

В: Необходим комплект документации по ГОСТ 34 для сдачи госзаказчику

О: Комплект:

– Ведомость технического проекта (РД 50-34.698-90) List of project documents
– Ведомость эксплуатационных документов (РД 50-34.698-90) List of operational documentation
– Ведомость эскизного проекта (РД 50-34.698-90) List of preliminary design documents
– Описание автоматизируемых функций (РД 50-34.698-90) Automated functions description
– Описание алгоритма (проектной процедуры) (РД 50-34.698-90) Algorithm description
– Описание информационного обеспечения системы (РД 50-34.698-90) Data management description
– Описание комплекса технических средств (РД 50-34.698-90) Hardware description
– Описание программного обеспечения (РД 50-34.698-90) Software description
– Пояснительная записка к техническому проекту (РД 50-34.698-90) Project explanatory note
– Пояснительная записка к эскизному проекту (РД 50-34.698-90) Explanatory Note to the preliminary design
– Программа и методика испытаний (РД 50-34.698-90) Program and methods of testing
– Руководство администратора (РД 50-34.698-90) Administration guide
– Руководство пользователя (РД 50-34.698-90) User guide

В: Необходим комплект документации для маркетинга и продаж

О: Комплект:

– Белые страницы (–) White papers
– Бизнес-план (–) Business plan
– Договор (–) Contract (agreement)
– История успеха (–) Success story
– Коммерческое предложение (–) Commercial offer
– Корпоративная информация (–) Corporate papers
– Маркетинговые материалы (–) Marketing materials
– Материалы для обучения (–) Training materials
– Презентация (–) Presentation

Заключение

Техническая документация не ограничивается перечисленными выше видами документов: существует более 150 видов различных документов (во всяком случае, известно нам). Вы можете заказать любой из необходимых вам документов у нас, воспользовавшись кнопкой ниже, или обратиться к нам за индивидуальной консультацией по данной ссылке.