Формирование документации, описывающей процесс интеграции и собственной разработки
Все этапы создания программного продукта и интеграции его в существующий IT-ландшафт необходимо сопровождать соответствующей документацией. Документацию можно разделить на три группы:
Предпроектная документация
Цель: сформировать требования и обосновать необходимость создания и интеграции IT-продукта
- Технические требования
- Концепция
- Результаты научно-исследовательских или опытно-конструкторских работ
- Технико-экономические обоснования
- Техническое задание
Проектная документация
Цель: обеспечение полного описания решений, достаточного для последующего сопровождения или интеграции программного обеспечения.
- Описание решений
- Структура данных
- Структура запросов
- Пояснительные записки к эскизному/техническому проекту
- Частные технические задания
- Документация API
- Макеты экранов
Эксплуатационная документация
Цель: формирование свойств и порядка использования разработанного/интегрированного программного обеспечения.
- Ведомость эксплуатационных документов
- Формуляр программного продукта
- Руководство программиста
- Описание языка
- Описание применения
- Руководство оператора
- Руководство системного программиста
- Руководство по техническому обслуживанию
Эффективно использовать трудовые и финансовые ресурсы и получить качественный результат при подготовке документации можно обратившись к компании Claire&Clarté, которая помогает заказчикам разрабатывать различные виды документации по проекту в соответствии с существующими нормативами.