用 Codex 或 Claude 帮你安装 复制这段 Prompt,粘贴到 Codex、Claude 或其他助手里,让它检查 Skill 页面并帮你完成安装。
直接命令不会经过审查 Prompt;运行前请先检查来源。
npx skills add https://github.com/AsiaOstrich/universal-dev-standards --skill docgen命令会保持在同一行。复制前请横向滚动并检查完整内容。
想先保存到本地?可下载 SkillsMP 当前能够提供的文件。
[UDS] 以 Claude 原生 Agent tool 编排多任务执行计划(DAG-based,无外部引擎)。 Use when: executing a plan.json file with parallel/sequential task dependencies. Keywords: orchestrate, plan, execute, DAG, task plan, 编排, 执行计划, 并行.
[UDS] 从 Spec 文档、OpenSpec 变更或自由文本需求生成 plan.json。 Use when: converting specifications into executable task plans for /orchestrate. Keywords: plan, spec, task plan, 计划, 规格, 任务, plan.json, DAG.
[UDS] AI 辅助 git push 安全层:质量门禁 + 协作护栏。 Use when: pushing commits, force pushing, pushing to protected branches, pushing feature branches. Keywords: git push, force push, protected branch, quality gate, push receipt, PR automation, 推送, 保护分支, 质量门禁.
正在显示 SKILL.md
基于 SOC 职业分类
| name | docgen |
| scope | universal |
| description | [UDS] Generate usage documentation from project sources |
| allowed-tools | Read, Write, Grep, Glob, Bash(*) |
| argument-hint | [config file | 設定檔] |
| disable-model-invocation | true |
Generate usage documentation (cheatsheets, references, guides) from project source files.
從專案原始檔案產生使用文件(速查表、參考手冊、使用指南)。
.usage-docs.yaml (or specified config file)# .usage-docs.yaml
output_dir: docs/generated/
formats:
- cheatsheet
- reference
sources:
- path: skills/commands/
type: commands
- path: cli/src/commands/
type: cli
language: [en, zh-TW]
| Type | Description | 說明 |
|---|---|---|
| cheatsheet | Quick reference card with commands and shortcuts | 速查表,列出命令與快捷方式 |
| reference | Comprehensive feature reference with all options | 完整功能參考手冊含所有選項 |
| usage-guide | Step-by-step usage guide for new users | 新手入門的逐步使用指南 |
/docgen - Generate docs using default .usage-docs.yaml/docgen .usage-docs.yaml - Generate docs from specified config file/docgen --format cheatsheet - Generate cheatsheet onlyVerify that generated documentation is up to date with source files.
驗證產生的文件是否與原始檔案保持同步。
Usage | 使用方式:
# Check if generated docs are in sync
./scripts/check-usage-docs-sync.sh
# Auto-fix out-of-sync docs
./scripts/check-usage-docs-sync.sh --fix
--fix): Automatically regenerates out-of-date documentation files.Note | 注意: This check is integrated into
pre-release-check.shas Step 8 (Usage docs sync check).此檢查已整合至
pre-release-check.sh的步驟 8(使用文件同步檢查)。
# UDS Command Cheatsheet
| Command | Description |
|------------|---------------------------|
| /commit | Generate commit message |
| /code-review | Run code review |
| /sdd | Create SDD specification |
| /discover | Assess project health |
After /docgen completes, the AI assistant should suggest:
文件已產生。建議下一步 / Documentation generated. Suggested next steps:
- 審查產生的文件內容是否完整 — Review generated content for completeness
- 執行
/commit提交文件變更 ⭐ Recommended / 推薦 — Commit documentation changes- 執行
/code-review審查文件品質 — Review documentation quality