@cyberguz

Один из самых больных вопросов для плохо организованных проектов

Вопрос собственно такой: чем (в чём, в каком редакторе) создавать документацию и в каком формате хранить?

Есть мысли-вопрос по структуре. Очевидно, что документация бывает нескольких типов, например для разработчиков:
описание внутреннего устройства и логики работы
+ интерфейс (API Referense)
+ Programming manual с примерами
и это для каждой самостоятельной подсистемы (например библиотеки, драйвера);
для пользователей:
для админов - установка, настройка, ...
для юзеров - типичный user manual с картинками.

Плюс ко всему эти доки необходимо синхронизировать с самим проектом, чтобы они соответствовали реальности. Да к тому же ещё доки должны храниться в разных форматах (man, html, chm, pdf) для выкладывания в нете для просмотра и для скачивания, да к тому же хотелось бы юзерскую документацию встроить в саму прогу в виде подсказок и хелпа.
А ещё, чтобы можно было легко дописать документацию на ещё одном языке.

Как сделать так, чтобы самому писать поменьше, чтобы всё генерилось автоматически, а в шаблон потом надо было только вписывать изменения (отличия от предыдущей версии)?

Вернуться к обсуждению:
Создание документации C++

__________________
Помощь в написании контрольных, курсовых и дипломных работ, диссертаций здесь

0