Skip to main content

docgen

[UDS] 從專案原始檔案產生使用文件(速查表、參考手冊、使用指南)

소스 정보

저장소
AsiaOstrich/universal-dev-standards
최근 소스 활동
2026년 6월 19일 09:26
감지된 SKILL.md 언어
중국어
스타
80
포크
14

설치 방법

기본적으로 소스를 먼저 확인하는 Prompt가 선택됩니다. 직접 명령으로 전환하거나 로컬 사본을 다운로드할 수도 있습니다.

소스 파일 검토

설치 여부를 결정하기 전에 SKILL.md와 SkillsMP에 표시된 보조 파일을 읽어 보세요.

파일 탐색기
2 개 파일

SKILL.md 표시 중

SKILL.md
소스 지침 · 읽기 전용 미리보기
source
../../../../skills/docs-generator/SKILL.md
source_version
1.0.0
translation_version
1.0.0
last_synced
2026-02-10T00:00:00.000Z
status
current
description
[UDS] 從專案原始檔案產生使用文件(速查表、參考手冊、使用指南)
name
docgen
allowed-tools
Read, Write, Grep, Glob, Bash(*)
scope
uds-specific
argument-hint
[config file | 設定檔]
disable-model-invocation
true
# 文件產生器 > **語言**: [English](../../../../skills/docs-generator/SKILL.md) | 繁體中文 從專案原始檔案產生使用文件(速查表、參考手冊、使用指南)。 ## 工作流程 1. **讀取設定** - 載入 `.usage-docs.yaml`(或指定的設定檔) 2. **掃描來源** - 讀取原始碼檔案、命令和技能定義 3. **提取內容** - 從原始碼解析描述、選項、範例 4. **產生文件** - 以設定的格式產生輸出 5. **寫入輸出** - 將產生的檔案儲存到設定的輸出目錄 ## 設定檔格式 ```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` - 僅產生速查表 ## 下一步引導 `/docgen` 完成後,AI 助手應建議: > **文件已產生。建議下一步:** > - 審查產生的文件內容是否完整 > - 執行 `/commit` 提交文件變更 > - 執行 `/code-review` 審查文件品質 ## 參考 - 詳細指南:[guide.md](./guide.md)
GitHub에서 보기