В какой/каких программах посоветуете написать пользовательскую документацию/инструкцию к программе?

Question

[helkart]

Нужно написать руководсво пользователя. Столкнулся с тем, что ворд не очень подходит.
Хотелось бы управлять/видеть структуру документа, добавлять скриншоты.

Comments

[Константин Нагибович]

Хотелось бы управлять/видеть структуру документа, добавлять скриншоты.

Word это прекрасно умеет.

Answer 1

[ge]

Решение зависит от того в каком формате нужно получить документацию. Рекомендую писать на языке разметки, а не в текстовом процессоре. В последствии обновлять документацию и конвертировать её в разные форматы будет гораздо проще.

Markdown подойдёт в большинстве случаев. Для более сложной разметки есть reStructuredText.

• Есть прекрасный Sphinx, который понимает Markdown и reStructuredText. Умеет генерировать статические сайты, юниксовые страницы мануалов, PDF и ещё много чего из единого исходника.
  
• Очень просто на Markdown можно собрать сайт с помощью Docusaurus.
  
• Документацию на языке разметки можно выложить в Wiki в репозитории на GitHub, если особых требований к размещению нет.
  

Если хочется WYSIWYG, то берите редактор Markdown, который так умеет. Например, Typora.

Answer 2

[Spiky_Flyki]

Мы в команде используем Dr.Explain.
В ней есть как раз нужная вам "структура" и возможность добавлять и аннотировать скриншоты.
Лично мы выбрали эту программу из-за возможности совместной работы и возможности экспортировать текст прямо из программы в нужные форматы (нам был нужен HTML и CHM)
Из плюсов для писателя там еще есть "шаблоны",по которым быстро написали руководство.
Советую.

Answer 3

[Василий Банников]

Markdown?

Answer 4

[mayton2019]

Да вы просто напишите ее сначала в txt файле. Потом когда будет - не сложно будет посмотреть ее в MarkDown
или PostScript.