1.Что такое документирование ПО?
Создание технической,пользовательской и программной документации,позволяющей пользователю лучше разобраться с программой
Техническая документация – некоторый пояснительный текст к созданному коду /часто используют программы автоматического создания документации,например doxygen
Пользовательская документация – руководство для конечного пользователя,всех типов – админ,секретарь и тп
Программная / проектная документация – описывает в общих чертах конечный продукт – UML диаграммы
2.стандарты в Документировании ПО
ISO/IEC 90003.Software engineering – Guidelines for the application of ISO 9001:2000 to computer software
Стандарты процесса документирования. Эти стандарты определяют процесс, которому следует следовать при производстве документов.
Стандарты документов. Эти стандарты регулируют структуру и представление документов.
Стандарты обмена документами. Эти стандарты обеспечивают совместимость всех электронных копий документов.
3. программы для документирования – doxygen
Doxygen — это кроссплатформенная система документирования исходных текстов, которая поддерживает C++, Си, Objective-C, Python, Java, IDL, PHP, C#, Фортран, VHDL и, частично, D.
https://blinov20.thkit.ee/jalgrattaeksam2/html/index.html
https://blinov20.thkit.ee/Zmeika1243-master/html/index.html