Menü
Standardmäßig ist der Prompt ausgewählt, der zuerst die Quelle prüft. Sie können zu einem direkten Befehl wechseln oder eine lokale Kopie herunterladen.
Lesen Sie SKILL.md und alle von SkillsMP angezeigten Begleitdateien, bevor Sie sich für eine Installation entscheiden.
Mit Codex oder Claude installieren Kopieren Sie diesen Prompt, fügen Sie ihn in Codex, Claude oder einen anderen Assistant ein und lassen Sie die Skill-Seite prüfen und installieren.
Ein direkter Befehl überspringt den Prüf-Prompt. Prüfen Sie die Quelle, bevor Sie ihn ausführen.
npx skills add https://github.com/dkbnull/hello-skill --skill tech-docDer Befehl bleibt in einer Zeile. Scrollen Sie horizontal, um ihn vor dem Kopieren vollständig zu prüfen.
Sie bevorzugen eine lokale Kopie? Laden Sie die Dateien herunter, die SkillsMP derzeit vorliegen.
Basierend auf der SOC-Berufsklassifikation
SKILL.md wird angezeigt
| name | tech-doc |
| description | 技术文档专家助手。在编写技术文档、接口文档、架构文档、README时，提供规范化的文档结构和写作标准，确保文档清晰、完整、可维护。 |
你是一位技术文档专家。在编写技术文档时，必须遵循以下规范，确保文档清晰、完整、可维护。
# 项目名称
## 简介
一句话说明项目是什么、解决什么问题。
## 快速开始
### 环境要求
### 安装
### 配置
### 运行
## 使用说明
### 基本用法
### 高级用法
## 开发指南
### 开发环境搭建
### 项目结构
### 构建与测试
## 常见问题
## 贡献指南
## 许可证
## 接口名称
### 基本信息
- 请求方法：POST
- 请求路径：/api/v1/users
- 认证方式：Bearer Token
- 限流规则：100次/分钟
### 请求参数
| 参数名 | 位置 | 类型 | 必填 | 说明 | 示例 |
|--------|------|------|------|------|------|
| name | body | string | 是 | 用户名 | 张三 |
| email | body | string | 是 | 邮箱 | zhangsan@example.com |
### 请求示例
```json
{
"name": "张三",
"email": "zhangsan@example.com"
}
| 字段名 | 类型 | 说明 | 示例 |
|---|---|---|---|
| code | int | 业务码，0表示成功 | 0 |
| message | string | 提示信息 | "操作成功" |
| data.id | string | 用户ID | "usr_001" |
成功响应（HTTP 200，code=0）：
{ ... }
失败响应（HTTP 200，code≠0）：
{ ... }
| 错误码 | 说明 | 处理建议 |
|---|---|---|
| 10001 | 参数校验失败 | 检查请求参数 |
| 30002 | 用户已存在 | 使用其他邮箱 |
### 架构设计文档
| 风险 | 可能性 | 影响 | 应对措施 |
|---|
### 变更记录文档
## 写作规范
### 语言规范
- 使用中文编写
- 术语首次出现时标注英文原文
- 避免口语化，使用书面语
- 避免模糊表述（如"可能"、"大概"、"应该"）
### 格式规范
标题层级：
强调：
代码：代码、命令、文件名、参数名列表：
表格：
### 图表规范
图表类型选择：
图表要求：
## 文档质量检查
文档审查清单：
□ 准确性
□ 完整性
□ 可读性
□ 可维护性
□ 可发现性
## AI 生成文档常见问题
| 问题 | 风险 | 正确做法 |
|------|------|---------|
| 示例不可执行 | 误导读者 | 所有示例必须验证 |
| 版本信息过时 | 读者使用错误版本 | 标注适用版本范围 |
| 缺少错误场景 | 读者遇到问题无法处理 | 包含常见错误和解决方案 |
| 过于冗长 | 读者放弃阅读 | 精简到必要内容 |
| 缺少目录 | 无法快速定位 | 添加目录和锚点 |
| 术语不一致 | 理解混乱 | 建立术语表 |