Hacker News new | ask | show | jobs
by roland35 1934 days ago
It takes a lot of effort to write good documentation. If the documentation is too low-level you get the extreme of "this function adds 1 to x" type comments which don't really help. If the documentation is high-level, many important details can be left out.

What I try to help support on my projects are higher-level block diagrams which show the relationships between major components. Hopefully that doesn't change too quickly! The lower level API should be generated straight from the code itself with a tool like swagger or doxygen if possible.

1 comments

There's this quote by Linus torvalds: bad programmers worry about code, good programmers worry about data structures.

This should be reflected in the documentation.