create-software-docs

Generate and update project documentation from codebase analysis.

Updated Feb 10, 2026

Search Tags:#automation #software engineering #code analysis #documentation #code generation #technical writing

Ready to run

npx skills add https://github.com/jrodrigopuca/skills --skill create-software-docs

💬 Prompt for ChatGPT / Claude Chat▼

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

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill automates the creation and updating of comprehensive project documentation directly from your codebase, eliminating manual effort and ensuring accuracy.

Core Features & Use Cases

Automated Documentation Generation: Creates project overviews, architecture diagrams, development guides, ADRs, runbooks, API references, data models, and more.
Codebase Analysis: Analyzes your code to extract evidence, identify modules, and understand architecture.
Use Case: Imagine you've just finished a new feature. Use this Skill to automatically generate or update the relevant sections of your project's documentation, ensuring it always reflects the current state of the code.

Quick Start

Use the create-software-docs skill to generate documentation for the current project.

Frequently Asked Questions about create-software-docs

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

FAQPage Schema

How do I generate project documentation from codebase analysis?▼

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.

Can I update existing technical writing without rewriting the whole document?▼

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.

What is the best way to keep architecture diagrams and runbooks synced with code changes?▼

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.

What types of software engineering documents can be generated automatically?▼

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.

Does automated code analysis work without external dependencies or plugins?▼

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.

How does evidence-based documentation generation handle known issues and validation?▼

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.