Если непонятно, какие именно виды документов вам необходимо разработать в текущей ситуации или какой сценарий обслуживания вам подойдет в каждом конкретном случае (нескольких случаях), рекомендует ознакомиться со следующими рекомендациями ниже:
☞ Список рекомендаций по выбору сценариев
☞ Список рекомендаций по выбору документов
Список рекомендаций по выбору сценариев
|
Сценарий обслуживания |
|||
|---|---|---|---|
|
|
|
|
|
|
Проектные документы: |
|
|
|
|
Техническое задание любого уровня сложности (вне зависимости от требований ГОСТ) |
|
✓ |
|
|
Любые проектные документы высокого уровня сложности (например, подробная Пояснительная записка) |
|
✓ |
|
|
Все иные виды проектных документов невысокой сложности (например, краткое Описание программного обеспечения или Описание автоматизированных функций) |
✓ |
|
|
|
Эксплуатационные документы: |
|
|
|
|
Руководство пользователя/администратора/программиста значительного объёма |
|
✓ |
|
|
Любые эксплуатационные документы значительного объёма (например, подробное Руководство по API или Справочник разработчика) |
|
✓ |
|
|
Все иные виды эксплуатационных документов незначительного объёма (например, краткое Общее описание системы или Технические условия) |
✓ |
|
|
|
Иные виды документов: |
|
|
|
|
Разработка неофициальной документации (требования по составу, содержанию или оформлению документации не регламентированы в принципе) |
✓ |
|
|
|
Разработка нестандартной документации (требования к содержанию и оформлению не регламентированы государственными и отраслевыми стандартами де-факто) |
✓ |
|
|
|
Комплекты документов: |
|
|
|
|
Комплект документации в соответствии с требованиями ГОСТ любого объёма |
|
✓ |
|
|
Комплект документации без требований ГОСТ, но значительного объёма |
|
✓ |
|
|
Иные комплекты документации незначительного объёма |
✓ |
|
|
|
Иные виды сценариев: |
|
|
|
|
Доработка и поддержка документации после окончания разработки |
✓ |
|
|
|
Постоянный поток работы, множество параллельных проектов |
|
|
✓ |
|
Необходимость выполнять периодическую работу в срочном порядке |
|
|
✓ |
|
Нет времени на бюрократические формальности, вопрос о расходах не стоит |
|
|
✓ |
Список рекомендаций по выбору документов
Предупреждение
Материал, представленный ниже, отражает точку зрения отдельной группы опытных специалистов и не может быть интерпретирован как универсальное и единственное верное решение для любой ситуации.
☒ Основной документ для разработки ПО, в котором зафиксирован базовый функционал и концепция проектируемого ПО (минимум) или отражены функциональные возможности и алгоритмы ПО в детальном виде (максимум)
☞ Техническое задание (свободный/пользовательский формат) Technical specification for development
☒ Основной документ для конечного пользователя (инструкция), в котором описано использование ПО по назначению
☞ Руководство пользователя (свободный/пользовательский формат) User guide
☒ Основной документ для конечного пользователя (инструкция), в котором описана установка и настройка ПО
☞ Руководство администратора (свободный/пользовательский формат) Administration guide
☒ Основной документ, в котором описаны возможности и методы модификации и доработки ПО (в т.ч. для расширения функционала)
☞ Руководство программиста (свободный/пользовательский формат) Programmer's guide
☒ Минимальный комплект документации для разработки и сдачи ПО
☞ Техническое задание (свободный/пользовательский формат) Technical specification for development
☞ Пояснительная записка (свободный/пользовательский формат) Explanatory Note
☞ Программа и методика испытаний (свободный/пользовательский формат) Program and methods of testing
☒ Минимальный комплект документации для релиза ПО
☞ Краткое описание (–) Readme
☞ Замечания по версии (–) Release notes
☞ Быстрый старт (–) Quick start
☞ Часто задаваемые вопросы (–) FAQ
☒ Минимальный комплект документации для использования ПО (вариант I)
☞ Руководство администратора (свободный/пользовательский формат) Administration guide
☞ Руководство пользователя (свободный/пользовательский формат) User guide
☞ Руководство программиста (свободный/пользовательский формат) Programmer's guide
☒ Минимальный комплект документации для использования ПО (вариант II)
☞ Быстрый старт (–) Quick start
☞ Справочное руководство (–) Reference guide
☞ Справочник разработчика (–) Programming guide
☒ Минимальный комплект документации для сдачи госзаказчику (ГОСТ 34)
☞ Ведомость технического проекта (РД 50-34.698-90) List of project documents
☞ Пояснительная записка к техническому проекту (РД 50-34.698-90) Project explanatory note
☞ Программа и методика испытаний (РД 50-34.698-90) Program and methods of testing
☞ Описание автоматизируемых функций (РД 50-34.698-90) Automated functions description
☞ Описание алгоритма (проектной процедуры) (РД 50-34.698-90) Algorithm description
☞ Описание комплекса технических средств (РД 50-34.698-90) Hardware description
☞ Общее описание системы (РД 50-34.698-90) System overview
☞ Ведомость эксплуатационных документов (РД 50-34.698-90) List of operational documentation
☞ Руководство администратора (РД 50-34.698-90) Administration guide
☞ Руководство пользователя (РД 50-34.698-90) User guide
☒ Минимальный комплект документации для сдачи госзаказчику (ГОСТ 19)
☞ Спецификация (ГОСТ 19.202-78) Specifications
☞ Пояснительная записка (ГОСТ 19.404-79) Exlanatory Note
☞ Программа и методика испытаний (ГОСТ 19.203-78) Program and methods of testing
☞ Ведомость эксплуатационных документов (ГОСТ 19.507-79) List of operational documentation
☞ Руководство оператора (ГОСТ 19.505-79) Operator's guide
☞ Руководство программиста (ГОСТ 19.504-79) Programmer's guide
☞ Руководство системного программиста (ГОСТ 19.503-79) System programmer's guide
☞ Формуляр (ГОСТ 19.501-78) Technical and operation data card
Заключение
Техническая документация не ограничивается перечисленными выше видами документов: существует более 150 видов различных документов (во всяком случае, известных нам). Вы можете заказать любой из необходимых вам документов у нас, воспользовавшись кнопкой ниже, или обратиться к нам за индивидуальной консультацией по данной ссылке.
Обратите также внимание, что комплект документации для одного продукта заказывать всегда намного выгоднее, чем разрабатывать документы по отдельности: это связано со спецификой алгоритма оценки трудоемкости разработки документации. Например, у нас при заказе комплекта экономия может достигать 35% от итоговой суммы заказа.