Docgen

Documents

docgen

Docgen is an Agent Skill for documents published in the majiayu000/claude-skill-registry repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Generate comprehensive documentation for .NET/C# codebases including architecture diagrams, API references, domain models, and getting started guides. Use when asked to: generate docs, document this, create documentation, write docs for, document a .NET project, create architecture documentation, document APIs.

View on GitHub ↗

QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

Open your project in Codex.
Copy and paste the prompt below.
Review files and risks before approving any action.

Prompt to paste

Inspect the Agent Skill at https://github.com/majiayu000/claude-skill-registry/blob/HEAD/skills/documents/docgen/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/docgen, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Documentation Generator

Generate comprehensive documentation for .NET/C# codebases.

Prerequisites

Scripts in scripts/:

scan_dotnet.py - Analyze project structure, patterns, frameworks
find_endpoints.py - Extract ASP.NET API endpoints

Workflow

Phase 1: Analysis

1.1 Scan Codebase Structure

python3 scripts/scan_dotnet.py /path/to/codebase

Output: JSON with solution structure, frameworks, packages, detected patterns (Repository, CQRS, DDD, MediatR).

1.2 Extract API Endpoints (if web project)

python3 scripts/find_endpoints.py /path/to/codebase

Output: JSON with controllers, routes, parameters, response types.

1.3 Identify Key Files

Always read:

README.md, CLAUDE.md (existing context)
Program.cs or Startup.cs (configuration)
Domain entities (in Domain/Core projects)

For Clean Architecture: Domain → Application → Infrastructure layers For libraries: Public API surface, extension methods, configuration classes

Phase 2: Planning

Determine documents to generate:

Document	When to Include
Architecture Overview	Always
Getting Started	Always
API Reference	Web project with endpoints
Domain Model	DDD patterns detected
Configuration Guide	Options/Configuration classes found

Create progress tracker at /path/to/codebase/docs/.docgen-progress.json.

Phase 3: Generation

For each document:

Read relevant source files
Generate markdown following templates in references/
Write to /path/to/codebase/docs/
Update progress tracker

Phase 4: Finalization

Generate docs/README.md navigation
Generate docs/GLOSSARY.md (if DDD)
Mark progress complete

Reference Templates

Detailed templates for each document type:

Architecture: See architecture.md
API Reference: See api-reference.md
Domain Model: See domain-model.md
Getting Started: See getting-started.md

Output Structure

docs/
├── README.md                 # Navigation index
├── GLOSSARY.md              # Domain terms (if applicable)
├── .docgen-progress.json    # Progress tracking
├── architecture/
│   └── overview.md
├── api/
│   └── README.md
├── domain/
│   └── models.md
└── getting-started.md

Quality Standards

Reference actual file paths and class names
Include real code examples from the codebase
Use Mermaid diagrams for architecture
Define domain terms in glossary
Cross-reference between documents