documentation

仓库创建 2026年6月30日最近提交 21 天前SkillHot 收录 20 天前

▸ 精选理由

结构化地帮助团队记录决策与运维流程，利于长期维护。

这个 Skill 做什么

生成与维护规格、README、ADR 和运行手册的写作指南与模板。

把规格、README、API 文档、ADR 和运行手册写成同事能直接用的版本：既能在开工前把需求写清，也能在上线后把接口和操作步骤记录下来。适合写新功能的 spec、记录重要决策、编写上手或故障处理流程，或修正文档与代码不一致时用。特点是给出实用模板和写法建议，让文档不是摆设而是可执行的指南。

▸ 展开 SKILL.md 英文原文

Use when writing or updating specs, READMEs, API/reference docs, ADRs, or runbooks — record an ADR per decision, update docs when a feature ships, fix drifted docs.

内容创作文档ADR运行手册通用

Stars

Forks

仓库内 Skill

7 日增星

安装 / 使用

给你的 Agent 一句话（通用）

帮我安装这个 skill：https://raw.githubusercontent.com/muxammadmamajonov/dot-claude/main/.claude/skills/documentation/SKILL.md

或 curl 直取 SKILL.md

curl -fsSL "https://raw.githubusercontent.com/muxammadmamajonov/dot-claude/main/.claude/skills/documentation/SKILL.md"

SKILL.MD 节选查看完整文件 ↗

# Documentation: Specs, Docs, ADRs, Runbooks

## When to use
- Capturing a feature before build (spec) or its interface after (reference/API docs).
- Recording a significant technical decision and its rationale (ADR).
- Writing an operational procedure for a recurring or emergency task (runbook).
- Onboarding docs (README / getting-started), or fixing docs that no longer match the code.
- When a review, audit, or incident reveals that a critical procedure exists only in someone's head.

Applies to every project type. The artifacts below — spec, reference, ADR, runbook, README — exist whether the project is a web app, an API, a CLI, a game, an embedded device, or an agent system. The *format*

via SKILL·HOT · 数据来自 GitHub 公开信息 · 原文版权归作者所有