用途
Documentation Templates 是一个文档模板与结构指南类技能，用于在真实项目需要 README、端点参考、变更日志、ADR 或便于智能体读取的索引时，提供一套可套用的文档结构与写作规范，并帮助将其适配到项目已有的惯例中。
主要能力
1. README 结构
按优先级排列的必要章节：
| 章节 | 用途 |
|---|---|
| 标题 + 一句话简介 | 这是什么 |
| 快速开始 | 5 分钟内跑起来 |
| 功能 | 我能做什么 |
| 配置 | 如何自定义 |
| API 引用 | 指向详细文档的链接 |
| 贡献 | 如何参与 |
| 许可证 | 法律信息 |
README 模板：
# 项目名称
一句话简介。
## Quick Start
[运行所需的最小步骤]
## Features
- 功能 1
- 功能 2
## Configuration
| Variable | Description | Default |
|----------|-------------|---------|
| PORT | Server port | 3000 |
## Documentation
- API Reference
- Architecture
## License
[链接到项目实际许可证；不要自行推断为 MIT]
2. API 文档结构
按端点组织的模板：
## GET /users/:id
按 ID 获取用户。
**Parameters:**
| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | string | Yes | User ID |
**Response:**
- 200: User object
- 404: User not found
**Example:**
[请求与响应示例]
3. 代码注释指南
JSDoc/TSDoc 模板：
/**
* 简要说明该函数做什么。
*
* @param paramName - 参数说明
* @returns 返回值说明
* @throws ErrorType - 何时抛出该错误
*
* @example
* const result = functionName(input);
*/
何时注释：
| ✅ 应注释 | ❌ 不应注释 |
|---|---|
| 为什么（业务逻辑） | 显而易见的内容 |
| 复杂算法 | 逐行注释 |
| 非显而易见的行为 | 自解释的代码 |
| API 契约 | 实现细节 |
4. 变更日志模板（Keep a Changelog）
# Changelog
## [Unreleased]
### Added
- 新功能
## [1.0.0] - 2025-01-01
### Added
- 初始发布
### Changed
- 更新依赖
### Fixed
- 修复缺陷
5. 架构决策记录（ADR）
# ADR-001: [标题]
## Status
Accepted / Deprecated / Superseded
## Context
我们为什么要做这个决策？
## Decision
我们决定了什么？
## Consequences
有哪些取舍？
6. 面向 AI 的文档（2025）
llms.txt 模板，供 AI 爬虫与智能体使用（其中 example.com 链接仅用于说明语法，需替换为实际发布的项目 URL）：
# 项目名称
> 一句话目标。
## Core Files
- [Main entry](https://example.com/project/src/index.ts): 应用入口
- [API routes](https://example.com/project/src/api/): 端点实现
- [Documentation](https://example.com/project/docs/): 用户与贡献者指南
## Key Concepts
- 概念 1：简要说明
- 概念 2：简要说明
便于 RAG 索引的组织方式：
- 清晰的 H1–H3 层级
- 数据结构使用 JSON/YAML 示例
- 流程使用 Mermaid 图
- 各章节自包含
7. 结构原则
| 原则 | 原因 |
|---|---|
| 可扫描 | 标题、列表、表格 |
| 示例优先 | 展示而不只是讲述 |
| 渐进式细节 | 从简单到复杂 |
| 保持更新 | 过时即误导 |
使用方式
当实际项目需要 README、端点参考、变更日志、ADR 或供智能体读取的索引，且需要一套适配其既有惯例的结构时使用本技能。模板是起点，应结合项目需要调整。
限制
- 需将示意性的路径、命令、日期与默认值替换为经验证的项目事实。
- 模板不是已安装的工作流，也不构成链接与示例可用的证据。
- 需保留真实的许可证与保密范围；不要发布私密端点，不要虚构已接受的 ADR 决策。
- 仅当任务明确匹配上述范围时使用本技能。
- 不应将输出视为环境特定验证、测试或专家评审的替代。
- 若缺少必要输入、权限、安全边界或成功标准，应停止并请求澄清。
适用场景
适用于真实项目的 README 撰写、API 端点文档、变更日志维护、架构决策记录整理，以及为 AI 爬虫、智能体或 RAG 索引准备可读文档。
暂未提供
关于本技能的安装方式、收费与价格、支持平台等信息，资料中暂未提供。