Generates cheatsheets, references, and usage guides from project source files like commands and skills using YAML config. Supports check mode to verify doc sync with sources.
npx claudepluginhub joshuarweaver/cascade-code-general-misc-3 --plugin asiaostrich-universal-dev-standardsThis skill is limited to using the following tools:
Generate usage documentation (cheatsheets, references, guides) from project source files.
Creates isolated Git worktrees for feature branches with prioritized directory selection, gitignore safety checks, auto project setup for Node/Python/Rust/Go, and baseline verification.
Executes implementation plans in current session by dispatching fresh subagents per independent task, with two-stage reviews: spec compliance then code quality.
Dispatches parallel agents to independently tackle 2+ tasks like separate test failures or subsystems without shared state or dependencies.
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 |
| /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- 執行
/review審查文件品質 — Review documentation quality