News for hackers. Stuff that matters.
Re:Ask HN: awesome web-based documentation? by cies on Thursday November 18, 2010 @07:01PM (#1919861)
i like publican, you have to feed it docbook (xml), but it then outputs pdf/html/epub, allows for pot-po based translations and is nicely stylable.

in one setup i put asciidoc (a wiki-syntax-to-docbook tool) before publican to make writing/editing the docs more straight forward.

i cannot give you one-size-fits-all documentation tips, it depends heavily on what document you work on (api docs, a user guide, etc.) and what is the target audience.

personally i like to avoid the word "you" in documentation.

There are no comments on this comment yet.