С помощью чего создать мануал для программы?

Автор vold57, 24-05-2020, 22:14:22

« назад - далее »

vold57Topic starter

Посоветуйте сервис или программу для создания мануалов. Желательно бесплатную или недорогую, так как работа разовая.


Tarasios

Я делаю вполне себе нормальные руководства в WinCHM Pro 4.15.
Бесплатно, просто, понятно, русский интерфейс. Можно делать перекрёстные ссылки в разделах. На выходе - формат веб справки, открывается в браузере
  •  


vold57Topic starter

Установил и попробовал совсем немного. Тщательно еще не разбирался. При каждом изменении предлагает записать. И создалось впечатление, что программа немного устарела. Желательно что-то более современное, позволяющее сделать мануал более привлекательным. 

LostAlly

Не хочу бытькапитаном, но...
Если хотите современное, то нужно делать на вебевозможно вам подойдет генератор статических сайтов, некоторые из них заточены под документацию, например vuepress.
На выходе у вас получится современная документация, которую, хоть в интернете публикуй, на самых дешевых хостингах, хоть вместе с программой поставляй.
Один минус-нужно поразбираться. Есть и альтернативные подобные решения.
  •  

vold57Topic starter

Цитата: LostAlly от 26-05-2020, 07:44:13Если хотите современное, то нужно делать на вебевозможно вам подойдет генератор статических сайтов
Почему бы тогда не использовать любую CMS, например MODx, с которым я привык работать.



Val_Ery

vold57, а как вы относитесь к командной строке и markdown?

На моё скромное имхо, был замечательный продукт, который мелкософт испохабилкупил - gitbook. Он и сейчас есть в исходниках, просто не обновляется больше. Его можно поставить на локальную машину и тремя командами рулить процессом (init - создать проект, serve - отслеживание изменений с просмотром в браузере, pdf - сохранить проект в pdf-формате). Используемые файлы - *.md, то есть не надо для каждой страницы дока писать html разметку. Можно и не заморачиваться локальной установкой, а работать онлайн (есть персональный план free).

P.S. Gitbook не обновляет только работу с cli, онлайн - он всегда новый.

Второй продукт, который мне нравится - MkDocs.
Пример того, что на нем сделано - тык. Его также можно установить для локальной работы (только нужен установленный python). Также использует markdown, плюс (что мне нравится) yaml. Есть куча всевозможных плагинов (https://github.com/mkdocs/mkdocs/wiki/MkDocs-Plugins#pdf--site-conversion), включая сохранение  мануала в pdf формате.

Ещё... Для микро html-презентаций я использую revealjs. Штука достаточно простая и замечательно документированная. Но - презентация, она и есть презентация: набор экранов всего лишь. Есть возможность экспорта в pdf.

Если нужна супер-документашка, с использованием жутких математических формул, вставкой графики и т.д., очень крут latex. Он крут настолько, что, как мне кажется, photoshop освоить проще :)

P.P.S. Для работы с markdown можно подобрать какой-нибудь редактор с wisiwyg или без. Например, из сделанных на электроне.
  •  

LostAlly

Цитата: vold57 от 26-05-2020, 09:07:19
Почему бы тогда не использовать любую CMS, например MODx, с которым я привык работать.
Почему бы тогда не использовать текстовый редактор или блокнот, это самый просто способ )))
А если по сути моего ответа,то чтобы посмотреть вашу справку(на движке) вам нужно таскать с документацией web сервер, PHP и Mysql.
А предложеный мной выше способ на выходе выдает статический сайт, который состоить исключительно из html, css и js и его можно просто открыть браузером локально или разместить бесплатно на git page. Я не силен в MODx, но если у него есть модуль, который создает на выходе статический сайт, который вы можете выгрузить и запускать локально без веб серера, то он тоже сойдет за генератор статических сайтов.
  •  

vold57Topic starter

#7
Цитата: Val_Ery от 26-05-2020, 09:09:12как вы относитесь к командной строке и markdown?
Я обычный юзер - не программист и не администратор. Меня не пугают html и css. Все остальное не мое.
Нужно создать документацию к программе, которая бы смотрелась довольно привлекательно и современно. Разумеется с использование скриншотов, а может и чего-то там, что еще будет шевелиться. :)
Готов в разумных пределах поразбираться, но не посвящая этому слишком много времени. :)

Цитата: LostAlly от 26-05-2020, 09:28:19А если по сути моего ответа,то чтобы посмотреть вашу справку(на движке) вам нужно таскать с документацией web сервер, PHP и Mysql.
А зачем мне их таскать? :) 

Цитата: LostAlly от 26-05-2020, 09:28:19А предложеный мной выше способ на выходе выдает статический сайт, который состоить исключительно из html, css и js и его можно просто открыть браузером локально или разместить бесплатно на git page.
Я не пользуюсь бесплатными хостингами. Пользуюсь и сервером и ВПС.