Agent skill

Readme Authoring

by devcodex-labs in devcodex-labs/devcodex

README 写作规范 — 为 README / 用户使用文档收口用户视角、章节顺序、示例策略与 consumer map

AGPL-3.0Auto-check passedDevelopment

Install Readme Authoring

skills CLI
$ npx skills add devcodex-labs/devcodex --skill readme-authoring -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install devcodex-labs/devcodex readme-authoring --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/devcodex-labs/devcodex.git skills-src && mkdir -p .claude/skills && cp -r skills-src/content/skills/readme-authoring .claude/skills/readme-authoring && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
readme-authoring
GitHub stars
439
Token cost
~1.1k tokens
SKILL.md length
311 words
Files
2
Skills in repo
70
Repo updated
First seen
Licence
AGPL-3.0

At a glance

README 写作规范 — 为 README / 用户使用文档收口用户视角、章节顺序、示例策略与 consumer map

  • Works in 8 steps: 这是什么 → 适合谁、何时使用 → 如何快速开始 → …
  • Tasks that involve Technical documentation
  • SKILL.md covers 职责, 触发条件, 默认受众模型 and README 写作契约, plus 6 more sections
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Readme Authoring is an agent skill from devcodex-labs/devcodex. README 写作规范 — 为 README / 用户使用文档收口用户视角、章节顺序、示例策略与 consumer map

Its SKILL.md is about 1.1k tokens, which your agent loads only when the skill is triggered. The skill folder holds 1 other file (for example `intent.json`).

It sits in Development, covering Technical documentation. The repository describes itself as: Intent-driven AI coding workflow runtime for consistent context, skills, approvals, validation, and handoffs across six AI coding hosts. The licence is AGPL-3.0.

When your agent uses it

  • Tasks that involve Technical documentation

Example prompts

  • “/readme-authoring”

Workflow steps

8 steps, taken from the first numbered list in SKILL.md.

  1. 这是什么
  2. 适合谁、何时使用
  3. 如何快速开始
  4. 常见用法 / 最短可成功路径
  5. 配置 / 运行要求
  6. 常见问题与排错
  7. 进一步文档
  8. 开发 / 贡献 / 维护说明

What it can do on your machine

Read from SKILL.md and the folder at commit 1dd4525. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md.

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Readme Authoring loads about 1.1k tokens when it runs. Until then it costs about 20 tokens; SKILL.md has 311 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~20
When it runs · the whole SKILL.md, loaded when a task matches
~1.1k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from devcodex-labs/devcodex at commit 1dd4525, republished under its AGPL-3.0 licence (© devcodex-labs). 311 words, ~1,104 tokens.

