Документация и артефакты проекта: карта раздела

Это карта страниц по документации и проектным артефактам. Она не заменяет основную страницу про состав документации на ПО, а помогает быстро перейти к нужной ветке: общий комплект, ТЗ, технический проект, описание программы, оформление по ГОСТ, приемка, эксплуатация, интеграции или передача проекта.

1. Если нужно понять, какие документы вообще нужны в проекте, начните со страницы про документацию на ПО.
2. Если уже готовится проектный комплект, переходите к техническому проекту, описанию программы и составу программных средств.
3. Если задача связана с формальной передачей, проверьте оформление по ГОСТ и листинг как часть комплекта.

• Документация на программное обеспечение: какие документы нужны в проекте
• Техническое задание на разработку ПО: что описывать, а что вынести в roadmap
• Технический проект по ГОСТ 34: что входит и как проверить состав
• Описание программы: структура, разделы и пример подготовки
• Назначение программы: как сформулировать без путаницы с функциями
• Оформление программной документации по ГОСТ: чек-лист перед передачей
• Состав программных средств: что описывать в документации
• Листинг программы в комплекте документации: когда нужен и как проверить
• Как проверить комплектность документации перед приемкой
• Минимальный комплект документации для небольшого ИТ-проекта
• Документация для интеграционного проекта
• Эксплуатационная документация: что должно остаться после запуска
• Передача проекта: код, доступы, changelog и инструкции

• Нужен состав комплекта: документация на ПО.
• Нужно согласовать требования, границы работ и приемку: техническое задание.
• Нужно проверить проектное решение: технический проект.
• Нужно проверить готовность к приемке: комплектность документации перед приемкой.
• Проект небольшой: минимальный комплект документации.
• Проект интеграционный: документация для интеграционного проекта.
• Система уже запускается: эксплуатационная документация и передача проекта.