Menú
文档模板与结构指南（Documentation templates）。README、API 文档、代码注释与 AI 友好型文档。
Instalar con Codex o Claude Copia este prompt, pégalo en Codex, Claude u otro asistente, y deja que revise la página de la skill y la instale por ti.
Basado en la clasificación ocupacional SOC
| name | documentation-templates |
| description | 文档模板与结构指南（Documentation templates）。README、API 文档、代码注释与 AI 友好型文档。 |
| allowed-tools | Read, Glob, Grep |
常见文档类型的模板与结构指南。
| 章节 | 用途 |
|---|---|
| 标题 + 单句描述 | 这是什么项目？ |
| 快速开始 | 5 分钟内能跑起来 |
| 功能特性 | 能做什么 |
| 配置指南 | 如何自定义 |
| API 参考 | 指向详细文档 |
| 贡献指南 | 如何参与 |
| 开源协议 | 法律条款 |
# 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
## 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]
/**
* 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);
*/
| [OK] 应当注释 | [FAIL] 不应注释 |
|---|---|
| 解释“为什么”（业务逻辑） | 解释“是什么”（显而易见的逻辑） |
| 复杂算法 | 每一行 |
| 非直观行为 | 自解释代码 |
| API 契约 | 实现细节 |
# Changelog
## [Unreleased]
### Added
- New feature
## [1.0.0] - 2025-01-01
### Added
- Initial release
### Changed
- Updated dependency
### Fixed
- Bug fix
# 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?
面向 AI 爬虫与代理（agents）：
# 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
用于 RAG（检索增强生成）索引：
| 原则 | 目的 |
|---|---|
| 可扫描 | 使用标题、列表、表格 |
| 示例优先 | 先展示，再解释 |
| 渐进展开 | 简单 -> 复杂 |
| 保持更新 | 过期即误导 |
提醒： 模板只是起点，请根据项目需求调整。
务实的编码标准—— 简洁、直接、不做过度设计、不写无用注释（Pragmatic coding standards）
性能分析原则。测量、分析与优化技术。
API design principles and decision-making（API 设计原则与决策逻辑）。REST vs GraphQL vs tRPC selection（选择）、response formats（响应格式）、versioning（版本控制）、pagination（分页）。
App Builder（应用构建编排器）主编排器。根据自然语言请求创建全栈应用，确定项目类型、选择技术栈并协调智能体。
Project scaffolding templates（项目脚手架模板）。用于从零创建新项目。包含 12 个技术栈模板。
Architectural decision-making framework（架构决策框架）。Requirements analysis（需求分析）、trade-off evaluation（权衡评估）、ADR documentation（架构决策记录）。Use when making architecture decisions or analyzing system design（用于架构决策与系统设计分析）。