2 ms·
I really like these "how do other people do X?" questions on HN. Thanks for asking it! I work at a small startup with a roughly 10-person eng team. When we wr
by skewart 11y ago
I really like these "how do other people do X?" questions on HN. Thanks for asking it!
I work at a small startup with a roughly 10-person eng team.
When we write docs we focus mainly on architecture and processes. The architecture docs often emerge from a "tech spec" that was written for the development of a feature that required a new service, or substantial changes to a new one. We keep everything in Github, in a README or other markdown files.
We also write API docs for HTTP endpoints. These are written with client developers and their concerns in mind. When doing this for a Rails app we use rspec_API_documentation, which is nice, but it can be annoying to have testing and documentation so tightly couples. We've talked about changing how we do this, but we always have more pressing things to do.
We never write docs for classes or modules within an app/service.
- brwr 11y agoMy pleasure! Questions like these are a great way to get a large set of informed opinions quickly. Regarding your comment on considering changing your API docs: What have you and your team talked about moving to? Also, why no class or module docs? I find a docstring at the top of the class that talks about it's implementation, usage, etc very helpful.