docs-generator

Generate project documentation from source files using a configuration file.

70|13|Updated Dec 24, 2025
One-click install
npx skills add https://github.com/AsiaOstrich/universal-dev-standards --skill docs-generator-asiaostrich
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-generator
Source: https://github.com/AsiaOstrich/universal-dev-standards/tree/main/locales/zh-CN/skills/docs-generator
Command: npx skills add https://github.com/AsiaOstrich/universal-dev-standards --skill docs-generator-asiaostrich

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the creation of comprehensive project documentation, including feature references and quick cheatsheets, directly from source files.

Core Features & Use Cases

  • Automated Documentation Generation: Creates FEATURE-REFERENCE.md and CHEATSHEET.md files.
  • Multi-Language Support: Generates documentation in English, Traditional Chinese, and Simplified Chinese.
  • Source Scanning: Scans CLI commands, skills, agents, workflows, core specs, and scripts.
  • Use Case: After updating your project's CLI commands or skills, run this Skill to instantly generate updated reference manuals and cheatsheets, ensuring your documentation stays current with minimal manual effort.

Quick Start

Use the docs-generator skill to generate all documentation for the current project.

Frequently Asked Questions about docs-generator

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate project documentation automatically from source files?

You can generate project documentation automatically by running a skill that scans your source files and creates feature references and cheatsheets. It requires a configuration file like .usage-docs.yaml to specify your output paths, formats, and documentation sources.

What is the best way to create a cheatsheet and feature reference for my codebase?

The best way to create a cheatsheet and feature reference is to automate the generation directly from your source files. By scanning project components like core specs and workflows, the tool instantly outputs updated reference manuals, ensuring your documentation stays current with minimal manual effort.

Can I generate documentation in languages other than English?

Yes, you can generate documentation in multiple languages. The automated documentation generation supports outputting feature references and cheatsheets in English, Traditional Chinese, and Simplified Chinese by scanning your defined project sources.

Do I need a configuration file to automate documentation generation for my scripts?

Yes, you need a configuration file, such as .usage-docs.yaml, to automate documentation generation for your scripts. This file defines the necessary output paths, desired formats, and the specific project sources to scan before generating the reference files.

What project components can be scanned for automated code documentation?

Automated code documentation scans various project components including CLI commands, skills, agents, workflows, core specs, and scripts. This comprehensive source scanning ensures all critical project elements are captured in the generated feature references and cheatsheets.