Beads Documentation Style Guide
gastownhall/beads
Sets the house style for the beads user docs: the canonical concept model, required terminology, prose and diagram conventions, and checks before docs work is done.
用户侧文档专项审查聚合入口 — 用于审查最终用户文档、站点文档、文档站、README、quick start、接入手册、项目文档、菜单导航、sidebar、信息架构、文档设计、用户路径、配置排错、真实工作流、生成站点和维护者内容边界;当用户要求 review/审查/复审/检查用户侧文档或项目文档可用性时使用。
$ npx skills add devcodex-labs/devcodex --skill audit-user-manual -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install devcodex-labs/devcodex audit-user-manual --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/audit-user-manual .claude/skills/audit-user-manual && 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 "audit-user-manual" agent skill from https://github.com/devcodex-labs/devcodex/tree/main/content/skills/audit-user-manual into .claude/skills/audit-user-manual/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "audit-user-manual", 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/audit-user-manualType 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 audit-user-manual -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install devcodex-labs/devcodex audit-user-manual --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/audit-user-manual .agents/skills/audit-user-manual && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "audit-user-manual" agent skill from https://github.com/devcodex-labs/devcodex/tree/main/content/skills/audit-user-manual into .agents/skills/audit-user-manual/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "audit-user-manual", 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 audit-user-manual -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install devcodex-labs/devcodex audit-user-manual --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/audit-user-manual .cursor/skills/audit-user-manual && 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 "audit-user-manual" agent skill from https://github.com/devcodex-labs/devcodex/tree/main/content/skills/audit-user-manual into .cursor/skills/audit-user-manual/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "audit-user-manual", 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/audit-user-manual--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 audit-user-manual -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install devcodex-labs/devcodex audit-user-manual --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/audit-user-manual .gemini/skills/audit-user-manual && 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 "audit-user-manual" agent skill from https://github.com/devcodex-labs/devcodex/tree/main/content/skills/audit-user-manual into .gemini/skills/audit-user-manual/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "audit-user-manual", 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 audit-user-manualInstalls 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 audit-user-manual -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/audit-user-manual .github/skills/audit-user-manual && 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 "audit-user-manual" agent skill from https://github.com/devcodex-labs/devcodex/tree/main/content/skills/audit-user-manual into .github/skills/audit-user-manual/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "audit-user-manual", 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 audit-user-manual -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 audit-user-manual --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/audit-user-manual .opencode/skills/audit-user-manual && 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 "audit-user-manual" agent skill from https://github.com/devcodex-labs/devcodex/tree/main/content/skills/audit-user-manual into .opencode/skills/audit-user-manual/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "audit-user-manual", 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.
audit-user-manual用户侧文档专项审查聚合入口 — 用于审查最终用户文档、站点文档、文档站、README、quick start、接入手册、项目文档、菜单导航、sidebar、信息架构、文档设计、用户路径、配置排错、真实工作流、生成站点和维护者内容边界;当用户要求 review/审查/复审/检查用户侧文档或项目文档可用性时使用。
Audit User Manual is an agent skill from devcodex-labs/devcodex. 用户侧文档专项审查聚合入口 — 用于审查最终用户文档、站点文档、文档站、README、quick start、接入手册、项目文档、菜单导航、sidebar、信息架构、文档设计、用户路径、配置排错、真实工作流、生成站点和维护者内容边界;当用户要求 review/审查/复审/检查用户侧文档或项目文档可用性时使用。
Its SKILL.md is about 1.2k 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 Writing & Content, covering Technical writing and 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.
6 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.
Audit User Manual loads about 1.2k tokens when it runs. Until then it costs about 43 tokens; SKILL.md has 259 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). 259 words, ~1,177 tokens.
.claude/skills/audit-user-manual/SKILL.md (or your agent's skills folder). This skill also uses 1 other file; get the full folder from GitHub.本 Skill 是用户侧文档 review 的薄封装入口。它不重新定义已有 Gate 正文,而是把 user-manual-authoring、expert-output-quality、audit-document、audit-readme、review-checklist、document-sync 和 test-router 的文档审查能力按固定顺序聚合,降低“项目文档 / 文档设计 / 菜单导航”审查时的触发心智。
| 场景 | 是否触发 |
|---|---|
| 用户要求审查、review、复审、检查最终用户文档、站点文档、文档站、README、quick start、接入手册 | 必须 |
| 用户特别提到项目文档、文档设计、信息架构、菜单、导航、sidebar、目录、页面角色、用户路径 | 必须 |
| docs-first 交付后要求确认用户文档是否能看懂、能否第一次成功、是否够详细 | 必须 |
| 纯内部技术方案、架构设计、代码审查、发布报告 | N/A,走对应 audit Skill |
user-manual-authoring,确认目标文档契约、受众、文档落点和用户主路径。expert-output-quality,执行专家型产物质量门禁。audit-document,执行通用文档结构、准确性、链接、术语、受众和关联一致性审查。audit-readme 的 RM-1~RM-6。review-checklist。test-router 与 document-sync 选择验证路线。| 维度 | 必查证据 |
|---|---|
| 文档定位 | targetSurface、documentLocation、primaryAudience、发布/preview 边界 |
| 用户路径 | 这是什么、适合谁、第一次成功、常见任务、配置、失败恢复、限制和下一步 |
| 文档设计 | 首页首屏、章节顺序、信息层级、reference / operations / maintainer 分区 |
| 菜单导航 | SidebarPageRoleMaterializationProbe / SidebarGroupSemanticModelProbe、pageRoleMatrix、sidebarSemanticModel、route / label 真相源、相邻页面职责、前两组导航是否服务用户主路径 |
| 受众与渲染顺序 | DocsAudienceRoleAndRenderedSequenceProbe:pageRole 分布、首屏前三信息块、前两组 sidebar、current quick start 距离、manual TOC 与 generated outline 重复数 |
| 内容可懂 | 功能完整性、配置易懂性、术语首次解释、字段/参数/状态/错误解释、示例真实度 |
| 认知高度 / 任务语言 | 模型审查 guide/readme 能否帮助目标读者完成任务;以当前正文摘要绑定的内容审查与实际使用证据为准,函数或短语数量不决定通过 |
| 专家型产物质量 | ExpertOutputQualityGate、ProductionRecommendedPathGate、FrameworkNativeCapabilityFirstGate、FixtureBoundaryDisclosureGate、AntiPatternContrastGate、ExpertEvidenceMatrixGate,区分生产推荐路径、fixture/mock/demo 边界和反模式 |
| 真实工作流 | quick start、队列/异步/批处理、导入导出、失败重试、幂等和观测是否是业务主路径;完整声明必须有 ScenarioCoverageMatrixProbe,持久化批处理追加 DurableBatchOrchestrationProbe |
| 生成与运行态 | GeneratedSiteGate;命中文档站主题、搜索、代码高亮、移动端、暗色/亮色或交互变化时执行 DocsThemeRuntimeVisualProbeGate |
| 交互语义 | 命中链接、按钮、菜单、对话框、可展开控件或自定义交互时执行 InteractiveSemanticProbe:role、accessible name、focusability、Enter/Space/Escape、focus recovery;截图不能替代 |
| 维护者边界 | release checklist、内部同步清单、台账状态、实现验收是否后置或移出公开用户主路径 |
| 消费者同步 | README、website、Profile、examples、templates、nav/sidebar、validate probes、部署副本和代码消费点 |
UserManualReviewScope:targetSurface、primaryAudience、sourceOfTruth、publishedBoundary、reviewMode=light|full。DocsNavigationReviewMatrix:每页 role、audience、route、label、sidebar group、sourceOfTruth、是否用户主路径、相邻页面职责。ExpertOutputQualityGate;无此类内容时写 N/A + skipReason。audit-document + 条件 audit-readme 做问题分级;同一问题只记录一次,不重复贴多个维度名。InteractiveSemanticProbe,不得用截图证明键盘/辅助技术语义;未触发写 N/A + skipReason。DocsAudienceRoleAndRenderedSequenceProbe:从源码路由/导航生成 pageRole matrix,并从 fresh generated HTML 或 Browser/Playwright 读取渲染后的首屏、outline 与 CTA 顺序;仅证明 route/label/构建存在不得判用户主面通过。通过条件同时满足:所有公开页面有 current-user / target-user / reference / planning / maintainer 角色;首页首屏前三信息块和 sidebar 前两组优先服务 current-user;current quick start 在约定导航距离内;正文手写 TOC 与 generated outline 无重复;证据来自 fresh 生成产物或运行态页面。任一项未观测只能标 unverified,不能用 Markdown 章节存在推断通过。
user-manual-authoring:写作入口和文档契约事实源;本 Skill 负责审查聚合。expert-output-quality:代码、文档、示例、fixture 和报告解读的专家型质量门禁,防止测试夹具或低阶写法误导用户主路径。audit-document:通用文档审查维度,必须叠加。audit-readme:README 或主入口文档时叠加。review-checklist:正式复审、收敛、多轮或 finding 批次时管理清单。document-sync:检查 README / website / Profile / examples / templates / nav/sidebar / validate / 部署副本同步。test-router:决定生成站点、链接、Browser/截图、人工复核或 N/A 路线。user-manual-authoring / audit-document / audit-readme 的完整长清单;本 Skill 只做聚合入口和输出矩阵。© 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/audit-user-manual of devcodex-labs/devcodex.
Open the folder on GitHubat commit 1dd4525
Audit User Manual 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 |
|---|---|---|---|---|---|---|
| Audit User Manual this skilldevcodex-labs/devcodex | 439 | — | ~1.2k | Automated safety check: Pass | AGPL-3.0 | |
| Beads Documentation Style Guidegastownhall/beads | 28k | — | ~3.2k | Automated safety check: Pass | MIT | |
| Technical Writing Standardcursor/plugins | 10k | 10 repos | ~2.4k | Automated safety check: Pass | None | |
| Heym Documentation Articlesheymrun/heym | 1.4k | — | ~780 | Automated safety check: Pass | Custom licence | |
| Developer Docs Technical Writervercel-labs/github-tools | 131 | — | ~3.9k | Automated safety check: Pass | MIT | |
| Aholo Viewer Docsmanycoretech/aholo-viewer | 1.1k | — | ~341 | Automated safety check: Pass | MIT |
gastownhall/beads
Sets the house style for the beads user docs: the canonical concept model, required terminology, prose and diagram conventions, and checks before docs work is done.
cursor/plugins
Applies four layers of technical-writing rules to docs, RFCs, readmes, PR descriptions and commit messages so a tired engineer follows them on the first read.
heymrun/heym
Creates and updates documentation articles for the Heym platform: category choice, manifest entry, markdown file and cross-links from existing pages.
vercel-labs/github-tools
Writes, reviews and edits developer documentation for SDKs, libraries and frameworks, from getting-started guides and API references to migration guides.
manycoretech/aholo-viewer
Guides writing and maintaining Aholo Viewer documentation: README, AGENTS.md, architecture notes, bilingual manual pages and AI collaboration guides.
WebMCP-org/npm-packages
Write technical documentation following the Diataxis framework by Daniele Procida.
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、quick start、接入手册、项目文档、菜单导航、sidebar、信息架构、文档设计、用户路径、配置排错、真实工作流、生成站点和维护者内容边界;当用户要求 review/审查/复审/检查用户侧文档或项目文档可用性时使用。. Audit User Manual is an agent skill from devcodex-labs/devcodex.
Audit User Manual fits situations like: tasks that involve Technical writing; tasks that involve Technical documentation.
Run `npx skills add devcodex-labs/devcodex --skill audit-user-manual -a claude-code`. Or copy the skill folder (content/skills/audit-user-manual in devcodex-labs/devcodex) into .claude/skills/audit-user-manual in your project. Claude Code loads it when a task matches its description.
Run `npx skills add devcodex-labs/devcodex --skill audit-user-manual -a codex`. Or copy the skill folder (content/skills/audit-user-manual in devcodex-labs/devcodex) into .agents/skills/audit-user-manual 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 audit-user-manual -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/audit-user-manual, .gemini/skills/audit-user-manual, .github/skills/audit-user-manual and .opencode/skills/audit-user-manual in your project.
SKILL.md names no scripts, command-line tools or credentials: Audit User Manual 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.
Audit User Manual 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.2k tokens (SKILL.md is roughly 4.7k 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 Audit User Manual: Beads Documentation Style Guide (gastownhall/beads, 28k stars), Technical Writing Standard (cursor/plugins, 10k stars), Heym Documentation Articles (heymrun/heym, 1.4k stars) and Developer Docs Technical Writer (vercel-labs/github-tools, 131 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.