什么样的文档是架构文档？

What kind of documentation is architecture documentation?

关于将文档分为 4 个不同的类别really amazing talk：

这里还有一篇文章：https://documentation.divio.com/

那么给定一个软件项目（如 emacs、django 或 numpy），关于架构的文档应该放在哪里？我应该将 arc42 or C4model 文件放在哪个目录？

如果您想使用相同的结构，我认为它适合 explanations 类别，因为架构文档公开了系统的高级视图。

作为一般说明，我认为考虑文档映射到项目生态系统的方式很重要（也许更重要），并尽量确保文档始终是：

  • 开发人员或利益相关者可以轻松访问
  • 在相关地方正确引用
  • 尽可能更新

结构很重要，但在这 3 个向量上进行优化会为其带来更多价值，IMO。