skills.rest
Muhomorik
MuhomorikCOMMUNITY
Explore all skills by this author →
GitHub

dotnet-documentation

Standardize .NET documentation with XML docs, DebuggerDisplay, and Mermaid diagrams.

Updated Mar 29, 2026
Search Tags:#csharp#mermaid#dotnet#architecture-diagrams#documentation-standards#xml-docs#debuggerdisplay
One-click install
npx skills add https://github.com/Muhomorik/KanelBulleKapital --skill dotnet-documentation
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: dotnet-documentation
Source: https://github.com/Muhomorik/KanelBulleKapital/tree/main/.claude/skills/dotnet-documentation
Command: npx skills add https://github.com/Muhomorik/KanelBulleKapital --skill dotnet-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation conventions for .NET (.csproj, C#) including XML docs, DebuggerDisplay attributes, and Mermaid diagrams for architecture documentation. Use when adding XML docs, DebuggerDisplay, or creating architecture diagrams in markdown. DO NOT use for web frameworks (Next.js, React, JavaScript, Node.js).

Core Features & Use Cases

  • XML documentation conformance for public APIs, including summary, param, and returns tags.
  • Guidance on applying [DebuggerDisplay] attributes to DTOs, entities, aggregates, and value objects to improve traceability.
  • Mermaid-based architecture diagrams and structured architecture documentation to visualize components and relationships.

Quick Start

Document public APIs with XML comments, annotate types with DebuggerDisplay attributes, and include Mermaid diagrams for architecture in your project.

Frequently Asked Questions about dotnet-documentation

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

FAQPage Schema
How do I enforce XML documentation standards for public APIs in C# codebases?▼

Apply XML documentation tags like summary, param, and returns to public APIs in C# codebases to standardize public API summaries. This ensures consistent documentation conformance across all exposed methods and types in your project.

What is the best way to add DebuggerDisplay attributes to DTOs and entities?▼

Annotate DTOs, entities, aggregates, and value objects with DebuggerDisplay attributes to improve traceability. This provides meaningful runtime information during debugging sessions and standardizes how types are displayed across the debugger.

How do I create Mermaid architecture diagrams for .NET projects?▼

Embed Mermaid syntax in Markdown guides to visualize components and relationships for .NET projects. This standardizes architecture documentation and ensures consistent architecture visualization across all project documentation.

Can I use this .NET documentation standard for web frameworks like Next.js or React?▼

No, this .NET documentation standard does not support web frameworks like Next.js, React, JavaScript, or Node.js. It is specifically designed for C# codebases and .NET project files to enforce XML docs and DebuggerDisplay attributes.

When do I need to document UI-thread notes in .NET public APIs?▼

Document UI-thread notes in .NET public APIs when providing consistent public API summaries to clarify thread safety requirements. This ensures developers understand UI-thread constraints and execution context when interacting with the documented API surface.

Related Skills

Explore More Software Engineering Skills→
dodygdodyg

dotnet-csproj-reading

Read and modify SDK-style .csproj files for project properties and dependencies.

Community
Intermediate
niltonfredericoniltonfrederico
2

dotnet-documenter

Generate Markdown documentation with Mermaid diagrams for .NET/C# applications.

Community
Advanced
arbisoftarbisoft
4

java-coding-standards

Enforce Java coding standards for Spring Boot projects via static checks and peer reviews.

Official
Intermediate
bryandrennerbryandrenner

dotnet-best-practices

Enforce .NET/C# best practices for code quality and architecture.

Community
Advanced