Settings

Theme

Ask HN: What do you use to produce software documentation?

6 points by LukaszB 13 years ago · 7 comments · 1 min read


We use github + markdown + wiki. Is there anything which offer collaboration on document (documentation to be specific) which allows all team members to edit/comment/iterate the docs?

dochtman 13 years ago

I like to use [Sphinx](http://sphinx-doc.org/), stored in the project repository.

It uses reStructuredText (which is more extensible than Markdown) and was written for the Python documentation.

  • LukaszBOP 13 years ago

    How about the situation when the documentation has to be prepared before any of implementation or coding starts (initial requirements, qc etc.) ?

    • dustinrcollins 13 years ago

      I think it's fine to document these things in Sphinx as well. Creating a docs repo and writing .rst files to cover these requirements can be useful, and then you can move them as needed as your project progresses.

    • swah 13 years ago

      I'm using Latex for exactly that, but it sucks so much I considered building a product/business to solve the problem.

Keyboard Shortcuts

j
Next item
k
Previous item
o / Enter
Open selected item
?
Show this help
Esc
Close modal / clear selection