Generate and update project documentation from codebase analysis.
npx skills add https://github.com/jrodrigopuca/skills --skill create-software-docs
Please help me install this Agent Skill. Skill: create-software-docs Source: https://github.com/jrodrigopuca/skills/tree/main/create-software-docs Command: npx skills add https://github.com/jrodrigopuca/skills --skill create-software-docs
This Skill automates the creation and updating of comprehensive project documentation directly from your codebase, eliminating manual effort and ensuring accuracy.
Use the create-software-docs skill to generate documentation for the current project.
High-intent search queries and answers about installing and using this skill.
Automated codebase analysis generates project documentation by extracting evidence to identify modules and understand architecture. It orchestrates the creation of overviews, architecture diagrams, development guides, ADRs, runbooks, API references, and data models.
Yes, automated documentation tools operate in update and reconcile modes to modify existing documents. These modes compare your current codebase against existing documentation to apply targeted updates while adhering to evidence-based principles.
Keep architecture diagrams and runbooks synced by running documentation generation in reconcile mode. This mode updates existing documentation to reflect the current state of the codebase, ensuring accuracy by using strict evidence-based extraction.
Automated documentation generation creates project overviews, architecture diagrams, development guides, ADRs, runbooks, API references, data models, glossaries, and known issues. It covers scope analysis, validation, and cleanup of technical writing.
Yes, this automation operates without external dependencies or plugins. It uses internal scripts and references to analyze your codebase, extract evidence, identify modules, and orchestrate modular documentation generation directly.
Evidence-based documentation handles known issues and validation by extracting proof directly from the codebase. It generates a known issues section and performs validation and cleanup steps to ensure the technical writing strictly reflects the code.
telum-aiCreate a Speck project structure with a skeleton project.md file.
JongsixGenerate technical documentation from source code and API definitions.
julianobarbosaReview code for quality, bugs, security issues, and best practices using Codex.
8GG-GitGenerate and maintain technical documentation including READMEs, API docs, runbooks, architecture documents, and onboarding guides.
