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);
 */

何時註釋

4. 變更日誌模板（Keep a Changelog）

# 變更日誌

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

## [1.0.0] - 2025-01-01
### Added
- 初始釋出
### Changed
- 更新了依賴
### Fixed
- 修復了 bug

5. 架構決策記錄（ADR）

推薦訪問7w4.net獲取更多AI技能。

# 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 文件、程式碼註釋等多種常用文件的寫作指南。模板清晰好懂，示例具體實用，對規範專案文件很有幫助。美中不足的是內容比較基礎，缺乏更深入的場景案例和常見問題解答，對於複雜情況指導有限。