Generates README, API docs, and summaries from scanned source code and files.
npx skills add https://github.com/sqfzy/my_configs --skill doc-sqfzy
Please help me install this Agent Skill. Skill: doc Source: https://github.com/sqfzy/my_configs/tree/main/claude/skills/doc Command: npx skills add https://github.com/sqfzy/my_configs --skill doc-sqfzy
Documentation often becomes out-of-sync with codebases. This Skill automatically generates and updates project documentation by analyzing source code and related artifacts, reducing manual effort and ensuring accuracy across docs like API docs, READMEs, and architecture summaries.
Generate or update the project's documentation from the codebase to keep API docs, READMEs, and summaries in sync.
High-intent search queries and answers about installing and using this skill.
API docs generation from source code is automated by reading code comments and docstrings directly from your codebase. This Skill analyzes your source files to produce accurate API documentation without manual effort.
Yes, README and CHANGELOG updates are automated by reading your source code and related artifacts. The Skill keeps these documentation files in sync with your actual codebase to aid onboarding and maintenance.
Keeping project documentation in sync with code is achieved by automatically generating and updating docs from source code analysis. This approach reads actual code to ensure documentation accuracy across API docs, READMEs, and summaries.
Yes, this documentation generator works without external dependencies. It reads your source code and related artifacts directly, and auto-saves the doc generation reports to a designated artifacts directory.
Onboarding guides are created from existing source code by analyzing your codebase and related artifacts. The Skill produces a consistent documentation set from your code to aid project onboarding and maintenance.
Automated code documentation should be used when your docs frequently become out-of-sync with your codebase. It reduces manual effort by reading actual code to produce accurate API docs, READMEs, and architecture summaries.
penghang1223Extract code comments and annotations into Markdown, JSON, or OpenAPI YAML documentation.
SSiertsemaEvaluate documentation tooling against audience, content, and technical criteria.
SensLiaoAutomate static code analysis and security scanning on pull requests or CI pipelines.
MikkoNumminenConvert markdown and structured data files into PDFs using local Chrome.
