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

Автор Тема: С помощью чего создать мануал для программы?  (Прочитано 469 раз)

Оффлайн vold57Автор темы

  • Бизнес оценка: (6, 100%)
  • Мастер
  • *****
  • СПАСИБО: 5322
  • Сообщений: 7374
  • Карма: 289
  • Пол: Мужской
  • Награды Более трех тысяч спасибо Мастер поисковой оптимизации
    • SEO, интернет-маркетинг, сайостроение

Оффлайн vold57Автор темы

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


Оффлайн Tarasios

  • Бизнес оценка: (0)
  • Рекрут
  • *
  • СПАСИБО: 6
  • Сообщений: 10
  • Карма: 0

Оффлайн Tarasios

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

Оффлайн vold57Автор темы

  • Бизнес оценка: (6, 100%)
  • Мастер
  • *****
  • СПАСИБО: 5322
  • Сообщений: 7374
  • Карма: 289
  • Пол: Мужской
  • Награды Более трех тысяч спасибо Мастер поисковой оптимизации
    • SEO, интернет-маркетинг, сайостроение

Оффлайн vold57Автор темы

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

Оффлайн LostAlly

  • Бизнес оценка: (0)
  • Пользователь
  • **
  • СПАСИБО: 16
  • Сообщений: 64
  • Карма: 4

Оффлайн LostAlly

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

Оффлайн vold57Автор темы

  • Бизнес оценка: (6, 100%)
  • Мастер
  • *****
  • СПАСИБО: 5322
  • Сообщений: 7374
  • Карма: 289
  • Пол: Мужской
  • Награды Более трех тысяч спасибо Мастер поисковой оптимизации
    • SEO, интернет-маркетинг, сайостроение

Оффлайн vold57Автор темы

  • Мастер
  • *****
Если хотите современное, то нужно делать на вебевозможно вам подойдет генератор статических сайтов
Почему бы тогда не использовать любую CMS, например MODx, с которым я привык работать.



Онлайн Val_Ery

  • Бизнес оценка: (0)
  • Постоялец
  • ***
  • СПАСИБО: 100
  • Сообщений: 184
  • Карма: 19

Онлайн 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

  • Бизнес оценка: (0)
  • Пользователь
  • **
  • СПАСИБО: 16
  • Сообщений: 64
  • Карма: 4

Оффлайн LostAlly

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

Оффлайн vold57Автор темы

  • Бизнес оценка: (6, 100%)
  • Мастер
  • *****
  • СПАСИБО: 5322
  • Сообщений: 7374
  • Карма: 289
  • Пол: Мужской
  • Награды Более трех тысяч спасибо Мастер поисковой оптимизации
    • SEO, интернет-маркетинг, сайостроение

Оффлайн vold57Автор темы

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

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

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


 

Похожие темы

  Тема / Автор Ответов Последний ответ
12 Ответов
3248 Просмотров
Последний ответ 19-07-2011, 22:50:59
от [Константин]
0 Ответов
1106 Просмотров
Последний ответ 03-08-2011, 16:13:50
от Павел Joofaq
12 Ответов
3519 Просмотров
Последний ответ 03-09-2013, 10:57:46
от Choice
7 Ответов
2818 Просмотров
Последний ответ 25-07-2014, 17:11:08
от Wennem
4 Ответов
1143 Просмотров
Последний ответ 19-06-2016, 00:34:16
от Dogica