user-manual-authoring SKILL.md skillA
user-manual-authoring from devcodex-labs/devcodex is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add devcodex-labs/devcodex/user-manual-authoring@git:20260908.6caf1bfPins git:20260908.6caf1bf in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- devcodex-labs/devcodex
- Path
content/skills/user-manual-authoring/SKILL.md- Versions recorded
- 2
- Latest version
- git:20260908.6caf1bf, committed Sep 8, 2026
- First version recorded
- Jul 30, 2026
- Size
- 12,573 bytes
- Repository stars
- 432
- License
- AGPL-3.0
开源/公开用户站点与最终用户手册写作 Owner — guide/README/reference/migration/changelog/operations；与维护者开发站不等价；经 DocsAudienceIntent 路由。.
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
# User Manual Authoring Skill ## 职责 当任务目标是**开源/公开用户使用**站点文档、最终用户手册、README、quick start、接入手册、API/CLI **reference（用户侧契约面）** 或公开能力页时，本 Skill 是优先写作入口。 主受众必须是**使用者**（含「使用库的开发者」），**不是**本仓库维护者。成功标准：理解 → 安装/接入 → **第一次成功** → 任务 → 配置 → 失败恢复。 技术方案、接口契约深页、实现计划和维护者 checklist 只能后置或拆任务；维护者开发站走 `maintainer-docs-site-authoring`。 ## 触发条件 | 场景 | 是否触发 | |------|:--------:| | `docsAudience=public-user`（DocsAudienceIntentGate） | 必须 | | 用户要求“用户使用文档 / 使用手册 / 最终用户文档 / 开源用户站” | 必须 | | 用户要求 README、quick start、接入手册、官网使用说明或公开能力页 | 必须 | | docs-first、先写文档再开发、后续按文档实现 | 必须 | | API/CLI/Config **reference**（使用者查表） | 必须（可编排 `dev-docs` light-api） | | 维护者开发站 / contributing / 发版 runbook / ADR 主叙事 | N/A → `maintainer-docs-site-authoring` | | 仅「写文档站/website」且 ambiguous | N/A → **阻断消歧**，禁止开写 | | 纯架构说明且受众为维护者 | N/A → `dev-docs` / `maintainer-docs-site-authoring` | ## 输入顺序 用户最终文档不得直接从未确认草稿生成最终承诺。推荐顺序： 1. 原始需求或材料保留为输入锚点。 2. `00-需求概况.md` 只作为整理草稿，不替代确认事实源。 3. 以 `01-需求确认.md` 或产品直接提供的 `01-产品需求.md` 作为文档事实源。 4. 判断 `documentationSurface=docs-site | README-minimum | N/A`。 5. 先产出最终用户使用文档。 6. 涉及前端、API 或外部调用方时，再生成契约文档。 7. 技术方案、实施方案、实施计划和 ECR 必须对照用户文档。 ## 文档契约 | 字段 | 要求 | |------|------| …
Read the whole file at its exact version.
How to install
mdr add devcodex-labs/devcodex/user-manual-authoring@sha256:309746d9e880a734The line at the top of this page pins the label git:20260908.6caf1bf, 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_pesvtod4lgsapwzu)
5 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 2 versions of this file, between Jul 30, 2026 and Sep 8, 2026, about one every 40 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20260908.6caf1bf latest | 2026-09-08 | 6caf1bf | 12,573 B | A | view · diff |
| git:20260730.6ee304a | 2026-07-30 | 6ee304a | 12,146 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 (12573 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
devcodex-labs/devcodex · 432 stars · license AGPL-3.0 · pushed 2026-10-27 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_pesvtod4lgsapwzu GET https://markdownregistry.com/api/v1/resolve?ref=devcodex-labs/devcodex/user-manual-authoring GET https://markdownregistry.com/api/v1/blob/309746d9e880a7342116ab00dfedb3ee16e954cca3ce9048f73e3abc2ca00a13
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.