dotnet:document

Generate XML documentation, READMEs, and OpenAPI descriptions from .NET source code.

2|Updated Apr 19, 2026
One-click install
npx skills add https://github.com/dimsour/dotnet-ai-toolkit --skill dotnet-document
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: dotnet:document
Source: https://github.com/dimsour/dotnet-ai-toolkit/tree/main/plugins/dotnet/skills/document
Command: npx skills add https://github.com/dimsour/dotnet-ai-toolkit --skill dotnet-document

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

Ensures documentation reflects actual code, eliminating the need for manual updates and reducing inconsistencies.

Core Features & Use Cases

  • XML Doc Comments Generation: Automatically creates detailed XML doc comments from source code.
  • README and Architecture Documentation: Updates READMEs and architectural documents with accurate details.
  • OpenAPI Descriptions: Generates rich OpenAPI descriptions from .NET code.

Quick Start

/dotnet:document --scope project

Frequently Asked Questions about dotnet:document

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

FAQPage Schema
How do I generate XML doc comments for .NET code accurately from source?

Generate XML doc comments for .NET code by mapping directly from source files to output without speculation. This approach ensures API documentation reflects actual code, eliminating manual updates and reducing inconsistencies.

What is the best way to update a README with accurate .NET architecture details?

Updating a README with .NET architecture details is best handled by extracting accurate details directly from source code without speculation. This ensures architectural documents reflect actual code, reducing manual inconsistencies.

Can I generate OpenAPI descriptions directly from .NET source code?

Yes, you can generate rich OpenAPI descriptions directly from .NET source code. By mapping strictly from source to output without speculation, it ensures the API documentation accurately reflects the actual implementation.

How do I document an entire .NET project at once?

Document an entire .NET project at once by executing the generation command with the project scope. This maps directly from source to output, handling XML doc comments, READMEs, and OpenAPI descriptions across the codebase.

Why does my .NET API documentation drift out of sync with the source code?

.NET API documentation drifts out of sync due to manual updates and inconsistencies between code and docs. Generating documentation directly from the source ensures it maps accurately to the actual code without speculation.

Are there limitations to generating .NET documentation without adding extra context?

Generating .NET documentation without extra context means the output maps strictly to source code features without speculation. It avoids adding features outside of the code, which limits documentation to exactly what exists in the source.