Документирование программ

Процесс разработки программного обеспечения сопровождается созданием большого количества документов. Эти документы сопровождают процессы:

>>управления разработкой программного обеспечения; 

>>передачи информации между разработчиками программного обеспечения; 

>>передачи пользователям информации, необходимой для эксплуатации программного обеспечения. 

Вся документация делится на две основные группы: 

>>документы управления разработкой программного обеспечения; 

>>документы, входящие в состав программного обеспечения. 

К первой группе относятся документы, связанные с разработкой и сопровождением программного обеспечения, которые обеспечивают связи внутри коллектива разработчиков и между коллективом разработчиков и лицами, управляющими процессом разработки. Сюда включаются различные стандарты, планы, отчеты, а также рабочие документы и переписка между разработчиками и управляющими разработкой. 

Ко второй группе относятся документы, включаемые в состав программного обеспечения. Эти документы в свою очередь делятся на две группы: 

>>документация по сопровождению; 

>>пользовательская документация. 

В состав документации по сопровождению включаются документы, описывающие структуру и состав ПО: архитектуру программной системы, спецификации и тексты программных модулей, средства тестирования, а также руководство по сопровождению программной системы с указанием аппаратном программно-зависимых ее частей. 

К пользовательской документации относятся документы, описывающие процессы установки и настройки ПО, а также инструкции системным администраторам и конечным пользователям по эксплуатации программных систем. 

Качество программной документации напрямую влияет на успех эксплуатации ПО в целом. В связи с этим для обеспечения качества программной документации разработан ряд стандартов, в которых предписывается порядок разработки этой документации, формулируются требования к каждому виду документов и определяются их структура и содержание.

Наш канал: https://t.me/programistica