1. Что такое документирование ПО
    • Документация на программное обеспечение — это документы, которые сопровождают некоторое программное обеспечение (ПО, программа или программный продукт) и описывают то, как работает программа и/или то, как её использовать.
    • Создание технической, программной, пользовательской документации
    • Техническая документации -пояснительный документ к коду / часто используют программы авто создание документации (doxygen)
    • Пользовательская документация – руководство для конечного пользователя(админ, секретарь)
    • Программная документация – описывает в общих чертах конечный продукт (UML диаграммы)
  2. Стандарты в документировании ПО
    • ISO-9000 seeria standardid
    • ISO/IEC 90003, Software engineering — Guidelines for the application of ISO 9001:2008 to computer software
    • EVS-ISO/IEC 12207 infotehnoloogia – tarkvara elutükli protsessid
  3. Программы для документирования – doxygen
    • Doxygen — это де-факто стандартный инструмент для создания документации из аннотированных источников C++, но он также поддерживает другие популярные языки программирования, такие как C, Objective-C, C#, PHP, Java, Python, IDL (разновидности Corba, Microsoft и UNO/OpenOffice). ), Fortran, VHDL и в некоторой степени D.

Linkid