asiaostrich/docgen
skills/docs-generator/SKILL.md
[UDS] Generate usage documentation from project sources
$ install --global
skillsauthnpx skillsauth add asiaostrich/universal-dev-standards docgenInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Apr 3, 2026, 10:52 AM6.0s2 files scanned
SKILL.md
- name:
- docgen
- scope:
- uds-specific
- description:
- [UDS] Generate usage documentation from project sources
- allowed-tools:
- Read, Write, Grep, Glob, Bash(*)
- argument-hint:
- [config file | 設定檔]
- disable-model-invocation:
- true
Documentation Generator | 文件產生器
Generate usage documentation (cheatsheets, references, guides) from project source files.
從專案原始檔案產生使用文件（速查表、參考手冊、使用指南）。
Workflow | 工作流程
- Read config - Load
.usage-docs.yaml(or specified config file) - Scan sources - Read source files, commands, and skill definitions
- Extract content - Parse descriptions, options, examples from source
- Generate docs - Produce output in the configured format
- Write output - Save generated files to the configured output directory
Config File Format | 設定檔格式
# .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]
Output Types | 輸出類型
| 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 | 新手入門的逐步使用指南 |
Usage | 使用方式
/docgen- Generate docs using default.usage-docs.yaml/docgen .usage-docs.yaml- Generate docs from specified config file/docgen --format cheatsheet- Generate cheatsheet only
Check Mode | 檢查模式
Verify 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
- Check mode (default): Reports differences between source and generated docs. Exits with non-zero status if out of sync.
- Fix mode (
--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（使用文件同步檢查）。
Generated Output Example | 產生範例
# UDS Command Cheatsheet
| Command | Description |
|------------|---------------------------|
| /commit | Generate commit message |
| /review | Run code review |
| /sdd | Create SDD specification |
| /discover | Assess project health |
Next Steps Guidance | 下一步引導
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
Reference | 參考
- Detailed guide: guide.md
Related Skills
asiaostrich/sweep
development
VerifiedTrustedCommunity
[UDS] 扫描代码库的调试残留与代码质量问题；可自动修正安全模式。 Use when: before committing, during PR review, or periodic codebase cleanup. Keywords: sweep, debug cleanup, console.log, debugger, TODO, ts-any, code quality, 扫描, 清理.
69SKILL.mdUpdated Jun 4, 2026
asiaostrich/spec-derive
tools
VerifiedTrustedCommunity
[UDS] 从规格衍生 BDD 场景、TDD 骨架或 ATDD 表格
69SKILL.mdUpdated Jun 4, 2026
asiaostrich/skill-builder
development
VerifiedTrustedCommunity
[UDS] 识别重复流程并以正确的开发深度构建 Skill
69SKILL.mdUpdated Jun 4, 2026
asiaostrich/push
tools
VerifiedTrustedCommunity
[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, 推送, 保护分支, 质量门禁.
69SKILL.mdUpdated Jun 4, 2026