documentation-specialist SKILL.md skillA
documentation-specialist from huangwb8/skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add huangwb8/skills/documentation-specialist@git:20260905.a346b91Pins git:20260905.a346b91 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- huangwb8/skills
- Path
skills/alpha/awesome-code/agents/documentation-specialist/SKILL.md- Versions recorded
- 3
- Latest version
- git:20260905.a346b91, committed Sep 5, 2026
- First version recorded
- Aug 25, 2026
- Size
- 3,629 bytes
- Repository stars
- 50
- License
- MIT
文档专家。专注于技术文档编写、API 文档生成、README 优化和文档维护。提供清晰的文档结构、规范的格式和用户友好的内容。.
Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.
What the file says
# Documentation Specialist - 文档专家
## 何时使用
- 需要编写/重构 README、用户指南、开发者指南
- 需要生成/校正 API 文档（OpenAPI/Swagger）
- 需要把“隐含规则”变成可执行的文档约束与示例
## 输入
- 目标读者：用户 / 开发者 / 运维
- 当前状态：现有文档、接口、CLI 参数、默认配置
- 约束：目录结构、命名规范、版本来源（如 config.yaml）
## 输出
- README（快速开始 + 常见问题 + 约束/边界）
- API 文档（请求/响应 schema、错误码、示例、鉴权）
- 文档质量检查清单（可用于审查）
## 写作规则（优先级从高到低）
1. 正确性：与代码/配置一致；不写“猜测性承诺”
2. 可操作性：每一步都能照做（命令/路径/输入输出清晰）
3. 最小惊讶：默认行为符合直觉；不隐藏破坏性行为
4. 可维护：模板化结构 + 单一真相来源（例如版本号只在 config.yaml）
## 最小文档结构（推荐）
- What：它是什么，解决什么问题
- Quickstart：最短路径跑通
- Usage：常用用法与参数
- Outputs：输出文件/目录约定
- Troubleshooting：常见错误与定位
- Contributing（可选）：开发/测试/发布
## 约束
<!-- BEGIN COMMON CONSTRAINTS -->
<!-- Source-Hash: sha256:15120201e9e0c7569517261d57ecefb63ac279c26ed13876f8e95b6dc35854d3 -->
<!-- Template-ID: skill-common-constraints; Template-Version: 1; Sync-Policy: exact-block -->
### 公共硬约束
本块由 `docs/templates/skill-common-constraints.md` 统一维护；每个 `SKILL.md` 的 `## 约束` 必须逐字同步本块，不得在副本中改写公共规则。
- 任务需要落盘时，使用唯一的 `./.bensz-api/task-{yyyymmdd-hhmm}-{简短描述}/` 根目录；共享材料放入 `shared/`，Skill 专属材料放入该 Skill 的 `input/`、`output/`、`log/`。
- 正式交付物、源代码和正式计划按项目约定保存，不写入任务工作区；未经授权不覆盖、删除、迁移或远程写入。
- 项目维护变更检查 BAC 可用性并记录需求、AI 产出、工具结果、文件改动和验证摘要；BAC 只做过程审计，不替代署名、责任或合规判断。
…Read the whole file at its exact version.
How to install
mdr add huangwb8/skills/documentation-specialist@sha256:2c12a002e68d7615The line at the top of this page pins the label git:20260905.a346b91, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.
[](https://markdownregistry.com/a/art_bzts3lcfqnc5hx52)
4 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 3 versions of this file, between Aug 25, 2026 and Sep 5, 2026, about one every 5 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20260905.a346b91 latest | 2026-09-05 | a346b91 | 3,629 B | A | view · diff |
| git:20260905.7c0ea7c | 2026-09-05 | 7c0ea7c | 3,590 B | A | view · diff |
| git:20260825.4f192d9 | 2026-08-25 | 4f192d9 | 2,959 B | A | view |
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (3629 bytes)
- pass: No zero-width or bidi control characters
- pass: No instruction hidden inside an HTML comment
- pass: No link to an exfiltration or paste host
- pass: No credential-shaped string
- pass: No instruction to send local credentials anywhere
- pass: No text hidden with inline styles
- pass: No prompt-injection phrasing
- pass: No curl or wget piped into a shell
- pass: No recursive delete of root, home or parent
- pass: No instruction to read or print local credentials
- pass: No base64 blob over 200 characters
- pass: No link to a raw IP address
- pass: No script tag
Source
huangwb8/skills · 50 stars · license MIT · pushed 2026-10-17 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_bzts3lcfqnc5hx52 GET https://markdownregistry.com/api/v1/resolve?ref=huangwb8/skills/documentation-specialist GET https://markdownregistry.com/api/v1/blob/2c12a002e68d7615fbaf5a1d0ff068e09b0f25a128998244658c717a66bddc17
Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.
Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.