documentation-creation

Documentation Creation 技能為從頭開始構建全面的專案文檔提供了結構化框架。該工具專為工程團隊和技術負責人設計，通過對代碼庫、框架配置和架構元數據進行深入分析，消除了編寫樣板文檔的手動負擔。利用既定的模板，它確保您的文檔與專案的實現細節、技術棧和領域邏輯保持同步。它專門用於新服務或主要組件的初始設置階段，在這些階段需要一致、高質量的文檔來促進入職並保持對系統的掌控。

• 自動發現並記錄技術棧，包括 PHP、Symfony、Docker 和資料庫配置。

• 基於實際專案文件系統，對有界上下文、實體和存儲庫結構進行系統性映射。

• 為必要的專案工件提供基於模板的生成，例如入門指南、API 參考、架構決策記錄和測試策略。

• 自動驗證例程，確保所有文檔鏈接、命令示例和目錄路徑保持有效並反映當前的代碼實現。

• 強制執行文檔標準，包括交叉鏈接要求和對專案範圍內設計原則的遵守。

• 在啟動新存儲庫時使用此工具，以確保快速、一致的文檔覆蓋率。

• 輸入通常包括對專案根目錄的訪問權限，包括 composer.json、Makefile 和 src/ 目錄結構等文件。

• 輸出由一整套 Markdown 格式的文檔文件組成，旨在提供專案的整體視圖。

• 注意：對於代碼更改後的持續同步，請使用 documentation-sync 技能以防止內容過時。

• 確保所有專案特定的元數據（例如實體名稱和有界上下文）都在生成的輸出中正確反映，以保持技術準確性。