skills.rest
arbgjr
arbgjrCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

doc-generator

Generate CLAUDE.md and README.md documentation from analyzed codebases.

3|Updated Jan 12, 2026
Search Tags:#automation#template#documentation#claude-code#project-docs#code-repo
One-click install
npx skills add https://github.com/arbgjr/sdlc_agentico --skill doc-generator-arbgjr
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-generator
Source: https://github.com/arbgjr/sdlc_agentico/tree/main/.claude/skills/doc-generator
Command: npx skills add https://github.com/arbgjr/sdlc_agentico --skill doc-generator-arbgjr

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires sdlc_logging, and includes scripts (resource) components.

What problem does it solve?

Generates ready-to-use software project documentation by analyzing a codebase and producing CLAUDE.md and README.md with an SDLC Agêntico signature.

Core Features & Use Cases

  • Language and framework detection to tailor documentation
  • Directory structure analysis and template-based documentation generation
  • Automatic attribution with the SDLC Agêntico signature

Quick Start

Run the doc-generator to produce CLAUDE.md and README.md for your project.

Frequently Asked Questions about doc-generator

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

FAQPage Schema
How do I automatically generate a README.md for my codebase?▼

You can automatically generate a README.md by running the doc-generator, which analyzes your codebase structure and outputs ready-to-use project documentation using predefined templates.

Can I generate project documentation for a multi-language repository?▼

Yes, project documentation generation supports multi-language repositories. The tool detects languages and frameworks like Python, JavaScript, and TypeScript, then tailors the output files to match your project stack.

How does codebase analysis work for creating CLAUDE.md files?▼

Codebase analysis for CLAUDE.md creation works by reading project metadata, detecting frameworks, analyzing the directory structure and tests, then applying a CLAUDE.md.template to produce tailored documentation.

Do I need a logging dependency to automate documentation generation?▼

Yes, the sdlc_logging dependency is required to automate documentation generation. It provides the necessary logging framework for the CLI workflow that reads project metadata and writes generated files.

What is the best way to add an attribution signature to generated project docs?▼

The best way to add an attribution signature is using an automated template-based generator, which embeds the SDLC Agêntico signature directly into your generated CLAUDE.md and README.md files.

Are there limitations to template-based project documentation generation?▼

Template-based documentation generation is limited by the structure of CLAUDE.md.template and README.md.template. Documentation quality depends on the accuracy of detected project metadata and directory analysis.

Related Skills

Explore More Software Engineering Skills→
spencerbeggsspencerbeggs

user-docs-detect-shape

Analyze repository file structures to determine project type and technical metadata.

Community
Intermediate
arisngarisng
5

git-atomic-commit

Group repository changes into atomic conventional commits by file type.

Community
Advanced
rodmena-limitedrodmena-limited
3

moai-foundation-claude

Create, configure, and manage Claude Code Skills with templates and tools.

Official
Advanced
resetreset

static-site-engineer

Develop front-end templates across Zola, Hugo, 11ty, Astro, and Eleventy sites.

Community
Advanced