前端文档同步

文档为什么会和代码脱节

前端仓库里，README、docs/、环境变量说明、路由与 API 文档、ADR 和迁移说明往往各自维护。依赖升级、路由改名、.env.example 变更或 CI 步骤调整后，文档里仍留着旧命令、错误变量名或过时的部署流程，新人按文档操作会直接踩坑。

技能如何对齐「事实来源」

本技能把可验证的仓库状态当作唯一依据，而不是凭记忆改文案。典型流程包括：

• 识别技术栈、文档入口和本次同步范围
• 收集 package.json、锁文件、框架/构建配置、.env.example、路由与 API、类型/schema、组件、测试及 CI/部署配置
• 对照 README、docs、ADR、changelog 等中的命令、环境变量、路由/API 行为与支持矩阵
• 只写入稳定的公共约定；不把临时调试结论或未落地设计写进长期文档
• 若存在多语言文档，至少统一命令名、环境变量、路由/API 名称与版本约束
• 对 skill/agent 分发类仓库，额外同步能力表、metadata 与 runtime 说明
• 最后跑文档一致性、类型检查、测试或构建等验证

边界与注意点

公开文档应保持高信号摘要，不会把 README 扩成完整实现细节。未确认的 TODO、草案或实验能力不会写成已支持行为；也不会擅自改你未指定的私有文档。ADR 只记录背景、决策、取舍、影响与回滚线索，不做长篇复盘。完成后会列出已同步文件、事实来源与验证命令，并标出仍需人工确认的文案、翻译或外部服务配置。