3 ms·
Your real documentation will always be your source code and configuration. Concentrate on making these clearer and more accessible (as appropriate, for instance
by csours 6y ago
Your real documentation will always be your source code and configuration. Concentrate on making these clearer and more accessible (as appropriate, for instance, don't make your passwords too accessible).
Any other "documentation" should point to your real documentation.
- detaro 6y agoHighly depends on your environment. If you have many products/projects, many things are worth documenting independently of the specific thing that encountered or used them.
- averros 6y agoI don't think you understand the purpose of documentation. It's not to say HOW things are done. Code and config files are all overly detailed and often quite convoluted HOWs. It's to explain WHY and to help people on the team orient themselves in a maturing product. It's to record thinking which went into deciding this or that implementation. It's to help people with HOW-TO recipes. It's to show the big-picture view of the project. Code and comments in code are pretty much useless for these purposes. Basically, any engineering org which doesn't pay attention to documentation is deeply disfunctional.