Правильная справка/документация для программы

beats · Регистрация: 09.12.2012

Студворк — интернет-сервис помощи студентам

Есть узкоспециализированное ПО, документацию или справку к которому нужно написать по разному для некоторых ролей пользователей.
В связи с этим вопросы:
1) документация и справка это разные вещи?
2) какой формат правильнее использовать в современное время? .CHM вроде устарел...
3) может есть какие либо редакторы? к примеру для того же .CHM есть только один достойный это - HelpNDoc

@gng · 22.01.2015, 18:25

Сообщение от beats

1) документация и справка это разные вещи?

В общем случае - да. Документация описывает назначение и использование ПО последовательно. Справка - по командам, действиям и т.д.

Сообщение от beats

2) какой формат правильнее использовать в современное время? .CHM вроде устарел...

Для документации - pdf и html.
Для справочного руководства - зависит от системы. В линуксе и сейчас маны неплохо себя чувствуют. В венде - не знаю, последний хелп я писал, когда chm там ещё не было.

Новые блоги и статьи Все статьи Все блоги /
Модульная разработка через nuget packages DevAlt 07.03.2026 Сложившийся в . Net-среде способ разработки чаще всего предполагает монорепозиторий в котором находятся все исходники. При создании нового решения, мы просто добавляем нужные проекты и имеем. . .	Модульный подход на примере F# DevAlt 06.03.2026 В блоге дяди Боба наткнулся на такое определение: В этой книге («Подход, основанный на вариантах использования») Ивар утверждает, что архитектура программного обеспечения — это структуры,. . .	Управление камерой с помощью скрипта OrbitControls.js на Three.js: Вращение, зум и панорамирование 8Observer8 05.03.2026 Содержание блога Финальная демка в браузере работает на Desktop и мобильных браузерах. Итоговый код: orbit-controls-threejs-js. zip. Сканируйте QR-код на мобильном. Вращайте камеру одним пальцем,. . .	SDL3 для Web (WebAssembly): Синхронизация спрайтов SDL3 и тел Box2D 8Observer8 04.03.2026 Содержание блога Финальная демка в браузере. Итоговый код: finish-sync-physics-sprites-sdl3-c. zip На первой гифке отладочные линии отключены, а на второй включены:. . .
SDL3 для Web (WebAssembly): Идентификация объектов на Box2D v3 - использование userData и событий коллизий 8Observer8 02.03.2026 Содержание блога Финальная демка в браузере. Итоговый код: finish-collision-events-sdl3-c. zip Сканируйте QR-код на мобильном и вы увидите, что появится джойстик для управления главным героем. . . .	Реалии Hrethgir 01.03.2026 Нет, я не закончил до сих пор симулятор. Эта задача сложнее. Не получилось уйти в плавсостав, но оно и к лучшему, возможно. Точнее получалось - но сварщиком в палубную команду, а это значит, в моём. . .	Ритм жизни kumehtar 27.02.2026 Иногда приходится жить в ритме, где дел становится всё больше, а вовлечения в происходящее — всё меньше. Плотный график не даёт вниманию закрепиться ни на одном событии. Утро начинается с быстрых,. . .	SDL3 для Web (WebAssembly): Сборка библиотек: SDL3, Box2D, FreeType, SDL3_ttf, SDL3_mixer и SDL3_image из исходников с помощью CMake и Emscripten 8Observer8 27.02.2026 Недавно вышла версия 3. 4. 2 библиотеки SDL3. На странице официальной релиза доступны исходники, готовые DLL (для x86, x64, arm64), а также библиотеки для разработки под Android, MinGW и Visual Studio. . . .

beats 101 / 42 / 9 Регистрация: 09.12.2012 Сообщений: 597

	Правильная справка/документация для программы 21.01.2015, 14:01. Показов 680. Ответов 1 Метки нет (Все метки) Есть узкоспециализированное ПО, документацию или справку к которому нужно написать по разному для некоторых ролей пользователей. В связи с этим вопросы: 1) документация и справка это разные вещи? 2) какой формат правильнее использовать в современное время? .CHM вроде устарел... 3) может есть какие либо редакторы? к примеру для того же .CHM есть только один достойный это - HelpNDoc 0