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

C++

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

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

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

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

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

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

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

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

Скомпилировать пример из документации CUDA cuBLAS - Visual C++
Привет всем, есть документация по библиотеке cublas_v2.3 http://www.naic.edu/~phil/hardware/nvidia/doc/CUBLAS_Library_2.3.pdf На...

Как обратится к документации библиотеки моего компилятора? - Visual C++
Мне нужно знать какая функция какие заголовки использует и описание функции.Вот и я хочу узнать как обратится к документации моего...

Требуется рекомендация по изучению документации MSDN - C++
Доброе время суток! Ребят всем отличного настроения, изучаю документацию MSDN , но вобще трудно как-то... Все запутанно или Я неправильно...

Cmake проект сборки документации - Кроссплатформенная разработка
Здравствуйте, хочу сделать проект со сборкой документации, что-то типо doxygen target example. В интернете ничего подобного не нашел,...

MPL упражнения из документации - Boost C++
Если кто читал документацию по MPL, то там в туториале есть раздел с упражнениями по пройденному материалу Exercises. Мне интересно было и...

Пример из документации BOOST - Boost C++
Доброе утро) Скопировал пример из документации boost, компилирую в среде Visual Studio 2012... int main(int argc, char *argv) { ...

1
unStatiK
Заблокирован
20.01.2011, 19:47 #2
http://sphinx.pocoo.org/ - можешь поюзать , а вообще руками все правится и создается
0
MoreAnswers
Эксперт
37091 / 29110 / 5898
Регистрация: 17.06.2006
Сообщений: 43,301
20.01.2011, 19:47
Привет! Вот еще темы с ответами:

Создание документации - C#
Всем привет! Хочу создать документацию для разрабатовоемого фреймворка. (c sharp) Документация, в основном, внутренняя (XML sharp...

Создание документации для пользователя - Java SE
Собственно, постал вопрос реализации данного элемента, как его лучше сделать?

О документации - Lazarus
Возник вполне логичный вопрос, есть люди отлично знающие Pascal/Lazarus, могут на нем делать хоть 3D игры с OpenGl. А вот где Lazarus та...

Генерация документации - C#
Привет. Я сейчас пишу курсовую на C# и одним из приложений к документации должно быть описание всех классов программы. Разумеется, я сразу...


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

Или воспользуйтесь поиском по форуму:
2
Ответ Создать тему
Опции темы

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