Agent skill

User Manual Authoring

by devcodex-labs in devcodex-labs/devcodex

开源/公开用户站点与最终用户手册写作 Owner — guide/README/reference/migration/changelog/operations;与维护者开发站不等价;经 DocsAudienceIntent 路由。

AGPL-3.0Auto-check passedDevelopment

Install User Manual Authoring

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

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

GitHub CLI
$ gh skill install devcodex-labs/devcodex user-manual-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/user-manual-authoring .claude/skills/user-manual-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
user-manual-authoring
GitHub stars
439
Token cost
~1.9k tokens
SKILL.md length
454 words
Files
2
Skills in repo
70
Repo updated
First seen
Licence
AGPL-3.0

At a glance

开源/公开用户站点与最终用户手册写作 Owner — guide/README/reference/migration/changelog/operations;与维护者开发站不等价;经 DocsAudienceIntent 路由。

  • Works in 7 steps: 原始需求或材料保留为输入锚点。 → 00-需求概况.md 只作为整理草稿,不替代确认事实源。 → 以 01-需求确认.md 或产品直接提供的 01-产品需求.md 作为文档事实源。 → …
  • Tasks that involve Technical writing
  • SKILL.md covers 职责, 触发条件, 输入顺序 and 文档契约, plus 7 more sections
  • Calls npm

What it does

User Manual Authoring is an agent skill from devcodex-labs/devcodex. 开源/公开用户站点与最终用户手册写作 Owner — guide/README/reference/migration/changelog/operations;与维护者开发站不等价;经 DocsAudienceIntent 路由。

Its SKILL.md is about 1.9k 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 writing, Changelog and release notes 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.

When your agent uses it

  • Tasks that involve Technical writing
  • Tasks that involve Changelog and release notes
  • Tasks that involve Technical documentation

Example prompts

  • “/user-manual-authoring”

Workflow steps

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

  1. 原始需求或材料保留为输入锚点。
  2. 00-需求概况.md 只作为整理草稿,不替代确认事实源。
  3. 以 01-需求确认.md 或产品直接提供的 01-产品需求.md 作为文档事实源。
  4. 判断 documentationSurface=docs-site | README-minimum | N/A。
  5. 先产出最终用户使用文档。
  6. 涉及前端、API 或外部调用方时,再生成契约文档。
  7. 技术方案、实施方案、实施计划和 ECR 必须对照用户文档。

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

    Shell commands in SKILL.md call:

    • npm

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

  • Network

    No URLs in SKILL.md. Its commands use npm, which can reach the network depending on how they are called.

    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

User Manual Authoring loads about 1.9k tokens when it runs. Until then it costs about 35 tokens; SKILL.md has 454 words of instructions outside code blocks.

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

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). 454 words, ~1,873 tokens.

