technical-documentation

仓库创建 2026年7月25日最近提交 5 天前SkillHot 收录 3 天前

这个 Skill 做什么

帮你把代码库里的技术文档和 agent 指令写清楚、可执行又好维护，既给人看也给自动化 agent 用。适合新建或重构文档、写 contributor/governance 文件或产出长期可复用的文档。特点是强调可操作性和可维护性，避免模糊的流程描述，能把复杂技术内容拆成明确的步骤和示例。

▸ 展开 SKILL.md 英文原文

Build and review high-quality technical docs as well as agent instruction files in your repository.

Stars

Forks

仓库内 Skill

7 日增星

安装 / 使用

给你的 Agent 一句话（通用）

帮我安装这个 skill：https://raw.githubusercontent.com/kody-w/rapp-toaster/main/examples/openclaw-in-rapp/technical-documentation/SKILL.md

或 curl 直取 SKILL.md

curl -fsSL "https://raw.githubusercontent.com/kody-w/rapp-toaster/main/examples/openclaw-in-rapp/technical-documentation/SKILL.md"

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

# Technical Documentation

## Purpose

Produce and review technical documentation that is clear, actionable, and maintainable for both humans and agents, including contributor-governance files and agent instruction files.

## When to use

- Creating or overhauling docs in an existing product/codebase (brownfield).
- Building evergreen docs meant to stay accurate and reusable over time.
- Reviewing doc diffs for structure, clarity, and operational correctness.
- Running full-repo documentation audits that must include both governance files and product docs surfaces (`docs/`, `README*`, `.md/.mdx/.mdc`, Fern/Sphinx/Mintlify-style sources).
- Updating or reviewing AGENTS.md and/or CONTRIBUTING.

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