14

Is making documentation in markdown recommended or word/other editor?

I also need to put some pics and codes.

Comments
  • 1
    @partycoder my own software...
  • 2
    @partycoder That's all for docs aimed at developers though, they tell people what your code does in a very dry way.

    For end user docs, markdown is neat and fast to write, especially when paired with a good parser and styling template.

    For complex documentation manuals which needs to be distributed digitally as well as in print... LaTeX.

    Side note: I really hate documentation syntax in annotations, it always feels like abuse of comments, like spoiling nice code with this parallel meta language. The only docs generator which does it properly is probably Haskell's haddock, which generates docs from the code itself, only requiring comments for... comments.
Add Comment