Ответы пользователя по тегу Документация
  • Как писать техническую документацию к софту?

    @invisible_me
    Начинающий web-разработчик
    Можно вспомнить курсовой по программированию.

    Как было у нас в учебном заведении, документация делится на 2 части.
    1. Общая
    2. Специальная

    Общая часть - описывается используемое ПО для разработки продукта.

    Спецаильная часть - описываются, все участки программы. Макро блок-схема, Блок-схемы проблемных участков. Листинг программы. Описание каждой функции, ее типы и т.д. и т.п. ER-диаграмма, связь таблиц БД. Сколько полей в таблице, описывается каждое поле таблицы, его тип и т.д и т.п

    Возможно стандарты разные.
    Ответ написан