Download SKILL.mdSave it as .claude/skills/user-manual-authoring/SKILL.md (or your agent's skills folder). This skill also uses 1 other file; get the full folder from GitHub.
name
user-manual-authoring
description
开源/公开用户站点与最终用户手册写作 Owner — guide/README/reference/migration/changelog/operations;与维护者开发站不等价;经 DocsAudienceIntent 路由。

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」且 ambiguousN/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 必须对照用户文档。

文档契约

字段要求
primaryAudience必须是用户 / 使用者;内部开发者只能是次级受众
docsSurfaceguide | readme | reference | migration | changelog | operations(由 DocsAudienceIntent 锁定)
documentLocation写清是文档站、README、需求交付目录、官网页还是 maintainer-only
userJourney覆盖理解、安装/进入、第一次成功、常见任务、配置、失败处理和下一步
informationArchitecture文档站要区分用户手册、reference、operations、compatibility、implementation、maintainer
pageRoleMatrix多页文档站列出页面 role、受众、sourceOfTruth、nav/sidebar 位置和用户主路径状态
sidebarSemanticModel文档站列出每个 sidebar group 的用户任务模型、相邻页面职责、route/label 真相源和非归属说明
configurationModel配置字段、默认值、选择建议、错误与排错必须简单易懂
realWorkflowExample队列、任务、异步、导入导出、推送或批处理类文档必须给真实批量工作流
renderedFlowEvidenceMermaid / 流程图 / 文档站主题必须有真实渲染或运行态验证证据
semanticParityEvidence行为语义、默认值、兼容路径、支持/不支持承诺必须有 BehaviorSemanticDocsParityGate / NegativeTranslationParityProbe 证据
exampleTruthEvidenceoption/config/method/callback 示例必须有 DocsExampleTruthSurfaceGate / CallbackExampleScopeProbe 证据
expertOutputQualityEvidence示例、fixture、quick start 或接入手册必须有 expert-output-quality / ExpertOutputQualityGate 证据,区分生产推荐路径、框架原生能力、fixture/mock/demo 边界和反模式
developerInfoPlacement开发契约、技术方案、数据模型、维护者 checklist 后置或单独标记
consumerMap同步 README、website、Profile、examples、prompts、templates、validate 和部署副本

必执行门禁

共享 Gate 分组与 requiredEvidence 以 ../spec-governance/gate-registry.json 为准(user-manual / docs-ia-readability / docs-semantics-examples / docs-audience-render-sequence / scenario-durable-workflow / expert-output-quality)。下表是本 Owner 的差分清单(触发 → 要证什么),不维护跨 Skill 百科。

触发要证什么(摘要)
任意用户手册 / README / 站点文档冻结用户主受众与落点;主路径覆盖理解→第一次成功→任务→配置→失败恢复;公开面不混维护者 checklist
docs-first / 最终用户手册文档先于技术方案成为用户路径合同;写目标版本可执行路径,不是 preview 状态说明
文档站 / 多页 READMEpage role / sidebar 任务模型 / IA 分区;中文主表达;主题与生成站点运行态(不仅 Markdown)
队列 / 异步 / 批处理 quick start真实业务工作流;声称场景完整或持久化编排时追加 scenario / durable 证据(见 registry)
行为承诺 / 示例 / 回调语义与 public API/runtime 对齐;示例可追溯 type/schema/dispatcher;fixture 不得冒充生产推荐路径(expert-output-quality)
能力 / 导航 / 路径变更同步 README、website、Profile、examples、validate、部署副本与代码消费点

执行步骤

  1. 判定文档目标:docs-site、README-minimum、public page、requirement deliverable 或 N/A。
  2. 核对事实源:确认需求/产品需求、当前版本、发布状态和公开能力边界。
  3. 写出用户主路径:这是什么、适合谁、第一次成功、常见任务、配置、排错、限制、下一步。
  4. 拆分信息架构:用户手册与 API/CLI/config reference、operations、implementation、maintainer 分开。
  5. 建立 pageRoleMatrix 与 sidebarSemanticModel:确认每页 role、sidebar group、相邻页面职责、route 真相源和非归属说明。
  6. 对真实工作流补示例:避免只有单点 API 或单个硬编码 job。
  7. 对示例 / fixture / quick start 执行 expert-output-quality:冻结 roleBaseline、productionRecommendedPath、frameworkNativeCapability、fixtureBoundary、antiPatternContrast 与 evidenceMatrix。
  8. 建立 consumerMap,列出 README、website、Profile、examples、prompts、templates、validate、部署副本和代码消费点。
  9. 完成后按风险调用 audit-user-manual 做用户侧文档聚合 review;落点为 README / 主入口文档时再叠加 audit-readme,通用结构与准确性由 audit-document 承接。
Show full SKILL.md (187 more words)Show less

与其他 Skill 的关系

  • dev-docs:识别文档任务后,用户站/README/用户手册必须 handoff 本 Skill;reference 可编排 light-api;纯维护者技术文或架构走 dev-docs / maintainer-docs-site-authoring。
  • maintainer-docs-site-authoring:维护者开发站 Owner;受众正交。
  • readme-authoring:README 是本 Skill 的 README 专项分支,继续负责 README 章节顺序与用户旅程细化。
  • audit-user-manual:负责用户侧文档、项目文档、菜单导航和文档 IA 的聚合审查,不替代写作入口。
  • audit-readme / audit-document:负责 README 专项与通用文档维度,通常由 audit-user-manual 编排。
  • expert-output-quality:负责专家型产物质量,避免文档把 fixture/mock/demo 或低阶重复写法包装成生产推荐路径。
  • test-router:选择生成站点、链接、用户路径、Browser/截图或代码级替代验证。
  • document-sync:按 consumerMap(含 audience=public-user)检查当前消费者和部署副本。
  • DocsAudienceIntentGate:模型判定受众,scripts/lib/docs-audience-intent.js 校验结构化决策;npm run test:docs-audience 仅验证契约接线。

认知高度与任务语言(L3 · 强制)

受众对(public-user)不等于可读。guide/readme 不得做成「完整但全是底层函数」的符号说明书。

认知高度三层
高度含义guide/readme 主路径reference
Task用户要完成的事、场景、步骤、选择建议必须为主叙事可附「何时用」
Concept领域概念、配置含义(白话)服务 Task可简要
Symbol类型名、方法签名、内部模块后置或链到 reference允许密
写作硬规则
  1. 唯一推荐路径:quick start 只推广一条 productionRecommendedPath;底层装配标「高级/扩展」。
  2. 先任务后符号:目录与标题优先任务名(「发消息」),不是 MessageDispatcher。
  3. 用户任务为主线:模型审查快速开始能否帮助目标读者完成第一次实际使用;不能用函数调用数量或是否出现某个任务词代替可读性判断。
  4. 渐进披露:5 分钟会用 → 30 分钟会选 → 查表 reference;禁止一篇写穿全部 public 函数当使用文档。
  5. 术语:内部名首次出现必须白话;配置先默认与选择建议再字段表。
  6. reference:符号可密,每项至少「用途一句话 + 与推荐路径关系/何时不用」。
延展失败场景(写作与审查时主动对照)

用户只提一种「看不懂」时,仍应自检相邻风险(问题驱动场景延展):

组场景
A 叙事函数清单 guide、概念堆无任务、配置字典、错误码无恢复、多入口无推荐
B IAguide/reference 混主路径、源码侧栏、深链才到第一次成功、一篇写穿
C 示例不可跑、fixture 当生产、无失败路径、版本漂移
D 伪用户库文档按贡献者写、运维当研发、术语三套
E 假完整TBD、超版承诺、三口径
F 负担前置未声明、图文不符
G 元失败受众对高度错、好读但假、单页好整站乱
完成前漂移自检
  • 锁定 docsAudience=public-user 后,正文不得以 release checklist / monorepo 内部 / ADR 列表 / 内部台账为首屏主叙事。
  • 模型审查读者任务、叙事顺序与可读性,形成绑定正文摘要的 DocsContentReviewV1(kind、conclusion、rationale、evidenceRefs,受众漂移追加 audience);适配函数只投影该结论,没有审查时为 unverified。
  • classifyDocsAudienceDriftSample('public-user', body, review) 与 classifyUserDocsCognitiveAltitudeSample(body, { surface, review }) 必须使用相应 kind 的当前审查记录;修改正文后重新审查。
  • 无安装/第一次成功路径不得宣称用户站完成。
  • 验证:模型内容审查、实际用户路径;npm run test:docs-audience 仅证明协议正确,不能证明某份文档可用。

禁止

  • 禁止把用户要求的站点文档写成开发文档、技术方案、实现计划或维护报告。
  • 禁止让开发契约、目标 API、Redis/缓存模型、数据模型或验收 checklist 成为用户主入口。
  • 禁止把未确认的 00-需求概况.md 当成最终用户承诺。
  • 禁止把最终用户手册写成整站全部内容容器。
  • 禁止把当前不可用状态说明冒充目标版本最终用户手册。
  • 禁止把 fixture、mock、demo、硬编码单例或重复 route/middleware/resource 声明写成用户主路径的生产推荐实践;必须标明验证用途和推荐替代。
  • 禁止在单任务内同时写维护者站并宣称双受众完成;多受众须拆任务。
  • 禁止以底层函数/类型调用链作为 quick start 的唯一主叙事(无任务句、无推荐路径)。

同步锚点(validate / consumer)

FixtureBoundaryDisclosureGate · ScenarioCoverageMatrixProbe · DurableBatchOrchestrationProbe

额外同步锚点

ChinesePrimaryExpressionGate · SidebarPageRoleMaterializationProbe · SidebarGroupSemanticModelProbe

<!-- auto-sync anchors -->

UserFacingDeliveryChainGate · FinalUserManualFirstGate · UserPathContractSweep · UserManualProductizationGate · UserManualRenderedFlowAndRealWorkflowProbe · DocsPageRoleMatrixGate · DocsThemeRuntimeVisualProbeGate

© 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/user-manual-authoring of devcodex-labs/devcodex.

  • SKILL.md
  • intent.json

Open the folder on GitHubat commit 1dd4525

Compare with similar skills

User Manual 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.

User Manual Authoring compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
User Manual Authoring this skilldevcodex-labs/devcodex439—~1.9kAutomated safety check: PassAGPL-3.0
Technical Writingfrappe/skills146—~1.1kAutomated safety check: PassNone
Updating Docs For Releasestreamlit/docs178—~4kAutomated safety check: PassApache-2.0
Documentcodewhale-hq/Codewhale41k—~170Automated safety check: PassMIT
Documentationaiskillstore/marketplace4301 repos~2.7kAutomated safety check: PassNone
Technical Writercuriositech/some_claude_skills243—~1.4kAutomated safety check: PassMIT

Similar skills

  • Technical Writing

    frappe/skills

    Write prose in "Simplified Technical English". An agent skill from frappe/skills.

    146 GitHub stars~1.1k tokensUpdated 7 days ago
    DevelopmentAuto-check passed
  • Update the streamlit/docs repo for a new Streamlit release. An agent skill from streamlit/docs.

    178 GitHub stars~4k tokensUpdated yesterday
    DevelopmentAuto-check passed
  • Document

    codewhale-hq/Codewhale

    Write or update repository/product documentation: README, user guides, API docs, architecture, migration notes, and changelog material.

    41k GitHub stars~170 tokensUpdated today
    DevelopmentAuto-check passed
  • Documentation

    aiskillstore/marketplace

    Comprehensive documentation specialist covering API documentation, technical writing, design documentation, migration guides, and changelog generation.

    430 GitHub starsUsed in 1 repo~2.7k tokens
    DevelopmentAuto-check passed
  • Technical Writer

    curiositech/some_claude_skills

    Expert technical documentation specialist for developer docs, API references, and runbooks.

    243 GitHub stars~1.4k tokensUpdated 1 mo ago
    Writing & ContentAuto-check passed
  • Developer Docs Planning

    hashgraph-online/awesome-codex-plugins

    Plan developer documentation by choosing content types, defining scope, making documentation decisions, researching features, planning scenarios, and turning user needs into a practical…

    1.2k GitHub stars~913 tokensUpdated yesterday
    DevelopmentAuto-check passed

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

Questions about User Manual Authoring

What does User Manual Authoring do?

开源/公开用户站点与最终用户手册写作 Owner — guide/README/reference/migration/changelog/operations;与维护者开发站不等价;经 DocsAudienceIntent 路由。. User Manual Authoring is an agent skill from devcodex-labs/devcodex.

When should I use User Manual Authoring?

User Manual Authoring fits situations like: tasks that involve Technical writing; tasks that involve Changelog and release notes; tasks that involve Technical documentation.

How do I install User Manual Authoring in Claude Code?

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

How do I install User Manual Authoring in Codex?

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

Can I use User Manual 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 user-manual-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/user-manual-authoring, .gemini/skills/user-manual-authoring, .github/skills/user-manual-authoring and .opencode/skills/user-manual-authoring in your project.

What does User Manual Authoring need to run?

Going by SKILL.md and its folder, User Manual Authoring needs the command-line tools its instructions call (npm).

Does User Manual Authoring access the network?

SKILL.md contains no URLs. Its commands use npm, which can reach the network depending on how they are called. This is read from the text; nothing was executed.

Is User Manual 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 User Manual Authoring use?

User Manual 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 User Manual Authoring use?

About 1.9k tokens (SKILL.md is roughly 7.5k 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 User Manual Authoring?

Skills that share tags, products or a category with User Manual Authoring: Technical Writing (frappe/skills, 146 stars), Updating Docs For Release (streamlit/docs, 178 stars), Document (codewhale-hq/Codewhale, 41k stars) and Documentation (aiskillstore/marketplace, 430 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains User Manual 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.