Форум программистов, компьютерный форум CyberForum.ru

C++

Войти
Регистрация
Восстановить пароль
 
cyberguz
6 / 6 / 0
Регистрация: 01.12.2010
Сообщений: 105
#1

Создание документации - C++

20.01.2011, 18:46. Просмотров 855. Ответов 1
Метки нет (Все метки)

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

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

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

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

Как сделать так, чтобы самому писать поменьше, чтобы всё генерилось автоматически, а в шаблон потом надо было только вписывать изменения (отличия от предыдущей версии)?
Similar
Эксперт
41792 / 34177 / 6122
Регистрация: 12.04.2006
Сообщений: 57,940
20.01.2011, 18:46     Создание документации
Посмотрите здесь:

Как обратится к документации библиотеки моего компилятора? Visual C++
Пример из документации BOOST Boost C++
Boost C++ MPL упражнения из документации
Cmake проект сборки документации
Visual C++ Скомпилировать пример из документации CUDA cuBLAS
C++ Требуется рекомендация по изучению документации MSDN

Искать еще темы с ответами

Или воспользуйтесь поиском по форуму:
После регистрации реклама в сообщениях будет скрыта и будут доступны все возможности форума.
unStatiK
Заблокирован
20.01.2011, 19:47     Создание документации #2
http://sphinx.pocoo.org/ - можешь поюзать , а вообще руками все правится и создается
Yandex
Объявления
20.01.2011, 19:47     Создание документации
Ответ Создать тему
Опции темы

Текущее время: 22:39. Часовой пояс GMT +3.
КиберФорум - форум программистов, компьютерный форум, программирование
Powered by vBulletin® Version 3.8.9
Copyright ©2000 - 2017, vBulletin Solutions, Inc.
Рейтинг@Mail.ru