documentation-guidelisted
Install: claude install-skill AsiaOstrich/universal-dev-standards
# 文件指南
> **語言**: [English](../../../../skills/documentation-guide/SKILL.md) | 繁體中文
**版本**: 2.1.0
**最後更新**: 2026-03-17
**適用範圍**: Claude Code Skills
---
## 目的
本 Skill 提供專案文件的全面指導，包括：
- 文件結構和檔案組織
- 依專案類型的內容需求
- 技術文件的撰寫標準
- 常見文件類型的範本
---
## 快速參考（YAML 壓縮格式）
```yaml
# === 專案類型 → 文件需求 ===
document_matrix:
# README ARCH API DB DEPLOY MIGRATE ADR CHANGE CONTRIB
new: [REQ, REQ, if_app, if_app, REQ, NO, REC, REQ, REC]
refactor: [REQ, REQ, REQ, REQ, REQ, REQ, REQ, REQ, REC]
migration: [REQ, REQ, REQ, REQ, REQ, REQ, REQ, REQ, REC]
maintenance:[REQ, REC, REC, REC, REC, NO, if_app, REQ, if_app]
# REQ=必要, REC=建議, if_app=如適用, NO=不需要
# === 文件金字塔 ===
pyramid:
level_1: "README.md → 入口點，快速概覽"
level_2: "ARCHITECTURE.md → 系統概述"
level_3: "API.md, DATABASE.md, DEPLOYMENT.md → 技術細節"
level_4: "ADR/, MIGRATION.md, CHANGELOG.md → 變更歷史"
# === 必要檔案 ===
root_files:
README.md: {required: true, purpose: "專案概述、快速入門"}
CONTRIBUTING.md: {required: "recommended", purpose: "貢獻指南"}
CHANGELOG.md: {required: "recommended", purpose: "版本歷史"}
LICENSE: {required: "for OSS", purpose: "授權資訊"}
docs_structure:
INDEX.md: "文件索引"
ARCHITECTURE.md: "系統架構"
API.md: "API 文件"
DATABASE.md: "資料庫綱要"
DEPLOYMENT.md: "部署指南"
MIGRATION.md: "遷移計畫（如適用）"
ADR/: "架構決策記錄"
# === 檔案命名 ===
naming:
root: "UPPERCASE.md (README.md, CONTRIBUTING.md, CHANGELOG.md)"
docs: "lowercase-kebab-case.md (g