所以我深入研究了这个话题,发现我对文档实践和框架的了解是多么的少,而这些在实际文档中从未提及,或者在大型课程中也不会看到。 arc42、C4建模、Diátaxis是我从未见过人们明确实践的方式。 我见过的大多数代码库都有非常临时的文档,作为事后补充,或者在另一个极端,由经验丰富的技术写手完全简化和抽象化,以至于无法理解产品表面下的复杂性。 话虽如此,我现在正在开发自己的代理文档工具,应该将其中一些实践应用于实际,并为高速度的代码库维护一致的文档,并与任何类型的开发工作流程兼容,能够从头处理整个代码库,并通过处理任意来源的git差异来维护它们。