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.
README 写作规范 — 为 README / 用户使用文档收口用户视角、章节顺序、示例策略与 consumer map
$ npx skills add devcodex-labs/devcodex --skill readme-authoring -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install devcodex-labs/devcodex readme-authoring --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ 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-srcUse ~/.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/
Install the "readme-authoring" agent skill from https://github.com/devcodex-labs/devcodex/tree/main/content/skills/readme-authoring into .claude/skills/readme-authoring/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-authoring", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/devcodex-labs/devcodex/tree/main/content/skills/readme-authoringType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add devcodex-labs/devcodex --skill readme-authoring -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install devcodex-labs/devcodex readme-authoring --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/devcodex-labs/devcodex.git skills-src && mkdir -p .agents/skills && cp -r skills-src/content/skills/readme-authoring .agents/skills/readme-authoring && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "readme-authoring" agent skill from https://github.com/devcodex-labs/devcodex/tree/main/content/skills/readme-authoring into .agents/skills/readme-authoring/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-authoring", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add devcodex-labs/devcodex --skill readme-authoring -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install devcodex-labs/devcodex readme-authoring --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/devcodex-labs/devcodex.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/content/skills/readme-authoring .cursor/skills/readme-authoring && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "readme-authoring" agent skill from https://github.com/devcodex-labs/devcodex/tree/main/content/skills/readme-authoring into .cursor/skills/readme-authoring/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-authoring", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/devcodex-labs/devcodex.git --path content/skills/readme-authoring--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add devcodex-labs/devcodex --skill readme-authoring -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install devcodex-labs/devcodex readme-authoring --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/devcodex-labs/devcodex.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/content/skills/readme-authoring .gemini/skills/readme-authoring && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "readme-authoring" agent skill from https://github.com/devcodex-labs/devcodex/tree/main/content/skills/readme-authoring into .gemini/skills/readme-authoring/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-authoring", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install devcodex-labs/devcodex readme-authoringInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add devcodex-labs/devcodex --skill readme-authoring -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/devcodex-labs/devcodex.git skills-src && mkdir -p .github/skills && cp -r skills-src/content/skills/readme-authoring .github/skills/readme-authoring && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "readme-authoring" agent skill from https://github.com/devcodex-labs/devcodex/tree/main/content/skills/readme-authoring into .github/skills/readme-authoring/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-authoring", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add devcodex-labs/devcodex --skill readme-authoring -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install devcodex-labs/devcodex readme-authoring --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/devcodex-labs/devcodex.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/content/skills/readme-authoring .opencode/skills/readme-authoring && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "readme-authoring" agent skill from https://github.com/devcodex-labs/devcodex/tree/main/content/skills/readme-authoring into .opencode/skills/readme-authoring/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-authoring", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
readme-authoringREADME 写作规范 — 为 README / 用户使用文档收口用户视角、章节顺序、示例策略与 consumer map
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.
8 steps, taken from the first numbered list in SKILL.md.
Read from SKILL.md and the folder at commit 1dd4525. It shows what the files ask for, not the result of running them.
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.
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.
No URLs in SKILL.md.
From URLs in SKILL.md, links to its own repository left out.
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.
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.
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.
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.
The full file from devcodex-labs/devcodex at commit 1dd4525, republished under its AGPL-3.0 licence (© devcodex-labs). 311 words, ~1,104 tokens.
.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.当任务目标是 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 | 后置 | 开发、贡献、维护内容不得抢占主叙事 |
| 字段 | 必填 | 说明 |
|---|---|---|
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 的关联事实 |
推荐主顺序:
docs-first 最终用户手册的顺序必须服务目标版本最终可执行路径;未实现、preview 或内部开发状态只能放在发布状态、限制说明或维护者区域,不能成为首屏、quick start 或 reference 主叙事。
禁止把以下内容前置为主叙事:
| 项目类型 | 用户最关心的信息 | 写作重点 |
|---|---|---|
library | 怎么安装、怎么 import、最小示例 | 依赖、最短调用、返回值示例 |
service | 怎么启动、端口/依赖、调用入口 | 启动命令、环境要求、运行方式 |
application | 怎么进入界面、登录/前置条件、核心操作 | 快速体验路径、主要页面或操作 |
tool | 怎么执行命令、输入输出、常见任务 | CLI/脚本入口、常见命令、输出示例 |
projectType。primaryAudience 是否为外部用户、内部使用者或协作方。UserDocsPrimarySurfaceGate:冻结 targetSurface、documentLocation、首页/quick start/nav 主面和开发/维护内容后置策略。UserDocsImmediateComprehensionGate:写出功能覆盖、配置易懂、首次读者即时理解的三轴检查。UserFacingDeliveryChainGate 与 FinalUserManualFirstGate,确认 README / 文档站内容来自已确认需求或产品需求,而不是未确认的整理草稿。DocsSiteInformationArchitectureGate;最终用户手册执行 UserManualFlowAndFailureGate;队列/任务/异步/批处理类 quick start 执行 QueueDocsRealWorkflowGate。userJourney 组织章节,不要从开发命令开始。consumerMap,核对 README 与 package.json、CLI、website、examples、changelog、Profile 是否一致;公开能力页追加 UserPathContractSweep。audit-readme。user-manual-authoring:站点文档、最终用户手册、接入手册和公开能力页的优先入口;README 是其专项分支。dev-docs:判断当前文档是否需要进入 user-manual-authoring 或 README 专项分支。dev-init:初始化项目时默认用本 Skill 生成 README。document-sync:代码/规范变更后检查 README 当前消费者与 consumerMap。audit-readme:实施完成后对 README / 用户使用文档做专项 review。© 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
SKILL.md and 1 other file in content/skills/readme-authoring of devcodex-labs/devcodex.
Open the folder on GitHubat commit 1dd4525
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.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| Readme Authoring this skilldevcodex-labs/devcodex | 439 | — | ~1.1k | Automated safety check: Pass | AGPL-3.0 | |
| Diagram Designcathrynlavery/diagram-design | 45k | 1 repos | ~7.5k | Automated safety check: Pass | MIT | |
| Simple Englishmoeru-ai/airi | 50k | 2 repos | ~4.6k | Automated safety check: Pass | MIT | |
| Get API Docs with chubandrewyng/context-hub | 14k | 2 repos | ~775 | Automated safety check: Pass | MIT | |
| Doc SyncJetBrains/ideavim | 10k | 2 repos | ~2.6k | Automated safety check: Pass | MIT | |
| Mailspring App ScreenshotsFoundry376/Mailspring | 18k | — | ~1.5k | Automated safety check: Pass | GPL-3.0 |
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.
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.
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.
JetBrains/ideavim
Keeps IdeaVim documentation in sync with code changes. An agent skill from JetBrains/ideavim.
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.
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.
devcodex-labs/devcodex
无障碍与国际化专家 Owner — 当任务涉及可访问性、键盘操作、焦点、屏幕阅读器、ARIA、语言地区、本地化、RTL、翻译资源、用户可见文案或多语言文档时使用;要求把包容性体验和本地化验证绑定到真实用户路径。
devcodex-labs/devcodex
AI Agent 系统架构专家 Owner — 当任务涉及 Agent 路由、工具调用、上下文管理、记忆、状态机、权限、人机协作、可观测性、回放验证或模型辅助治理时使用;要求把 Agent 行为设计成可解释、可恢复、可审计。
devcodex-labs/devcodex
API 契约架构专家 Owner — 当任务涉及 public API、HTTP/SDK/CLI 契约、版本兼容、错误模型、分页过滤、幂等、Schema、类型、迁移或消费者影响时使用;要求先冻结消费者契约,再设计实现与验证。
devcodex-labs/devcodex
架构设计文档编排 Owner — 当用户要求架构设计、系统设计、技术架构或可指导开发、Review 与任务拆分的完整方案时使用;要求从业务流程反推节点、状态、数据、一致性、异常补偿、ADR 与实施任务。
devcodex-labs/devcodex
审查公共维度 G0~G5 + Profile Freshness Check — 所有 audit 子类型必先执行的基础维度层
devcodex-labs/devcodex
审计工作流的跨会话状态机 — 在 <audit-root/.audit-state/<session-id.json 持久化轮次/发现项/收敛状态,支持 Token 中断后精准恢复
Categories
README 写作规范 — 为 README / 用户使用文档收口用户视角、章节顺序、示例策略与 consumer map. Readme Authoring is an agent skill from devcodex-labs/devcodex.
Readme Authoring fits situations like: tasks that involve Technical documentation.
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.
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.
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.
SKILL.md names no scripts, command-line tools or credentials: Readme Authoring is instructions for the agent only.
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.
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.
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.
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.
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.
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.