关于将文档分为4个不同的类别,有一个非常惊人的讨论:
- 教程:用于学习
- howtos:解决特定问题
- 参考:提供信息
- 解释:帮助理解大局
这里还有一个可用的写操作:https://documentation.divio.com/
那么,给定一个软件项目(比如emacs、django或numpy(,关于架构的文档在哪里合适呢?我应该将arc42或C4model文档放在哪个目录中?
如果您想使用相同的结构,我认为它符合explanations
类别,因为体系结构文档公开了系统的高级视图。
总的来说,我认为思考文档映射到项目生态系统中的方式(也许更重要(,并努力确保文档始终是:
- 开发人员或利益相关者都可以轻松访问
- 在相关地方适当引用
- 尽可能更新
结构很重要,但优化这三个向量会给它带来更多价值