Documenting Code

“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 同步。