Download SKILL.mdSave it as .claude/skills/readme-authoring/SKILL.md (or your agent's skills folder). This skill also uses 1 other file; get the full folder from GitHub.
name
readme-authoring
description
README 写作规范 — 为 README / 用户使用文档收口用户视角、章节顺序、示例策略与 consumer map

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✅理解 -> 安装/接入 -> 启动/运行 -> 使用 -> 配置 -> 排错
targetSurface✅public-docs-site / project-readme-docs / requirement-deliverable / maintainer-only,不得未确认就把需求交付文档挂入项目 README/docs
primarySurfaceCheck✅首页首屏、quick start、nav/sidebar 前两组、CTA、reference、配置、常见任务和排错是否服务用户使用路径
immediateComprehension✅功能完整性、配置易懂性、首次读者即时理解三轴结论
deliveryChain条件docs-first / 最终用户手册场景填写 UserFacingDeliveryChainGate:确认需求事实源、用户最终文档、条件契约文档、技术方案输入和 ECR 用户文档符合性
siteInformationArchitecture条件文档站填写 DocsSiteInformationArchitectureGate:用户手册、reference、operations、compatibility、implementation、maintainer 面各归其位
flowAndFailurePath条件最终用户手册填写 UserManualFlowAndFailureGate:整体流程、关键角色、第一次成功、失败分流、排查命令、恢复/降级
realWorkflowExample条件队列 / 任务 / 异步 / 批处理类 quick start 填写 QueueDocsRealWorkflowGate,不能用单个硬编码 job 代替主路径
developerInfoPlacement✅必须晚于快速开始、常见用法、配置与排错
consumerMap✅README 与 package.json / CLI / website / examples / changelog / Profile 的关联事实

章节顺序规则

推荐主顺序:

  1. 这是什么
  2. 适合谁、何时使用
  3. 如何快速开始
  4. 常见用法 / 最短可成功路径
  5. 配置 / 运行要求
  6. 常见问题与排错
  7. 进一步文档
  8. 开发 / 贡献 / 维护说明

docs-first 最终用户手册的顺序必须服务目标版本最终可执行路径;未实现、preview 或内部开发状态只能放在发布状态、限制说明或维护者区域,不能成为首屏、quick start 或 reference 主叙事。

禁止把以下内容前置为主叙事:

  • 维护者内部流程
  • 贡献约定
  • 大段架构设计
  • 与使用者无关的目录说明

项目类型差异

项目类型用户最关心的信息写作重点
library怎么安装、怎么 import、最小示例依赖、最短调用、返回值示例
service怎么启动、端口/依赖、调用入口启动命令、环境要求、运行方式
application怎么进入界面、登录/前置条件、核心操作快速体验路径、主要页面或操作
tool怎么执行命令、输入输出、常见任务CLI/脚本入口、常见命令、输出示例

性能 / 语法 / 能力矩阵写法

  • README 面向使用者时,性能表、语法说明、能力矩阵或路由/匹配模式说明必须先给“如何选择”的结论,再解释字段和内部术语。
  • 语法、路由、匹配、配置能力类章节默认同时包含:支持的形式、明确不支持的形式、优先级或冲突示例。
  • 性能数据不得只给 benchmark 术语;应说明每一列对用户选择的含义,并标明测试条件或 N/A 理由。

执行步骤

  1. 判断 projectType。
  2. 确认真实 primaryAudience 是否为外部用户、内部使用者或协作方。
  3. 执行 UserDocsPrimarySurfaceGate:冻结 targetSurface、documentLocation、首页/quick start/nav 主面和开发/维护内容后置策略。
  4. 执行 UserDocsImmediateComprehensionGate:写出功能覆盖、配置易懂、首次读者即时理解的三轴检查。
  5. docs-first / 最终用户手册场景执行 UserFacingDeliveryChainGate 与 FinalUserManualFirstGate,确认 README / 文档站内容来自已确认需求或产品需求,而不是未确认的整理草稿。
  6. 文档站执行 DocsSiteInformationArchitectureGate;最终用户手册执行 UserManualFlowAndFailureGate;队列/任务/异步/批处理类 quick start 执行 QueueDocsRealWorkflowGate。
  7. 按 userJourney 组织章节,不要从开发命令开始。
  8. 只保留与当前项目类型相关的快速开始与示例块。
  9. 建立 consumerMap,核对 README 与 package.json、CLI、website、examples、changelog、Profile 是否一致;公开能力页追加 UserPathContractSweep。
  10. 交付后若任务要求 review,再调用 audit-readme。

与其他 Skill 的关系

  • user-manual-authoring:站点文档、最终用户手册、接入手册和公开能力页的优先入口;README 是其专项分支。
  • dev-docs:判断当前文档是否需要进入 user-manual-authoring 或 README 专项分支。
  • dev-init:初始化项目时默认用本 Skill 生成 README。
  • document-sync:代码/规范变更后检查 README 当前消费者与 consumerMap。
  • audit-readme:实施完成后对 README / 用户使用文档做专项 review。

禁止

  • 禁止把 README 默认写成“维护者操作手册”。
  • 禁止让开发/贡献章节出现在快速开始之前。
  • 禁止只写架构或目录而不给真实使用路径。
  • 禁止把“站点文档 / 用户使用文档”写成开发契约、目标 API、数据模型或实现验收主叙事;这些内容只能后置或标为 developer/maintainer-only。
  • 禁止把 docs-first 最终用户手册写成当前 preview / 当前不可用说明,也禁止把最终用户手册当成整站全部内容容器。
  • 禁止队列、任务、异步处理、推送、导入导出或批处理类 quick start 只写单个硬编码 job;单 job 只能作为 API micro example,不能替代真实批量工作流。
  • 禁止用内部分类名、benchmark 术语或 provider/adapter 实现名抢占用户主叙事;应先写用户场景与选择建议,再引出 API / 模式名称。

© devcodex-labs, AGPL-3.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 1 other file in content/skills/readme-authoring of devcodex-labs/devcodex.

  • SKILL.md
  • intent.json

Open the folder on GitHubat commit 1dd4525

Compare with similar skills

Readme Authoring next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Readme Authoring compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Readme Authoring this skilldevcodex-labs/devcodex439—~1.1kAutomated safety check: PassAGPL-3.0
Diagram Designcathrynlavery/diagram-design45k1 repos~7.5kAutomated safety check: PassMIT
Simple Englishmoeru-ai/airi50k2 repos~4.6kAutomated safety check: PassMIT
Get API Docs with chubandrewyng/context-hub14k2 repos~775Automated safety check: PassMIT
Doc SyncJetBrains/ideavim10k2 repos~2.6kAutomated safety check: PassMIT
Mailspring App ScreenshotsFoundry376/Mailspring18k—~1.5kAutomated safety check: PassGPL-3.0

Similar skills

  • Diagram Design

    cathrynlavery/diagram-design

    Creates branded diagrams, from architecture, flowchart and sequence to charts and maps, as self-contained HTML with inline SVG, with import from draw.io, Mermaid and Excalidraw.

    45k GitHub starsUsed in 1 repo~7.5k tokens
    DevelopmentAuto-check passed
  • Simple English

    moeru-ai/airi

    Write or rewrite technical text with the rules of ASD-STE100 Simplified Technical English so it is clear, unambiguous, and free of AI slop.

    50k GitHub starsUsed in 2 repos~4.6k tokens
    DevelopmentAuto-check passed
  • Get API Docs with chub

    andrewyng/context-hub

    Fetches current documentation for third-party APIs and SDKs with the chub CLI before the agent writes code against them, instead of relying on remembered API shapes.

    14k GitHub starsUsed in 2 repos~775 tokens
    DevelopmentAuto-check passed
  • Doc Sync

    JetBrains/ideavim

    Official

    Keeps IdeaVim documentation in sync with code changes. An agent skill from JetBrains/ideavim.

    10k GitHub starsUsed in 2 repos~2.6k tokens
    DevelopmentAuto-check passed
  • Mailspring App Screenshots

    Foundry376/Mailspring

    Captures screenshots of the running Mailspring dev app for docs, PRs or visual checks by launching it with a debugging port, driving the UI and clipping to an element.

    18k GitHub stars~1.5k tokensUpdated today
    DevelopmentAuto-check passed
  • Draw.io Diagram Studio

    Agents365-ai/drawio-skill

    Creates and edits editable draw.io diagrams from descriptions, code, infrastructure files, SQL and API schemas, with sync, review, test and export tools.

    10k GitHub stars~2.4k tokensUpdated 5 days ago
    DevelopmentAuto-check: notes

More from devcodex-labs/devcodex

All 70 skills in this repo
  • Accessibility I18n

    devcodex-labs/devcodex

    无障碍与国际化专家 Owner — 当任务涉及可访问性、键盘操作、焦点、屏幕阅读器、ARIA、语言地区、本地化、RTL、翻译资源、用户可见文案或多语言文档时使用;要求把包容性体验和本地化验证绑定到真实用户路径。

    439 GitHub stars~718 tokensUpdated 21 days ago
    Auto-check passed
  • AI Agent System Architecture

    devcodex-labs/devcodex

    AI Agent 系统架构专家 Owner — 当任务涉及 Agent 路由、工具调用、上下文管理、记忆、状态机、权限、人机协作、可观测性、回放验证或模型辅助治理时使用;要求把 Agent 行为设计成可解释、可恢复、可审计。

    439 GitHub stars~2.4k tokensUpdated 21 days ago
    Auto-check passed
  • API Contract Architecture

    devcodex-labs/devcodex

    API 契约架构专家 Owner — 当任务涉及 public API、HTTP/SDK/CLI 契约、版本兼容、错误模型、分页过滤、幂等、Schema、类型、迁移或消费者影响时使用;要求先冻结消费者契约,再设计实现与验证。

    439 GitHub stars~865 tokensUpdated 21 days ago
    Auto-check passed
  • Architecture Design

    devcodex-labs/devcodex

    架构设计文档编排 Owner — 当用户要求架构设计、系统设计、技术架构或可指导开发、Review 与任务拆分的完整方案时使用;要求从业务流程反推节点、状态、数据、一致性、异常补偿、ADR 与实施任务。

    439 GitHub stars~1.1k tokensUpdated 21 days ago
    Auto-check passed
  • Audit Common

    devcodex-labs/devcodex

    审查公共维度 G0~G5 + Profile Freshness Check — 所有 audit 子类型必先执行的基础维度层

    439 GitHub stars~4.1k tokensUpdated 21 days ago
    Auto-check passed
  • Audit Session

    devcodex-labs/devcodex

    审计工作流的跨会话状态机 — 在 <audit-root/.audit-state/<session-id.json 持久化轮次/发现项/收敛状态,支持 Token 中断后精准恢复

    439 GitHub stars~1.8k tokensUpdated 21 days ago
    Auto-check passed

Categories

Questions about Readme Authoring

What does Readme Authoring do?

README 写作规范 — 为 README / 用户使用文档收口用户视角、章节顺序、示例策略与 consumer map. Readme Authoring is an agent skill from devcodex-labs/devcodex.

When should I use Readme Authoring?

Readme Authoring fits situations like: tasks that involve Technical documentation.

How do I install Readme Authoring in Claude Code?

Run `npx skills add devcodex-labs/devcodex --skill readme-authoring -a claude-code`. Or copy the skill folder (content/skills/readme-authoring in devcodex-labs/devcodex) into .claude/skills/readme-authoring in your project. Claude Code loads it when a task matches its description.

How do I install Readme Authoring in Codex?

Run `npx skills add devcodex-labs/devcodex --skill readme-authoring -a codex`. Or copy the skill folder (content/skills/readme-authoring in devcodex-labs/devcodex) into .agents/skills/readme-authoring in your project. Codex loads it when a task matches its description.

Can I use Readme Authoring in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add devcodex-labs/devcodex --skill readme-authoring -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/readme-authoring, .gemini/skills/readme-authoring, .github/skills/readme-authoring and .opencode/skills/readme-authoring in your project.

What does Readme Authoring need to run?

SKILL.md names no scripts, command-line tools or credentials: Readme Authoring is instructions for the agent only.

Does Readme Authoring access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Readme Authoring safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Readme Authoring use?

Readme Authoring is published under the AGPL-3.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Readme Authoring use?

About 1.1k tokens (SKILL.md is roughly 4.4k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Readme Authoring?

Skills that share tags, products or a category with Readme Authoring: Diagram Design (cathrynlavery/diagram-design, 45k stars), Simple English (moeru-ai/airi, 50k stars), Get API Docs with chub (andrewyng/context-hub, 14k stars) and Doc Sync (JetBrains/ideavim, 10k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Readme Authoring?

devcodex-labs (a GitHub organization) maintains it in devcodex-labs/devcodex, which has 439 GitHub stars. The repository holds 70 skills in this directory. The repository was last updated on September 17, 2026.

Source: devcodex-labs/devcodex on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.