Doc Generator Skill

Purpose

Automatically generates professional documentation for projects by analyzing the codebase structure, detecting languages and frameworks, and creating:

CLAUDE.md - Guidance for Claude Code
README.md - Project documentation

Both files include the SDLC Agêntico signature: 🤖 Generated with SDLC Agêntico by @arbgjr

Features

Language Detection: Auto-detects Python, JavaScript, TypeScript, Java, C#, Go, Rust, Ruby
Framework Detection: Identifies Django, Flask, FastAPI, React, Next.js, Vue, Angular, Express, .NET, Maven, Gradle
Directory Analysis: Generates project structure tree (max 3 levels deep)
Smart Defaults: Language-specific installation, run, and test commands
Test Detection: Identifies test files and directories
Docker/CI Detection: Detects Dockerfile and GitHub Actions
Professional Templates: Pre-built templates with all standard sections
Signature: Adds SDLC Agêntico attribution to all generated docs

Usage

Via Slash Command

/doc-generate

Via Python Script

# Generate in current directory
python3 .claude/skills/doc-generator/scripts/generate_docs.py

# Generate in specific directory
python3 .claude/skills/doc-generator/scripts/generate_docs.py --output-dir /path/to/project

# Force overwrite existing files
python3 .claude/skills/doc-generator/scripts/generate_docs.py --force

Generated Content

CLAUDE.md Sections

Project Overview
Architecture
Directory Structure
Development Setup
Development Workflow
Code Standards
Testing Strategy
Deployment
Common Tasks
Troubleshooting
SDLC Agêntico Signature

README.md Sections

Overview
Features
Tech Stack
Getting Started
Usage
API Documentation
Architecture
Development
Deployment
Contributing
License
Support
SDLC Agêntico Signature

Detection Logic

Languages

Detected by file extensions:

Python: *.py
JavaScript: *.js, *.jsx
TypeScript: *.ts, *.tsx
Java: *.java
C#: *.cs
Go: *.go
Rust: *.rs
Ruby: *.rb

Frameworks

Detected by dependency files:

Python: requirements.txt → Django, Flask, FastAPI
JavaScript/TypeScript: package.json → React, Next.js, Vue, Angular, Express
.NET: *.csproj files
Java: pom.xml (Maven), build.gradle (Gradle)

Tests

Detected by:

Test file patterns: test_*.py, *_test.py, *.test.js, *.spec.js
Test directories: tests/, test/, __tests__/, spec/

Templates

Templates are located in .claude/skills/doc-generator/templates/:

CLAUDE.md.template - Claude Code guidance template
README.md.template - Project README template

Templates use {{placeholder}} syntax for variable substitution.

Signature Format

All generated files end with:

---

🤖 *Generated with [SDLC Agêntico](https://github.com/arbgjr/sdlc_agentico) by [@arbgjr](https://github.com/arbgjr)*

This provides:

✅ Attribution to SDLC Agêntico
✅ Link to project repository
✅ Link to author GitHub profile
✅ Professional branding

Integration

Agents

This skill can be invoked by:

doc-generator agent (Phase 7 - Release)
orchestrator agent (on-demand)
Manual invocation via /doc-generate command

Phase

Typically used in Phase 7 (Release) but can be invoked at any time.

Dependencies

Python 3.11+
.claude/lib/python/sdlc_logging.py (structured logging)

Logging

All operations are logged with:

Skill: doc-generator
Phase: 7 (Release)
Events: Project analysis, file generation, errors

View logs:

# Grafana query
{skill="doc-generator"} | json

Examples

Python Project

Input:

requirements.txt with django
tests/ directory
Dockerfile

Output:

CLAUDE.md with Django-specific setup
README.md with Django stack
Run command: python manage.py runserver
Test command: pytest

TypeScript/React Project