Где посмотреть примеры документирования разработки сайта?

Подскажите, какими инструментами лучше пользоваться и на что обратить внимание. Сейчас есть задача создать относительно крупный и сложный веб-проект и хочется это задокументировать. Чисто для себя, заказчик это не оплачивает, да и не нужно ему это наверное.
  • Вопрос задан
  • 1996 просмотров
Пригласить эксперта
Ответы на вопрос 4
dimonchik2013
@dimonchik2013
совет, который уже дан - ничего не стоит
eduardtibet
@eduardtibet
Technical Writer / Documentation Engineer
Вы не обозначили самое главное: ДЛЯ ЧЕГО вам надо писать документацию?

Возможные варианты:
1. "Для галочки" - чтобы сдать заказчику.
2. Для уменьшения стоимости владения - например, чтобы новые/внешние разработчики не спрашивали "как это работает" и не отвлекали.
3. Для облегчения жизни себе - например, чтобы новую версию можно было делать на основе старой и ничего не забылось со временем.
4. Еще варианты....

Это САМЫЕ главные вопросы. Ответьте на них - потом можно будет думать дальше :)
Ответ написан
Tpona
@Tpona
Ужасный перфекционист
На мой взгляд, самый верный подход - это метаразметка комментариев из которых потом формируется справочная система.
Мы используем Doxygen.
Все, что нужно делать - это правильно оформлять комментарии к коду.
Ответ написан
Ваш ответ на вопрос

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

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