agentleFS
Sign inStart free
AsiaOstrichAsiaOstrich/EngramGraph/.agents/skills/docs-generator/SKILL.md

docgen

Skill4 starsChanged 28 days agoMITView on GitHub

[UDS] Generate usage documentation (cheatsheets, references, guides) from project sources. Use when: producing a cheatsheet or feature reference from CLI and skill definitions, regenerating docs after commands change, checking generated docs are current. Not for: deciding what documentation a project needs or writing prose by hand — use /documentation-guide; changelog entries — use /changelog. Keywords: docgen, usage docs, cheatsheet, feature reference, generated documentation, 使用文件, 速查表, 文件產生.

5 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

3 rules. About 0 are common, 2 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Scan sources: - Read source files, commands, and skill definitions

    line 46
  2. Distinctive:

    Verify that generated documentation is up to date with source files.

    line 83
  3. Very specific:

    After /docgen completes, the AI assistant should suggest:

    line 119

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Documentation Generator | 文件產生器

Generate usage documentation (cheatsheets, references, guides) from project source files.

從專案原始檔案產生使用文件（速查表、參考手冊、使用指南）。

Workflow | 工作流程

  1. Read config - Load .usage-docs.yaml (or specified config file)
  2. Scan sources - Read source files, commands, and skill definitions
  3. Extract content - Parse descriptions, options, examples from source
  4. Generate docs - Produce output in the configured format
  5. 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 | 輸出類型

TypeDescription說明
cheatsheetQuick reference card with commands and shortcuts速查表，列出命令與快捷方式
referenceComprehensive feature reference with all options完整功能參考手冊含所有選項
usage-guideStep-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.sh as Step 8 (Usage docs sync check).

此檢查已整合至 pre-release-check.sh 的步驟 8（使用文件同步檢查）。

Generated Output Example | 產生範例

# UDS Command Cheatsheet

| Command    | Description               |
|------------|---------------------------|
| /commit    | Generate commit message    |
| /code-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
  • 執行 /code-review 審查文件品質 — Review documentation quality

Reference | 參考

  • Detailed guide: guide.md

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free