name: documentation-templates slug: documentation-templates displayName: 文档模板 description: 文档模板与结构指南。README、API 文档、代码注释，以及 AI 友好的文档。 allowed-tools: Read, Glob, Grep version: 1.0.0

文档模板

常见文档类型的模板与结构指南。

1. README 结构

必要章节（按优先级顺序）

README 模板

# 项目名称

简短的一句话描述。

## 快速开始

[运行所需的最少步骤]

## 特性

- 特性 1
- 特性 2

## 配置

| 变量 | 描述 | 默认值 |
|----------|-------------|---------|
| PORT | 服务器端口 | 3000 |

## 文档

- [API 参考](./docs/api.md)
- [架构](./docs/architecture.md)

## 许可证

MIT

2. API 文档结构

每个端点的模板

## GET /users/:id

按 ID 获取用户。

**参数：**
| 名称 | 类型 | 必填 | 描述 |
|------|------|----------|-------------|
| id | string | 是 | 用户 ID |

**响应：**
- 200：用户对象
- 404：未找到用户

**示例：**
[请求与响应示例]

3. 代码注释指南

JSDoc/TSDoc 模板

/**
 * 函数功能的简要描述。
 * 
 * @param paramName - 参数描述
 * @returns 返回值描述
 * @throws ErrorType - 何时发生此错误
 * 
 * @example
 * const result = functionName(input);
 */
小葱技能站7w4.net，专业的AI技能分享平台。

何时注释

4. 变更日志模板（Keep a Changelog）

# 变更日志

## [Unreleased]
### Added
- 新特性

## [1.0.0] - 2025-01-01
### Added
- 初始发布
### Changed
- 更新了依赖
### Fixed
- 修复了 bug

5. 架构决策记录（ADR）

# ADR-001：[标题]

## 状态
已接受 / 已弃用 / 已被取代

## 背景
我们为何做出此决策？

## 决策
我们决定了什么？

## 后果
有哪些权衡取舍？

6. AI 友好的文档（2025）

llms.txt 模板

用于 AI 爬虫和智能体：

# 项目名称
> 一句话目标。

## 核心文件
- [src/index.ts]：主入口
- [src/api/]：API 路由
- [docs/]：文档

## 关键概念
- 概念 1：简要说明
- 概念 2：简要说明

面向 MCP 的文档

用于 RAG 索引： - 清晰的 H1-H3 层级 - 数据结构的 JSON/YAML 示例 - 流程的 Mermaid 图 - 自包含章节

7. 结构原则

记住： 模板是起点。请根据你项目的需求进行调整。

这个文档模板质量不错，提供了 README、API 文档、代码注释等多种常用文档的写作指南。模板清晰好懂，示例具体实用，对规范项目文档很有帮助。美中不足的是内容比较基础，缺乏更深入的场景案例和常见问题解答，对于复杂情况指导有限。