Generate README.md and DESIGN.md documentation skeletons for software modules.
npx skills add https://github.com/wzyxdwll/ccgx-workflow --skill gen-docs-wzyxdwll
Please help me install this Agent Skill. Skill: gen-docs Source: https://github.com/wzyxdwll/ccgx-workflow/tree/main/templates/skills/tools/gen-docs Command: npx skills add https://github.com/wzyxdwll/ccgx-workflow --skill gen-docs-wzyxdwll
This tool automates the creation of README.md and DESIGN.md skeletons for new and existing modules, ensuring consistent, ready-to-use documentation across projects.
Run the doc generator for a module path to create README.md and DESIGN.md skeletons.
High-intent search queries and answers about installing and using this skill.
To auto-generate README.md and DESIGN.md skeletons, run the documentation generator against your module path. It scans module structure, dependencies, and entry points to produce ready-to-use documentation templates.
A DESIGN.md template should include architecture overviews, core components, technical decisions, and security considerations. This generator automates extraction of module dependencies and entry points to populate those sections accurately.
You can generate standardized documentation for both new and existing codebases. The tool applies language detection and entry-point discovery to ensure the README.md and DESIGN.md scaffolds match your project's actual structure.
Automated code analysis improves README scaffolding by scanning module dependencies and entry points. This ensures the generated README.md includes accurate usage templates, feature lists, and an API overview tailored to your code.
The documentation generator requires no specific dependencies or frameworks to run. It operates independently to analyze your project structure and extract module information for the documentation scaffolds.
The best way to ensure consistent documentation across multiple software modules is to automate generation of README.md and DESIGN.md skeletons. This enforces standardized templates for overviews, features, architecture, and security considerations.
vecearAnalyze a repository to generate ARCHITECTURE.md with Mermaid diagrams and entry points.
arisngGroup repository changes into atomic conventional commits by file type.
JongsixGenerate technical documentation from source code and API definitions.
astoreyaiCapture screen regions and convert OCR text to Markdown notes.
