工程開發
Documenting Code avatar

Documenting Code

將專案文件與程式碼同步。使用 init-project 標準維護功能規格、API 合約與 README,確保可追蹤性與完整性。

簡介

「Documenting Code」技能是維護開發環境中高完整性技術文件的核心引擎。它強制執行「init-project」標準,確保每個功能、使用者故事和架構變更都能被記錄、連結,並根據程式碼庫進行驗證。透過將文件視為開發生命週期中的關鍵部分,此技能可防止實作與意圖之間的偏差,為專案成長提供清晰的稽核追蹤。

  • 自動化追蹤:將使用者故事 (US-###) 連結至功能 (F-##) 與產品需求文件 (PRD)。

  • 標準化文件:針對規格、系統架構、API 合約與資料計畫強制執行一致的 YAML 結構。

  • 整合驗證:提供指令列工具以檢查損壞的連結、孤立文件與 API 一致性。

  • README 編排:根據目前文件狀態自動更新專案概覽、功能列表與安裝說明。

  • 生命週期管理:根據專案成熟度,自動路由至綠地 (初始化) 或棕地 (更新) 工作流程。

  • 指令套件:包含如 /manage-project/update/update-feature 與 /manage-project/validate/check-consistency 等直接實用工具。

  • 每次主要實作階段後執行編排器,以保持文件最新。

  • 在完成 Pull Request 或發布前,務必使用驗證套件檢查標準合規性。

  • 使用提供的 Bash 指令稿 (例如 check-project.sh) 進行全系統完整性檢查。

  • 確保 api-contracts.yaml 中的所有 API 端點與原始程式碼中實作的邏輯相符。

  • 新增功能時,請使用 add-feature 與 add-api 指令,以確保正確的檔案結構會自動產生。

  • 維護 YAML front-matter 中繼資料 (標題、狀態、最後更新時間),以利於文件追蹤與過期內容偵測。

  • 適用於:API 文件化、系統架構更新、PRD 維護、功能追蹤、技術債稽核與 README 同步。

倉庫統計

Star 數
499
Fork 數
67
Open Issue 數
0
主要語言
JavaScript
預設分支
main
同步狀態
閒置
最近同步時間
2026年4月30日 下午12:43
在 GitHub 查看