文档 代码
- 作者仓库星标 1
- 作者仓库 claude-skills
Docs From Code
Overview
Translate what the code does into documentation people can actually use.
Core Workflow
- Identify the audience first: developer, operator, customer, reviewer, or teammate.
- Read the code, scripts, config, and tests to extract accurate setup steps, behaviors, constraints, and terminology.
- Organize the document around real user needs such as setup, architecture, usage, troubleshooting, or change impact.
- Add examples and commands only when they are supported by the repo or provided artifacts.
- Tighten for clarity and remove implementation noise that does not help the audience.
Deliver
- Produce docs that are specific, runnable, and easy to scan.
- Include caveats, prerequisites, and common failure points when they matter.
- Update existing docs instead of creating duplicates when a home already exists.
Guardrails
- Do not invent commands, file paths, or guarantees.
- Keep architecture explanations high-signal rather than encyclopedic.
- Prefer the repository's established tone and documentation structure.
- 流狐分类
- 文档
- 作者声明 Agent
- 未找到明确声明；不据此推断已兼容或已测试
- 静态检查
- 88 / 100 · 启发式扫描，不代表运行安全
- 作者 / 版本 / 许可
- @00PrabalK00 · 未声明 license
- 流狐 Token 估算
- 低消耗
- 流狐接入估算
- 即装即用
- 是否需要外部 API Key
- 未发现要求
- 检测到的系统要求
- 未声明
- 底层运行要求
- 未声明
- 检测到的文件与系统行为
-
- 只读
- 允许写入 / 修改
- 检测到的网络行为
- 仅限本地
- 安装命令数
- 无（仅作为资料）
档案由构建时根据 SKILL.md 与安装命令自动衍生，可能与作者实际意图存在差异。
需要注意： 未限定 allowed-tools，默认拥有全部工具权限。
作者没有在当前 SKILL.md 中定义固定输出样例。Translate what the code does into documentation people can actually use.
Identify the audience first: developer, operator, customer, reviewer, or teammate. Read the code, scripts, config, and tests to extract accurate setup steps, behaviors, constraints, and terminology. Organize the document around real user needs such as setup,…
Produce docs that are specific, runnable, and easy to scan. Include caveats, prerequisites, and common failure points when they matter. Update existing docs instead of creating duplicates when a home already exists.
Do not invent commands, file paths, or guarantees. Keep architecture explanations high-signal rather than encyclopedic. Prefer the repository's established tone and documentation structure.
# Docs From Code
## Overview
Translate what the code does into documentation people can actually use.
## Core Workflow
1. Identify the audience first: developer, operator, customer, reviewer, or teammate.
2. Read the code, scripts, config, and tests to extract accurate setup steps, behaviors, constraints, and terminology.
3. Organize the document around real user needs such as setup, architecture, usage, troubleshooting, or change impact.
4. Add examples and commands only when they are supported by the repo or provided artifacts.
5. Tighten for clarity and remove implementation noise that does not help the audience.
## Deliver
- Produce docs that are specific, runnable, and easy to scan.
- Include caveats, prerequisites, and common failure points when they matter.
- Update existing docs instead of creating duplicates when a home already exists.
## Guardrails
- Do not invent commands, file paths, or guarantees.
- Keep architecture explanations high-signal rather than encyclopedic.
- Prefer the repository's established tone and documentation structure.作者原文负责流程事实；流狐只索引当前章节、要点、文件与命令。
章节 -> Overview → Core Workflow → Deliver → Guardrails
要点 -> Translate what the code does into documentation people can actually use. · 1. Identify the audience first: developer, operator, customer, reviewer, or teammate. · - Produce docs that are specific, runnable, and easy to scan. · - Do not invent commands, file paths, or guarantees.
文件/命令 -> 原文未列出明确文件或命令
内容 SHA-256 -> e7b0daa507dd
方法与流程
适用与边界
原文中的明确线索