asiaostrich/docs-generator
locales/zh-TW/skills/docs-generator/SKILL.md
[UDS] 從專案原始檔案產生使用文件（速查表、參考手冊、使用指南）
$ install --global
skillsauthnpx skillsauth add asiaostrich/universal-dev-standards docs-generatorInstall 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 24, 2026, 9:21 AM72.1s2 files scanned
SKILL.md
- name:
- docs-generator
- source:
- ../../../../skills/docs-generator/SKILL.md
- source_version:
- 1.0.0
- translation_version:
- 1.0.0
- last_synced:
- 2026-02-10
- status:
- current
- description:
- [UDS] 從專案原始檔案產生使用文件（速查表、參考手冊、使用指南）
文件產生器
語言: English | 繁體中文
從專案原始檔案產生使用文件（速查表、參考手冊、使用指南）。
工作流程
- 讀取設定 - 載入
.usage-docs.yaml（或指定的設定檔） - 掃描來源 - 讀取原始碼檔案、命令和技能定義
- 提取內容 - 從原始碼解析描述、選項、範例
- 產生文件 - 以設定的格式產生輸出
- 寫入輸出 - 將產生的檔案儲存到設定的輸出目錄
設定檔格式
# .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]
輸出類型
| 類型 | 說明 | |------|------| | cheatsheet | 速查表，包含命令和快捷鍵 | | reference | 完整功能參考手冊，包含所有選項 | | usage-guide | 新手入門使用指南 |
使用方式
/docgen- 使用預設的.usage-docs.yaml產生文件/docgen .usage-docs.yaml- 從指定的設定檔產生文件/docgen --format cheatsheet- 僅產生速查表
檢查模式
驗證產生的文件是否與原始檔案保持同步。
使用方式：
# 檢查產生的文件是否同步
./scripts/check-usage-docs-sync.sh
# 自動修復不同步的文件
./scripts/check-usage-docs-sync.sh --fix
- 檢查模式（預設）：報告原始檔與產生文件之間的差異。若不同步則以非零狀態退出。
- 修復模式（
--fix）：自動重新產生過期的文件。
注意：此檢查已整合至
pre-release-check.sh的步驟 8（使用文件同步檢查）。
下一步引導
/docgen 完成後，AI 助手應建議：
文件已產生。建議下一步：
- 審查產生的文件內容是否完整
- 執行
/commit提交文件變更- 執行
/review審查文件品質
參考
- 詳細指南：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