Infrastructure Documenter Skill 详细介绍
用途
该技能用于编写清晰、可维护的基础设施文档，覆盖架构图、运行手册（Runbook）、系统文档、运维流程与“文档即代码”实践，目标是让基础设施知识保持可读、可更新、可执行。
文档理念
技能提出四条原则：
- 活文档（Living documentation）：与现实保持同步。
- 面向读者（Audience-aware）：不同文档面向不同读者。
- 可操作（Actionable）：每份文档都应帮助某人完成某件事。
- 版本控制（Version-controlled）：文档变更与代码一同被跟踪。
技能从文档类型上区分了读者与用途：架构类面向工程师，用于理解系统设计；Runbook 面向运维/SRE，用于处理事件；API 文档面向开发者，用于系统集成；入职材料面向新员工，用于快速上手；决策记录面向未来的自己，用于理解“为什么这么选”。
主要能力
架构文档
提供系统架构总览写法，示例涵盖项目概述、按用户 → 边缘网络 → 应用层 → 依赖服务（数据库、缓存、支付等）的高层架构图，以及组件清单（前端框架、样式、状态管理；后端各服务的提供方与用途）。此外还给出数据流步骤（请求进入边缘、SSR/API 路由处理、数据库查询、边缘缓存、返回响应）与安全章节，包括认证流程（登录、JWT 存入 Cookie、服务端逐请求校验、RLS 策略）与数据保护要点（静态加密、传输 TLS、密钥存储、PII 字段加密）。
图表与 schema
技能包含 Mermaid 时序图示例（用户、边缘、框架、数据库、缓存之间的请求流与缓存命中/未命中分支）以及数据库 ER 图示例（users、projects、tasks 三表关系与字段定义）。
Runbook
提供 Runbook 模板，结构包括：概述、严重级别（P1 完全中断至 P4 无用户影响）、检测方式、影响评估（受影响用户、数据风险、收入影响）、前置条件、分步处置（验证问题、定位根因、应用修复、验证修复）、升级流程与事后处理。示例命令涵盖健康检查、日志跟踪、部署回滚、数据库连接数检查、终止空闲连接、排查长查询、查看表大小、识别缺失索引、并发建索引等。另附数据库性能问题专用 Runbook，包含症状、快速检查与解决步骤。
架构决策记录（ADR）
提供 ADR 模板，含状态、背景、决策、备选方案（各自的优缺点）与后果（正面、负面、风险、参考链接），示例为选择 Supabase 作为数据库的决策。
API 文档
给出 API 参考结构：基础 URL、认证方式（Bearer Token）、端点说明（获取当前用户、更新用户）、请求体字段表、curl 示例、错误响应状态码与统一错误格式。
环境与配置文档
提供环境矩阵（生产、预发、预览、开发对应的 URL、用途与部署方式）、各环境环境变量示例、访问权限划分，以及密钥轮换表（数据库密码、API Key、JWT 密钥及轮换周期与上次轮换时间）。
文档即代码
给出文档目录结构样例（architecture、runbooks、api、onboarding 等），以及通过 GitHub Actions 自动生成文档的示例：由 OpenAPI 生成 API 文档、用 TypeDoc 生成 TypeScript 文档、部署到 GitHub Pages。
清单
包含架构文档、运维文档、开发者文档三类检查清单，以及维护相关事项（评审周期、归属、变更流程、版本策略）。
适用场景
- 创建架构文档
- 编写运维 Runbook
- 记录决策依据（ADR）
- 搭建文档结构
- 制作新员工入职材料
- 构建自动化文档
- 规划事件响应流程
限制
技能内容为文档编写方法与模板示例，具体项目中的技术选型、命令与配置需结合实际情况调整；定价、平台支持范围与使用效果等事实暂未提供。