بنقرة واحدة
update-docs
文档更新。当用户说 "更新文档"、"文档需要同步"、"添加文档" 时激活。 支持代码变更驱动的文档更新、新文档脚手架、文档审查。
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
القائمة
文档更新。当用户说 "更新文档"、"文档需要同步"、"添加文档" 时激活。 支持代码变更驱动的文档更新、新文档脚手架、文档审查。
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
MiniHES 后端开发规范。当用户进行 FastAPI 后端开发、API 设计、数据库操作、 DLMS 协议实现、数据采集任务开发时自动激活。 涵盖分层架构、编码原则、安全要求、数据库规范。
MiniHES 代码审查。当用户请求审查代码、review PR、检查变更时激活。 支持本地变更审查和指定文件审查,输出结构化审查报告。 引用 backend-checklist.md 和 frontend-checklist.md 作为审查依据。
修复代码格式和 lint 问题。当用户在提交前需要修复代码风格、 排查 lint 错误、或说 "fix"、"格式化"、"lint" 时激活。
MiniHES 前端开发规范。当用户进行 Vue 3 前端开发、组件设计、 页面布局、样式调整时自动激活。 涵盖技术栈、组件设计原则、设计规范、Ant Design Vue 用法。
Systematic code review patterns covering security, performance, maintainability, correctness, and testing
Distills iteration lessons, categorizes them, and injects them into the most relevant Skill.md files with deduplication.
| 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