Задать вопрос
IvanTheCrazy
@IvanTheCrazy

Документация на ПО?

Уважаемое сообщество, я сейчас работаю над одним проектом и его требуется целиком и полностью документировать. В связи с этим появился вопрос следующего характера: как должна выглядеть эта документация и что в нее нужно включить? В моем понимании должно присутствовать следующее:
  1. комментарии в коде
  2. uml-диаграммы
  3. описание структуры БД
  4. описание интерфейсов взаимодействия модулей друг с другом


И Может быть есть какие-то готовые программные средства для описания всего этого в едином центре, что-то более специализированное и удобное, нежели MS-office?
  • Вопрос задан
  • 3072 просмотра
Подписаться 3 Оценить Комментировать
Помогут разобраться в теме Все курсы
  • Яндекс Практикум
    Продвинутый Go-разработчик
    6 месяцев
    Далее
  • Учебный центр IBS
    AI-002 Промпт-инжиниринг для Архитекторов: Эффективное Использование LLM
    1 неделя
    Далее
  • Учебный центр IBS
    ARC-014 Архитектура в Agile-проектах
    1 неделя
    Далее
Пригласить эксперта
Ответы на вопрос 1
sainnr
@sainnr
В общих чертах, про то, какая документация нужна и в каком случае, было здесь.

Если вы хотите следовать стандартам документации (ГОСТ, ISO), то посмотрите вот здесь.
Ответ написан
Комментировать
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Похожие вопросы