用途
该技能用于为常见文档类型提供模板与结构指南，帮助开发者以统一、清晰的方式编写项目文档。它覆盖 README、API 文档、代码注释、变更日志、架构决策记录（ADR）以及面向 AI 的文档等场景。
主要能力
1. README 结构
按优先级列出必要章节：标题 + 一句话说明（这是什么）、快速开始（5 分钟内运行）、功能（我能做什么）、配置（如何自定义）、API 参考（链接到详细文档）、贡献（如何帮助）、许可证（法律）。
README 模板示例：
# Project Name
Brief one-line description.
## Quick Start
[Minimum steps to run]
## Features
- Feature 1
- Feature 2
## Configuration
| Variable | Description | Default |
|----------|-------------|---------|
| PORT | Server port | 3000 |
## Documentation
- [API Reference](./docs/api.md)
- [Architecture](./docs/architecture.md)
## License
MIT
2. API 文档结构
按端点提供模板，包含方法、路径、说明、参数表（名称、类型、是否必填、描述）、响应状态码说明以及请求与响应示例。
示例：
## GET /users/:id
Get a user by ID.
**Parameters:**
| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | string | Yes | User ID |
**Response:**
- 200: User object
- 404: User not found
**Example:**
[Request and response example]
3. 代码注释指南
提供 JSDoc/TSDoc 模板：
/**
* Brief description of what the function does.
*
* @param paramName - Description of parameter
* @returns Description of return value
* @throws ErrorType - When this error occurs
*
* @example
* const result = functionName(input);
*/
并给出何时注释的对照：应注释“为什么（业务逻辑）”“复杂算法”“非显而易见的行为”“API 契约”；不应注释“显而易见的内容”“每一行”“自解释的代码”“实现细节”。
4. 变更日志模板（Keep a Changelog）
# Changelog
## [Unreleased]
### Added
- New feature
## [1.0.0] - 2025-01-01
### Added
- Initial release
### Changed
- Updated dependency
### Fixed
- Bug fix
5. 架构决策记录（ADR）
# ADR-001: [Title]
## Status
Accepted / Deprecated / Superseded
## Context
Why are we making this decision?
## Decision
What did we decide?
## Consequences
What are the trade-offs?
6. 面向 AI 的文档
llms.txt 模板（供 AI 爬虫与智能体使用）：
# Project Name
> One-line objective.
## Core Files
- [src/index.ts]: Main entry
- [src/api/]: API routes
- [docs/]: Documentation
## Key Concepts
- Concept 1: Brief explanation
- Concept 2: Brief explanation
MCP 就绪文档（用于 RAG 索引）：清晰的 H1-H3 层级、数据结构的 JSON/YAML 示例、流程的 Mermaid 图、自包含的章节。
7. 结构原则
可扫描（标题、列表、表格）、示例优先（展示而非仅说明）、渐进式细节（从简单到复杂）、保持最新（过时即误导）。
使用方式
资料未提供具体的安装命令或调用步骤，暂未提供。该技能以模板和指南形式呈现，可作为编写文档时的起点，按项目需要调整。
适用场景
适用于需要编写或规范项目文档的开发者，包括 README、API 文档、代码注释、变更日志、架构决策记录，以及希望让文档更便于 AI 爬虫、智能体和 RAG 索引读取的场景。
限制
资料明确说明：模板只是起点，需根据项目需求调整。资料未提供收费、价格、平台支持范围等信息，暂未提供。