I
I
Ivan2011-11-25 09:30:48
Documentation
Ivan, 2011-11-25 09:30:48

How to write documentation (not code-based)?

There is a desire to write a userguide (a multi-page tutorial, not a generated documentation for the project). Basic requirements:
1. Ability to export to HTML (online version)/PDF (offline).
2. Preferably based on files. Then I want to take out the texts in github.
3. It will be enough offline, because. I will write alone.
4. If there are plug-ins for editors for this program, it's generally good.
5. Images, code inserts and other nice things are planned in the text. I want it all to look beautiful in the end, without unnecessary gestures on my part (yeah, I'm lazy).
6. i18n is not critical, although it would be cool.
Thanks for the help.

Answer the question

In order to leave comments, you need to log in

6 answer(s)
E
Eddy_Em, 2011-11-25
@Eddy_Em

I use latex. From my point of view, nothing better has yet been invented.

B
bagyr, 2011-11-25
@bagyr

Markdown, Emacs Org-mode, LaTeX.

C
chmv, 2011-11-25
@chmv

I have been using Help&Manual for many years .

A
ainu, 2011-11-25
@ainu

My choice is files in markdown in a folder, all this is on github.
I advise everyone. Reads like plain text great.
See how it looks:
doit-cms.ru/docs/docs.php?file=active_record (the same files through the php viewer, they are also on github)
github.com/ramainen/doit-cms/tree/master/docs - list of pages. Native, comfortable.
github.com/ramainen/doit-cms/blob/master/docs/active_record.md - highlight out of the box.

D
Darkus, 2011-11-25
@Darkus

1. LaTeX.
2.Word.

J
jtraub, 2011-11-25
@jtraub

1. LaTeX
2. Sphinx
3. My own set of scripts for text processing in Markdown formats
4. Docbook
I personally use LaTeX and Sphinx and they are enough for me to be completely happy.

Didn't find what you were looking for?

Ask your question

Ask a Question

731 491 924 answers to any question