Mephistophele
@Mephistophele

Как написать техническую документацию к проекту?

Добрый день.
Заказчик очень уж хочет техническую документацию по проекту. В его ожиданиях "оно" выглядит следующим образом: коммиты с ключами к jira, с детальным описанием кода, с комментариями разработчика, а так же время, потраченное на каждую задачу. При всём этом ему заждется держать этого монстра в виде одного большого pdf файла. Собственно, тут и ежу понятно, что команда от такого "щастья" начнёт разбегаться. Может быть у кого-либо есть примеры документации с описанием кода, способные более-менее удовлетворить вышеизложенным фантазиям, но остающиеся в рамках разумного приличия?
  • Вопрос задан
  • 5593 просмотра
Решения вопроса 1
@rinx
Посмотрите в сторону ГОСТ34. Уже есть наработанные стандарты. Не обязательно использовать всё из этого, но можно взять то, что действительно важно и интересно.
www.clientprav.ru/standard/gost_34
Ответ написан
Комментировать
Пригласить эксперта
Ответы на вопрос 3
iiil
@iiil
Инженер и вэб-дизайнер, рисую.
А платить он за такое готов? Как бы стоимость документации не превысила стоимость работы над проектом..
Ответ написан
foxmuldercp
@foxmuldercp
Системный администратор, программист, фотограф
Ох, написать парсилку тасков из джиры, привязать как-то к ней хистори коммитов, кто делал, оформить и выслать в пдф.
я вижу так.
Ответ написан
Комментировать
eduardtibet
@eduardtibet
Technical Writer / Documentation Engineer
Добрый день!

Вообще для такой цели (именно документация по коду, если я правильно понял вопрос) существуют специальные утилиты, которые позволяют выцеплять документацию/комментарии (написанную разработчиками прямо в коде). Вы смотрели в сторону doxygen (www.doxygen.org)?

P.S. Непонятно только, зачем все это _хранить_ в pdf. PDF - это средство представления, а не формат хранения/обработки.
Ответ написан
Комментировать
Ваш ответ на вопрос

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

Войти через центр авторизации
Похожие вопросы