Generate README.md and DESIGN.md skeletons by analyzing module code structure.
npx skills add https://github.com/telagod/code-abyss --skill gen-docs-telagod
Please help me install this Agent Skill. Skill: gen-docs Source: https://github.com/telagod/code-abyss/tree/main/skills/tools/gen-docs Command: npx skills add https://github.com/telagod/code-abyss --skill gen-docs-telagod
Documentation is essential for onboarding and long-term maintenance. This skill analyzes a module's structure to auto-create consistent README.md and DESIGN.md skeletons, ensuring every new module starts with proper docs.
Execute node scripts/doc_generator.js <module-path> to generate the documentation templates for the target module.
High-intent search queries and answers about installing and using this skill.
To automatically generate markdown documentation, you can run a documentation generator script against your module path to analyze code structure and produce ready-to-use README.md and DESIGN.md templates.
Scaffolding a README.md and DESIGN.md skeleton is done by analyzing your code structure to extract files, functions, and classes, then generating templates that describe the module, its components, architecture, and risks.
Yes, you can generate documentation templates that automatically detect the programming language and list dependencies by analyzing the target module's code structure before producing the markdown files.
No external dependencies are required to auto-generate module documentation skeletons, as the skill operates independently using its internal scripts to analyze code and output the markdown templates.
You should use an automated documentation generator when starting a new module to ensure every project begins with proper docs, saving time onboarding and supporting long-term maintenance with consistent skeletons.
Generated documentation skeletons are limited to README and DESIGN files because they are designed to scaffold initial module descriptions, architecture decisions, and risks rather than producing comprehensive API references.
mvillmowMap module hierarchies and dependencies across multi-language codebases.
pckienuitStandardize project documentation with structured markdown templates for READMEs, APIs, and changelogs.
opensage-agentIdentify direct and indirect callers of functions using Neo4j callgraph data.
nobu007Generate standardized Markdown agent definitions for the Miyabi framework.
