dotnet-doc-controller

Generates comprehensive Markdown API documentation for .NET REST controllers and related DTOs/models/enums.

Updated Jun 20, 2025
One-click install
npx skills add https://github.com/emaginebr/BazzucaMedia --skill dotnet-doc-controller-emaginebr
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: dotnet-doc-controller
Source: https://github.com/emaginebr/BazzucaMedia/tree/main/.claude/skills/dotnet-doc-controller
Command: npx skills add https://github.com/emaginebr/BazzucaMedia --skill dotnet-doc-controller-emaginebr

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the creation of comprehensive Markdown documentation for .NET REST API controllers, saving developers significant time and ensuring API consistency.

Core Features & Use Cases

  • Automated API Documentation: Generates detailed documentation for controllers, endpoints, request/response objects, and enums.
  • Comprehensive Coverage: Scans the entire codebase to find all related DTOs, models, and enums for accurate documentation.
  • Use Case: After developing a new ProductController, use this Skill to instantly generate a complete API reference document in the docs/ directory, ready for integration into your project's documentation portal.

Quick Start

Use the dotnet-doc-controller skill to generate documentation for the UserController.

Frequently Asked Questions about dotnet-doc-controller

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

FAQPage Schema
How do I generate Markdown API documentation for a .NET REST controller?

This Skill parses specified .NET REST controller files and outputs comprehensive Markdown documentation to a `docs/` directory using UPPER_SNAKE_CASE filenames.

Can I automatically document DTOs and enums used across my .NET solution?

Yes, this generator scans the entire .NET solution to automatically identify and document all associated DTOs, models, and enums linked to the target REST controller.

What is the best way to maintain consistent API documentation for new .NET controllers?

Automating Markdown generation ensures API consistency by parsing new REST controllers and formatting endpoints, request objects, and response models according to strict documentation rules.

Does the generated .NET API documentation follow a specific file naming convention?

Yes, the generated Markdown API documentation files are saved to a `docs/` directory and strictly follow an UPPER_SNAKE_CASE naming convention for filesystem consistency.

What components are required to start generating .NET controller Markdown files?

No external dependencies are required; simply provide a target .NET REST controller file and the generator will parse the solution to create the Markdown API reference.