/install gen-coding-specs
\r \r
gen-coding-specs - 生成技术编码规范\r
\r
技能 ID: gen-coding-specs \r
版本: 1.3.0 \r
\r
目标\r
\r
为当前工作空间生成完整的编码规范文档(docs/coding-specs/coding.*.md),使 AI 与开发者对技术栈、接口、风格、测试等达成一致;与 gen-code 读取路径一致(见 skills/SKILLS-FILE-OUTPUT.md 第五节)。\r
\r
模板来源(技能自备)\r
\r 模板与本技能同目录维护,路径:\r \r
- 本仓库:
skills/gen-coding-specs/templates/(与SKILL.md同级下的templates/)\r - 仅拷贝本技能到目标项目时:请保留
gen-coding-specs/templates/整目录,与SKILL.md一并拷贝;生成时从此目录读取,写入项目内docs/coding-specs/。\r \r 执行生成时,以templates/为相对路径(相对于本技能目录)解析各coding.*.md源文件。\r \r
执行步骤\r
\r 完整执行流程、12 分册定制规则、交叉一致性校验见 prompt.md。\r \r
1. 分析工作空间\r
\r
- 技术栈:语言、框架、数据库、构建工具等 \r
- 项目结构:目录与模块划分 \r
- 业务领域:简要背景 \r
- 现有规范:是否已有
docs/coding-specs/内容 \r \r
2. 创建规范目录\r
\r 若不存在则创建(须先建目录再写文件):\r \r
mkdir -p docs/coding-specs\r
```\r
\r
### 3. 生成规范文档\r
\r
按模板生成并落盘到 **`docs/coding-specs/`**,文件名固定:\r
\r
| 输出文件 | 模板 |\r
|----------|------|\r
| `coding.index.md` | `templates/coding.index.md` |\r
| `coding.api.md` | `templates/coding.api.md` |\r
| `coding.architecture.md` | `templates/coding.architecture.md` |\r
| `coding.data-models.md` | `templates/coding.data-models.md` |\r
| `coding.vue.md` | `templates/coding.vue.md` |\r
| `coding.coding-style.md` | `templates/coding.coding-style.md` |\r
| `coding.testing.md` | `templates/coding.testing.md` |\r
| `coding.security.md` | `templates/coding.security.md` |\r
| `coding.performance.md` | `templates/coding.performance.md` |\r
| `coding.documentation.md` | `templates/coding.documentation.md` |\r
| `coding.code-review.md` | `templates/coding.code-review.md` |\r
| `coding.version-control.md` | `templates/coding.version-control.md` |\r
\r
### 4. 定制\r
\r
按项目填充技术栈、示例与团队约定;保持各分册之间无冲突。\r
\r
### 5. 验证\r
\r
- [ ] 索引 `coding.index.md` 可导航到各分册 \r
- [ ] 内容反映真实技术栈与约束 \r
- [ ] 格式正确、含必要示例 \r
\r
## 输出与衔接\r
\r
- **落盘**:遵守 [SKILLS-FILE-OUTPUT.md](../SKILLS-FILE-OUTPUT.md)。\r
- **后续**:**gen-code** 等技能执行时须**直接读取** `docs/coding-specs/` 下对应 `coding.*.md`(见 `coding.index.md` 索引),无需单独「加载上下文」技能。\r
- **规范随项目变更**:可再次执行本技能覆盖生成,或直接编辑 `docs/coding-specs/` 下 Markdown。\r
\r
## 相关技能\r
\r
### 前置技能\r
\r
- **gen-design**: 系统设计,提供技术栈和边界定义\r
\r
### 后续技能\r
\r
- **gen-code**: 主要消费者,读取技术规范作为编码风格标准\r
- **注意**:若项目采用契约驱动开发,`gen-code` 优先读取 `contract-gen` 输出的 YAML 契约\r
- 本技能生成的 Markdown 规范作为**风格标准**(命名规范、代码格式等)\r
- **contract-gen**: 契约生成,生成机器可读的 YAML 契约\r
- 本技能生成规范后,可执行 `contract-gen` 生成精确的结构定义\r
- 契约应遵循本技能的规范(如 `coding.api.md` 的接口风格、`coding.data-models.md` 的命名规范)\r
- **review-code**: 审查时对照本规范分册\r
\r
### 技能分工\r
\r
| 技能 | 输出 | 用途 | gen-code 读取优先级 |\r
|------|------|------|-------------------|\r
| **gen-coding-specs** | `docs/coding-specs/*.md` | 风格规范(命名、格式、代码风格) | 🟡 中(风格) |\r
| **contract-gen** | `docs/contracts/*.yaml` | 精确结构定义(表名、字段、API 路径) | 🔴 高(优先) |\r
\r
**建议流程**:\r
- **标准流程**:`gen-design` → `gen-coding-specs` → `gen-code`\r
- **契约驱动**:`gen-design` → `gen-coding-specs` → `contract-gen` → `gen-code`\r
\r
全链路见 [SKILL-VALUE-CHAIN.md](../SKILL-VALUE-CHAIN.md)。\r
\r
---\r
\r
*本技能替代原「command + instructions」安装方式;不再向 `.cursor/commands` 等目录安装命令文件。*\r
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install gen-coding-specs - After installation, invoke the skill by name or use
/gen-coding-specs - Provide required inputs per the skill's parameter spec and get structured output
What is Gen Coding Specs?
基于模板为当前工作空间生成完整技术编码规范,写入 docs/coding-specs/,供 gen-code 与其它技能消费。 It is an AI Agent Skill for Claude Code / OpenClaw, with 140 downloads so far.
How do I install Gen Coding Specs?
Run "/install gen-coding-specs" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is Gen Coding Specs free?
Yes, Gen Coding Specs is completely free, licensed under MIT-0. You can download, install and use it at no cost.
Which platforms does Gen Coding Specs support?
Gen Coding Specs is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created Gen Coding Specs?
It is built and maintained by Liu Feng (@lf951515851); the current version is v1.0.0.