所以我深入研究了這個話題,發現我對文檔實踐和框架的了解是多麼的淺薄,而這些在實際的文檔中或是大型課程中從未提及過。 arc42、C4建模、Diátaxis是我從未見過人們明確實踐的幾種方法。 我見過的大多數代碼庫都有非常隨意的文檔,作為事後補充,或者在另一個極端的情況下,則被經驗豐富的技術作家完全簡化和抽象化,以至於無法理解產品表面下的複雜性。 話雖如此,我現在正在開發自己的代理文檔工具,應該能夠將這些方法付諸實踐,並為高速度的代碼庫維護一致的文檔,並且能夠與任何類型的開發工作流程兼容,還能夠從頭處理整個代碼庫,並通過處理任意來源的git差異來維護它們。