В чем писать документацию (не code-based)?

Есть желание написать userguide (многостраничный туториал, не сгенерированная документация к проекту). Основные требования:


1. Возможность экспорта в HTML (онлайн-версия)/PDF (оффлайн).

2. Желательно, чтобы была основана на файлах. Хочу потом вынести тексты в гитхаб.

3. Достаточно будет оффлайна, т.к. писать буду один.

4. Если для этой программы существуют плагины для редакторов — вообще хорошо.

5. В тексте планируются изображения, вставки кода и прочие няшки. Хочется, чтобы это все в итоге выглядело красиво, без лишних телодвижений с моей стороны (ага, я ленивый).

6. i18n не критично, хотя и было бы круто.


Спасибо за помощь.
  • Вопрос задан
  • 3850 просмотров
Пригласить эксперта
Ответы на вопрос 6
@Eddy_Em
Пользуюсь латехом. С моей точки зрения, лучше ничего еще не придумали.
Ответ написан
bagyr
@bagyr
Markdown, Emacs Org-mode, LaTeX.
Ответ написан
chmv
@chmv
Много лет пользуюсь Help&Manual.
Ответ написан
ainu
@ainu
Мой выбор — файлы в markdown в папке, всё это лежит на github.
Всем советую. Читается как plain текст великолепно.
Смотрите как это выглядит:
doit-cms.ru/docs/docs.php?file=active_record (теже самые файлы через php-просмотрщик, там же лежит на гитхабе)
github.com/ramainen/doit-cms/tree/master/docs — список страниц. Нативно, убодно.
github.com/ramainen/doit-cms/blob/master/docs/active_record.md — подстветочка из коробки.
Ответ написан
Комментировать
Darkus
@Darkus
1. LaTeX.
2. Word.
Ответ написан
Комментировать
@jtraub
1. LaTeX
2. Sphinx
3. Свой набор скриптов для обработки текстов в форматах типа Markdown
4. Docbook

Сам лично пользуюсь LaTeX и Sphinx и мне их хватает для полного счастья.
Ответ написан
Комментировать
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Войти через центр авторизации
Похожие вопросы