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

[jtprogru]

Составление документации обязательный пункт при разработке каждого приложения. Чем больше по функционалу приложение, тем важнее документация как для участников разработки, так и для конечных пользователей.

Документацию разработчика можно автоматически создавать на базе комментариев в коде. Комментированию подлежат:

• Структуры данных с описанием полей;
• Интерфейсы, описывающие функционал структур;
• Все функции;

Во встроенном Wiki имеет смысл описывать документацию для оконечных пользователей. Документация для конечного пользователя должна содержать в себе:

• Описание всех переменных окружения;
• Пошаговое описание (с указанием всех команд) процесса локального запуска проекта в режиме разработки;
• Весь внешний функционал, с которым конечный пользователь может взаимодействовать;
• Контакты разработчика(ов) на которые можно выслать фидбэк (оценить качество работы, предложить недостающий функционал или улучшение текущего), сообщить об ошибке (ссылка на Issues репозитория как один из вариантов контактов);
• Пошаговое описание (с указанием всех команд) процесса формирования bug-report'a;