Форум программистов, компьютерный форум, киберфорум
C++
Войти
Регистрация
Восстановить пароль
 
Рейтинг 4.83/6: Рейтинг темы: голосов - 6, средняя оценка - 4.83
6 / 6 / 1
Регистрация: 01.12.2010
Сообщений: 105
1

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

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

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

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

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

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

Как сделать так, чтобы самому писать поменьше, чтобы всё генерилось автоматически, а в шаблон потом надо было только вписывать изменения (отличия от предыдущей версии)?
0
Programming
Эксперт
94731 / 64177 / 26122
Регистрация: 12.04.2006
Сообщений: 116,782
20.01.2011, 18:46
Ответы с готовыми решениями:

Как включить генерирование документации?
Подскажите кто сталкивался, перерыл везде, в инструкции говорится что в окне Model view должно...

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

AlphaBlend() & BLENDFUNCTION: какой функционал был убран из документации? Почему? Работает ли он сегодня?
Есть такая структура: BLENDFUNCTION(ru) Со вторым полем, BlendFlags - всё чётко и понятно:Должно...

Оформление документации
Не знаю, где спросить, поэтому спрошу здесь. Руководствуясь каким стандартом/технологией можно...

1
Заблокирован
20.01.2011, 19:47 2
http://sphinx.pocoo.org/ - можешь поюзать , а вообще руками все правится и создается
0
IT_Exp
Эксперт
87844 / 49110 / 22898
Регистрация: 17.06.2006
Сообщений: 92,604
20.01.2011, 19:47

Заказываю контрольные, курсовые, дипломные и любые другие студенческие работы здесь.

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

Как правильно создать проект для примера из документации по MF?
Как правильно создать проект для примера из документации по Media Foundation?...

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

Пример из документации BOOST
Доброе утро) Скопировал пример из документации boost, компилирую в среде Visual Studio 2012... ...


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

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

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