3 ms·

Ask HN: How do you document your applications?

3 points by mabn 10y ago

I'm wondering what are others using to store documentation of their (non-public) services. Github wiki looks nice, but including charts/diagrams is a pain. It has the advantage of keeping docs close to the code, but searching wikis does not work. Confluence kind of works (and has gliffy integration!), but its search is also terrible. I'm referring to documents like: architecture overview, what is it and how it works, user guide, but a place for javadoc/godoc would be nice as well. What works best for you?

tjalfi 10y ago
I document my programs in .c format.
- deleted 10y ago
  [deleted]
flukus 10y ago
I don't think you should need/want charts for developer documentation anyway. If you need charts to display the architecture for instance, but probably to focused on layering and not enough on producing code that actually does things. The user guide can go on that shared drive where everyone ignores it anyway.
- mabn 10y ago
  It's all cool until someone else has to touch this "code that actually does things".
  - flukus 10y ago
    And then it's still cool because they can see what it's doing instead of having the logic spread across 15 files in 6 layers.
ceasos 10y ago
None of them is one best, but combined you can a make something that floats. I am also having similar situation, github wiki, issues, milestones, google docs, url to diagrams, readme... everything combined only gives what i strive for(so far). But still search, its PITA, I agree.