Menu
文档写作技能，帮助撰写技术文档、API 文档、用户手册等
Installer avec Codex ou Claude Copiez ce prompt, collez-le dans Codex, Claude ou un autre assistant, puis laissez-le vérifier la page du skill et l'installer pour vous.
API 测试技能，帮助测试和调试 HTTP API 接口
代码审查技能，帮助审查代码质量、发现潜在问题并提供改进建议
数据分析技能，帮助分析数据、生成可视化图表和提供数据洞察
HITL 人机交互测试技能，用于测试和演示多步人机交互功能（选择、确认、输入、表单）
SQL 专家技能，帮助编写、优化和调试 SQL 查询
Basé sur la classification professionnelle SOC
| name | document-writer |
| description | 文档写作技能，帮助撰写技术文档、API 文档、用户手册等 |
| category | document |
| tags | ["document","writing","technical","api","markdown"] |
这个技能帮助你撰写各类专业文档：
# 项目名称
简短的项目描述（一两句话）
## 功能特性
- ✅ 特性一
- ✅ 特性二
- ✅ 特性三
## 快速开始
### 安装
```bash
npm install package-name
import { something } from 'package-name';
// 示例代码
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| option1 | string | - | 描述 |
| option2 | number | 10 | 描述 |
详见 API 文档
欢迎贡献！请阅读 贡献指南
MIT License
### 2. API 接口文档
```markdown
# API 接口文档
## 基础信息
- 基础 URL: `https://api.example.com/v1`
- 认证方式: Bearer Token
## 接口列表
### 获取用户信息
获取指定用户的详细信息。
**请求**
GET /users/{id}
**路径参数**
| 参数 | 类型 | 必填 | 说明 |
|------|------|------|------|
| id | string | 是 | 用户 ID |
**请求头**
| 参数 | 类型 | 必填 | 说明 |
|------|------|------|------|
| Authorization | string | 是 | Bearer {token} |
**响应**
```json
{
"code": 200,
"data": {
"id": "user_123",
"name": "张三",
"email": "zhangsan@example.com",
"created_at": "2024-01-01T00:00:00Z"
}
}
错误码
| 错误码 | 说明 |
|---|---|
| 404 | 用户不存在 |
| 401 | 未授权 |
### 3. 技术设计文档
```markdown
# 技术设计文档
## 1. 概述
### 1.1 背景
[描述项目背景和需求来源]
### 1.2 目标
- 目标一
- 目标二
### 1.3 非目标
- 不在本次范围内的内容
## 2. 系统设计
### 2.1 架构图
[架构图]
### 2.2 核心组件
#### 组件 A
- 职责: [描述]
- 接口: [描述]
#### 组件 B
- 职责: [描述]
- 接口: [描述]
### 2.3 数据流
[描述数据如何在系统中流动]
## 3. 详细设计
### 3.1 数据模型
```sql
CREATE TABLE users (
id VARCHAR(36) PRIMARY KEY,
name VARCHAR(100) NOT NULL,
created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
);
[API 接口列表]
[算法描述和伪代码]
| 风险 | 影响 | 缓解措施 |
|---|---|---|
| 风险一 | 高 | 措施 |
### 4. 变更日志
```markdown
# 变更日志
本项目遵循 [语义化版本](https://semver.org/lang/zh-CN/)。
## [未发布]
### 新增
- 新功能描述
### 变更
- 变更描述
### 修复
- Bug 修复描述
## [1.0.0] - 2024-01-01
### 新增
- 初始版本发布
- 核心功能 A
- 核心功能 B
### 安全
- 安全相关更新
# ## ###- * 1.code [text](url)| col1 | col2 |> quote**bold** *italic*