docs: add coding_prompts/README.md index
This commit is contained in:
parent
98ef0172ea
commit
19878a19a8
|
|
@ -0,0 +1,60 @@
|
|||
# Coding Prompts 编程提示词
|
||||
|
||||
> 用于 Vibe Coding 流程的专用提示词集合
|
||||
|
||||
## 📋 提示词索引
|
||||
|
||||
### 🔴 核心流程
|
||||
|
||||
| 文件 | 说明 |
|
||||
|:---|:---|
|
||||
| [标准化流程](./标准化流程.md) | 开发流程标准化 |
|
||||
| [项目计划(plan)提示词](./项目计划(plan)提示词.md) | 项目规划与计划生成 |
|
||||
| [项目上下文文档生成](./项目上下文文档生成.md) | 生成项目上下文文档 |
|
||||
| [标准项目目录结构](./标准项目目录结构.md) | 标准化项目结构 |
|
||||
|
||||
### 🟠 需求与分析
|
||||
|
||||
| 文件 | 说明 |
|
||||
|:---|:---|
|
||||
| [智能需求理解与研发导航引擎](./智能需求理解与研发导航引擎.md) | 需求理解与导航 |
|
||||
| [任务描述,分析与补全任务](./任务描述,分析与补全任务.md) | 任务分析与补全 |
|
||||
| [分析1](./分析1.md) | 通用分析提示词 |
|
||||
| [分析2](./分析2.md) | 深度分析提示词 |
|
||||
| [客观分析](./客观分析.md) | 客观分析框架 |
|
||||
|
||||
### 🟡 架构与设计
|
||||
|
||||
| 文件 | 说明 |
|
||||
|:---|:---|
|
||||
| [系统架构](./系统架构.md) | 系统架构设计 |
|
||||
| [系统架构可视化生成Mermaid](./系统架构可视化生成Mermaid.md) | Mermaid 图表生成 |
|
||||
| [前端设计](./前端设计.md) | 前端设计提示词 |
|
||||
|
||||
### 🟢 代码质量
|
||||
|
||||
| 文件 | 说明 |
|
||||
|:---|:---|
|
||||
| [胶水开发](./胶水开发.md) | 胶水编程开发规范 |
|
||||
| [前置条件式硬约束生成](./前置条件式硬约束生成.md) | 生成开发硬约束 |
|
||||
| [执行纯净性检测](./执行纯净性检测.md) | 代码纯净性检测 |
|
||||
| [人机对齐](./人机对齐.md) | 人机协作对齐 |
|
||||
|
||||
### 🔵 文档与工具
|
||||
|
||||
| 文件 | 说明 |
|
||||
|:---|:---|
|
||||
| [精华技术文档生成提示词](./精华技术文档生成提示词.md) | 技术文档生成 |
|
||||
| [简易提示词优化器](./简易提示词优化器.md) | 提示词优化 |
|
||||
| [输入简单的日常行为的研究报告摘要](./输入简单的日常行为的研究报告摘要.md) | 研究报告生成 |
|
||||
| [sh控制面板生成](./sh控制面板生成.md) | Shell 控制面板 |
|
||||
|
||||
### 📁 Excel 导出提示词
|
||||
|
||||
[xlxs-md/](./xlxs-md/) - 从 Excel 表格导出的提示词集合
|
||||
|
||||
## 🔗 相关资源
|
||||
|
||||
- [系统提示词](../system_prompts/) - AI 系统级提示词
|
||||
- [元提示词](../meta_prompts/) - 生成提示词的提示词
|
||||
- [用户提示词](../user_prompts/) - 用户自定义提示词
|
||||
|
|
@ -1,139 +0,0 @@
|
|||
---
|
||||
name: meta-skills
|
||||
description: "元技能:生成和优化 Skills 的技能。用于创建新 Skill、重构现有 Skill、建立技能标准。"
|
||||
---
|
||||
|
||||
# Meta-Skills 元技能
|
||||
|
||||
生成、优化和管理 Skills 的元级技能。
|
||||
|
||||
## When to Use This Skill
|
||||
|
||||
触发条件:
|
||||
- 需要创建新的 Skill
|
||||
- 需要重构/优化现有 Skill
|
||||
- 需要建立 Skill 编写标准
|
||||
- 需要验证 Skill 质量
|
||||
|
||||
## Not For / Boundaries
|
||||
|
||||
不适用于:
|
||||
- 直接执行领域任务(这是领域 Skill 的职责)
|
||||
- 凭空发明事实(必须基于材料)
|
||||
|
||||
必需输入:
|
||||
- 领域材料(文档/API/代码/规范)
|
||||
- 或现有 Skill 文件
|
||||
|
||||
## Quick Reference
|
||||
|
||||
### Skill 目录结构
|
||||
|
||||
```
|
||||
skill-name/
|
||||
├── SKILL.md # 必需:入口文件
|
||||
├── references/ # 可选:长文档
|
||||
│ └── index.md # 导航索引
|
||||
├── scripts/ # 可选:辅助脚本
|
||||
└── assets/ # 可选:模板/配置
|
||||
```
|
||||
|
||||
### SKILL.md 最小模板
|
||||
|
||||
```markdown
|
||||
---
|
||||
name: skill-name
|
||||
description: "[领域]能力:包含[能力1]、[能力2]。当[触发条件]时使用。"
|
||||
---
|
||||
|
||||
# skill-name Skill
|
||||
|
||||
一句话说明边界和交付物。
|
||||
|
||||
## When to Use This Skill
|
||||
|
||||
触发条件:
|
||||
- [触发1]
|
||||
- [触发2]
|
||||
|
||||
## Not For / Boundaries
|
||||
|
||||
- [不做什么]
|
||||
- [必需输入]
|
||||
|
||||
## Quick Reference
|
||||
|
||||
### 常用模式
|
||||
|
||||
**模式1:** 说明
|
||||
```
|
||||
[可直接使用的命令/代码]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
### Example 1
|
||||
- 输入:
|
||||
- 步骤:
|
||||
- 预期输出:
|
||||
|
||||
## References
|
||||
|
||||
- `references/index.md`
|
||||
|
||||
## Maintenance
|
||||
|
||||
- 来源: [文档/仓库]
|
||||
- 更新: YYYY-MM-DD
|
||||
- 限制: [已知限制]
|
||||
```
|
||||
|
||||
### 质量检查清单
|
||||
|
||||
1. `name` 匹配 `^[a-z][a-z0-9-]*$`
|
||||
2. `description` 包含"做什么+何时用"
|
||||
3. 有 "When to Use" 和 "Not For"
|
||||
4. Quick Reference ≤ 20 个模式
|
||||
5. ≥ 3 个可复现示例
|
||||
6. 长内容在 `references/`
|
||||
|
||||
## Examples
|
||||
|
||||
### Example 1: 从文档创建 Skill
|
||||
|
||||
**输入**: 官方文档 + 代码示例
|
||||
**步骤**:
|
||||
1. 创建目录 `skills/<skill-name>/`
|
||||
2. 编写 frontmatter `description`
|
||||
3. 提取 10-20 个高频模式到 Quick Reference
|
||||
4. 添加 ≥3 个端到端示例
|
||||
5. 长内容移到 `references/`
|
||||
|
||||
### Example 2: 重构臃肿 Skill
|
||||
|
||||
**输入**: 现有的长 SKILL.md
|
||||
**步骤**:
|
||||
1. 识别模式 vs 长文解释
|
||||
2. 长文移到 `references/`
|
||||
3. Quick Reference 只保留可复制的模式
|
||||
4. 添加 "Not For / Boundaries"
|
||||
|
||||
### Example 3: 验证 Skill 质量
|
||||
|
||||
**输入**: `skills/<skill-name>/`
|
||||
**步骤**:
|
||||
1. 检查 frontmatter 格式
|
||||
2. 检查必需章节
|
||||
3. 检查示例数量
|
||||
4. 检查 references 导航
|
||||
|
||||
## References
|
||||
|
||||
- [claude-skills 元技能](../claude-skills/SKILL.md) - 完整的 Skill 规范
|
||||
- [skill-template.md](./skill-template.md) - 技能模板
|
||||
|
||||
## Maintenance
|
||||
|
||||
- 来源: claude-skills 规范
|
||||
- 更新: 2025-12-19
|
||||
- 限制: 模板是建议性的,可根据需要调整
|
||||
|
|
@ -1,118 +0,0 @@
|
|||
# 技能规范化模板
|
||||
|
||||
## 元信息
|
||||
- 版本: v1.0
|
||||
- 更新: 2025-12-19
|
||||
|
||||
---
|
||||
|
||||
## 模板正文
|
||||
|
||||
```markdown
|
||||
---
|
||||
name: [skill-name]
|
||||
description: "[领域]能力:包含[能力1]、[能力2]。当[触发条件]时使用。"
|
||||
---
|
||||
|
||||
# [skill-name] Skill
|
||||
|
||||
[一句话说明边界和交付物]
|
||||
|
||||
## When to Use This Skill
|
||||
|
||||
触发条件:
|
||||
- [触发条件1:具体任务/关键词]
|
||||
- [触发条件2]
|
||||
- [触发条件3]
|
||||
|
||||
## Not For / Boundaries
|
||||
|
||||
不适用于:
|
||||
- [不做什么1]
|
||||
- [不做什么2]
|
||||
|
||||
必需输入:
|
||||
- [必需输入1]
|
||||
- [必需输入2]
|
||||
|
||||
## Quick Reference
|
||||
|
||||
### [分类1]
|
||||
|
||||
**模式1:** [一行说明]
|
||||
```
|
||||
[可直接复制使用的命令/代码]
|
||||
```
|
||||
|
||||
**模式2:** [一行说明]
|
||||
```
|
||||
[可直接复制使用的命令/代码]
|
||||
```
|
||||
|
||||
### [分类2]
|
||||
|
||||
...
|
||||
|
||||
## Examples
|
||||
|
||||
### Example 1: [场景名称]
|
||||
|
||||
**输入**: [输入描述]
|
||||
**步骤**:
|
||||
1. [步骤1]
|
||||
2. [步骤2]
|
||||
3. [步骤3]
|
||||
**预期输出**: [输出描述/验收标准]
|
||||
|
||||
### Example 2: [场景名称]
|
||||
|
||||
...
|
||||
|
||||
### Example 3: [场景名称]
|
||||
|
||||
...
|
||||
|
||||
## References
|
||||
|
||||
- `references/index.md` - 导航索引
|
||||
- `references/[topic].md` - [主题说明]
|
||||
- [外部链接](https://example.com) - [说明]
|
||||
|
||||
## Maintenance
|
||||
|
||||
- 来源: [文档/仓库/规范]
|
||||
- 更新: YYYY-MM-DD
|
||||
- 限制: [已知限制和边界情况]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 使用说明
|
||||
|
||||
1. 复制上方模板
|
||||
2. 替换 `[占位符]` 为实际内容
|
||||
3. `name` 必须是小写字母+数字+连字符
|
||||
4. `description` 必须包含"做什么"和"何时用"
|
||||
5. 至少提供 3 个示例
|
||||
|
||||
## 目录结构
|
||||
|
||||
```
|
||||
skill-name/
|
||||
├── SKILL.md # 必需
|
||||
├── references/ # 可选
|
||||
│ ├── index.md # 推荐
|
||||
│ └── [topic].md
|
||||
├── scripts/ # 可选
|
||||
└── assets/ # 可选
|
||||
```
|
||||
|
||||
## 质量检查
|
||||
|
||||
- [ ] name 格式正确
|
||||
- [ ] description 包含触发关键词
|
||||
- [ ] 有 When to Use
|
||||
- [ ] 有 Not For / Boundaries
|
||||
- [ ] Quick Reference ≤ 20 模式
|
||||
- [ ] ≥ 3 个示例
|
||||
- [ ] 长内容在 references/
|
||||
Loading…
Reference in New Issue