readme-authoring SKILL.md skillA
readme-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/readme-authoring@git:20260730.6ee304aPins git:20260730.6ee304a 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/readme-authoring/SKILL.md- Versions recorded
- 1
- Latest version
- git:20260730.6ee304a, committed Jul 30, 2026
- Size
- 7,834 bytes
- Repository stars
- 432
- License
- AGPL-3.0
README 写作规范 — 为 README / 用户使用文档收口用户视角、章节顺序、示例策略与 consumer map.
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
# Readme Authoring Skill ## 职责 当任务目标是 `README.md` 或项目主用户使用文档时，本 Skill 负责把“写什么、先写给谁看、哪些内容必须后置”收口为一套稳定规则。 它不新增 workflow 子类型，仍由 `dev-docs` / `dev-init` 触发。站点文档、最终用户手册、接入手册和公开能力页的主入口由 `user-manual-authoring` 承担；本 Skill 是其中的 README 专项分支。 ## 触发条件 | 场景 | 是否触发 | |------|:--------:| | 新建或改写 `README.md` | 🔴 必须 | | 初始化项目时生成 README | 🔴 必须 | | 面向真实使用者且落点为 README / 项目主文档 | 🔴 必须 | | 站点文档、最终用户手册、接入手册、公开能力页 | 先触发 `user-manual-authoring`，落点为 README 时再叠加本 Skill | | CONTRIBUTING / 架构文档 / 纯开发指南 | N/A | ## 默认受众模型 README 的默认第一受众必须是**用户 / 使用者**，而不是维护者。 这里的“用户 / 使用者”指真实依赖这份文档完成理解、安装、启动、接入、使用或排错的人；可以是外部用户，也可以是内部同事。 | 字段 | 默认值 | 说明 | |------|--------|------| | `primaryAudience` | `用户 / 使用者` | README 主叙事默认面向真实读者 | | `secondaryAudience` | `开发者 / 贡献者 / 维护者` | 仅作为后置补充受众 | | `developerInfoPlacement` | `后置` | 开发、贡献、维护内容不得抢占主叙事 | ## README 写作契约 | 字段 | 必填 | 说明 | |------|:----:|------| | `primaryAudience` | ✅ | 默认 `用户 / 使用者` | | `secondaryAudience` | 条件 | 可选 `开发者 / 贡献者 / 维护者` | | `projectType` | ✅ | `library` / `service` / `application` / `tool` | | `userJourney` | ✅ | `理解 -> 安装/接入 -> 启动/运行 -> 使用 -> 配置 -> 排错` | …
Read the whole file at its exact version.
How to install
mdr add devcodex-labs/devcodex/readme-authoring@sha256:a20dbfc6063ee800The line at the top of this page pins the label git:20260730.6ee304a, 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_os5rhxz2argl3ice)
4 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 1 version of this file, committed on Jul 30, 2026.
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 (7834 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_os5rhxz2argl3ice GET https://markdownregistry.com/api/v1/resolve?ref=devcodex-labs/devcodex/readme-authoring GET https://markdownregistry.com/api/v1/blob/a20dbfc6063ee800cff9be558632f4b587c63a87ed7d571c4a65625e0a75dd39
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.