Форум программистов, компьютерный форум, киберфорум
C++
Войти
Регистрация
Восстановить пароль
Другие темы раздела
C++ Автоматизация OpenOffice 3.2 https://www.cyberforum.ru/ cpp/ thread231355.html
Доброго времени суток. Необходимо прикрутить OpenOffice 3.2 API к VS 2008 или Qt Creator(вроде как, правда, Оо не дружит особо с MinGW, но все таки). ОС Win7. Долго читал различные манула, форумы и...
Как написать функцию, которая бы автоматически определяла типа принимаемых параметров? C++
Друзья! На самом деле примеров подобных функций много, я имею ввиду конструкторы объектов классов из библиотеки STL Но там принимаемые параметры различаются явно. А у меня- никак, но тем не менее,...
Подключение TLB-файла C++
Доброе время суток. Попросили написать программу учета для кассового аппарата. Чтобы хозяин пришел глянул что как, подредактировал и ушел. На сайте производителя нашел описание протокола связи...
C++ не могу разобраться с процессом незнал куда написать необходимо разобраться с процессом прикрепленным ниже а именно принцип работы. При работе с дизасемблером(я еще новичок не разбираюсь) суть не открылась мне если кто разбирается... https://www.cyberforum.ru/ cpp/ thread230038.html
C++ Программирование микшера для windows 7 https://www.cyberforum.ru/ cpp/ thread229994.html
Пишу программу - микшер через win API. На XP все работает без проблем, перенес на windows 7 и оказалось что микшер не работает. Проблему нашел при выполнении команды mixerSetControlDetails, выдавала...
Тестирование потоками данных программы в C++ C++
Как это реализовать? где можно почитать
Софт для спутниковых тюнеров C++
Ребята кто нибудь сталкивался стаким вешами писат прогу. для тюнера как сделать это просто стало интересно? Извините если ошибся разделом я пишу на С++ и Visual C++ основном..
C++ работа с системой хочется что-нибудь написать , чтобы оно работало с системой , прожки работающие сами в себе конечно интересно , но хочется что-нибудь поразвитей что ли вижу только так возможность: 1.взять... https://www.cyberforum.ru/ cpp/ thread229399.html
C++ VSTO 2007 https://www.cyberforum.ru/ cpp/ thread228725.html
Добрый день!Подскажите где можно найти литературу по Visual Studio Tools for Office 2007 на русском языке. Для написания add-in под MS Project 2007. писать буду на Visual C# или Vicual C++.
C++ Сокращение расстояния Хэмминга Добрый день, уважаемые форумчане. Есть у меня следующая ситуация: имеем два массива одинаковой длины типа unsigned int, например arr1 и arr2 (на самом деле размерность может быть любой). Необходимо... https://www.cyberforum.ru/ cpp/ thread228708.html
6 / 6 / 1
Регистрация: 01.12.2010
Сообщений: 105
0

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

20.01.2011, 18:46. Просмотров 1313. Ответов 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
КиберФорум - форум программистов, компьютерный форум, программирование
Powered by vBulletin® Version 3.8.9
Copyright ©2000 - 2021, vBulletin Solutions, Inc.