Menu
The review-first prompt is selected by default. You can switch to a direct command or download a local copy.
Read SKILL.md and any companion files shown by SkillsMP before deciding whether to install.
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
A direct command skips the review prompt. Inspect the source before running it.
npx skills add https://github.com/ViewWay/MiniHES --skill update-docsThe command stays on one line. Scroll horizontally to inspect it before copying.
Prefer a local copy? Download the files currently available to SkillsMP.
Based on SOC occupation classification
Showing SKILL.md
| name | update-docs |
| description | 文档更新。当用户说 "更新文档"、"文档需要同步"、"添加文档" 时激活。 支持代码变更驱动的文档更新、新文档脚手架、文档审查。 |
docs/
├── planning/ # 项目规划
│ ├── development-plan.md # 开发排期计划
│ ├── project-workflow.md # 项目开发流程
│ └── phase-overview.md # 阶段概览
├── tasks/ # 需求文档
│ └── prd-cloud-metering-system.md
├── design/ # 设计文档
│ └── tech-review-and-architecture.md
├── api/ # API 文档（按模块）
├── guides/ # 开发指南
│ └── testing-strategy.md
└── reports/ # 审查报告、复盘
规则：禁止在 docs/ 根目录直接放文件，必须进子目录。
# 查看分支变更
git diff main...HEAD --stat
| 变更位置 | 可能影响的文档 |
|---|---|
app/models/ | 架构文档（数据模型部分） |
app/api/v1/endpoints/ | API 文档、PRD（功能描述） |
app/core/config.py | 部署文档、环境配置 |
app/services/ | 架构文档（业务逻辑部分） |
app/adapters/ | 通信适配文档 |
app/dlms/ | 协议栈文档 |
| 前端页面/路由 | PRD（功能描述） |
对每个需要更新的文档：
| 类型 | 模板 |
|---|---|
| 技术方案 | 标题 + 背景 + 方案 + 对比 + 决策 |
| API 文档 | 端点 + 参数 + 响应 + 示例 |
| 操作手册 | 前置条件 + 步骤 + 验证 + 常见问题 |
| 变更记录 | 日期 + 版本 + 变更内容 + 影响 |
检查项：
docs/ 目录tech-review-and-architecture.mdYYYY-MM-DDMAJOR.MINOR.PATCH