Why does it prefer IReadOnlyList over IEnumerable for collections?

IReadOnlyList signals to the consumer that the collection is already materialized and indexable, reducing ambiguity regarding lazy evaluation or multiple enumerations common with IEnumerable.

Does this skill support modern .NET versions?

Yes, it is specifically optimized for .NET 8.0 and newer, utilizing modern C# features like primary constructors, collection expressions, and optimized argument throw helpers.

How does this skill handle asynchronous API design?

It provides specific conventions for Task and ValueTask selection, the correct usage of the Async suffix, and ensures CancellationTokens are always placed as the final parameter.

Can this help with error handling strategies?

Absolutely. It guides you on when to use exceptions versus the Try-Get pattern or Result objects, helping you design predictable and performant error reporting into your API.

.NET C# API Design Guide

Name: .NET C# API Design Guide
Author: rudironsoni

byrudironsoni

0•

API 开发

Provides expert architectural guidance for designing intuitive, consistent, and forward-compatible public .NET APIs and libraries.

This skill empowers developers to build professional-grade .NET API surfaces by applying industry-standard design principles and .NET Framework Design Guidelines. It covers critical architectural decisions including standardized naming conventions, logical parameter ordering, optimal return type selection (such as IReadOnlyList and IAsyncEnumerable), and robust error handling strategies using the Try pattern or custom exception hierarchies. Optimized for .NET 8.0+, it ensures that your codebases are developer-friendly, highly maintainable, and aligned with modern C# features like primary constructors and collection expressions.

主要功能

01Comprehensive error reporting strategies including Result patterns and exception hierarchies

02Strategic return type selection for performance and consumer clarity

03Standardized naming conventions for types, methods, and attributes based on .NET guidelines

040 GitHub stars

05Extensibility guidance using composition, interfaces, and builder patterns

06Optimized parameter ordering patterns and overload progression logic

使用场景

01Refactoring existing .NET method signatures to improve developer experience (DX)

02Implementing consistent 'Try' patterns and async workflows across a service layer

03Designing a new public NuGet library or shared internal enterprise SDK

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add rudironsoni/dotnet-harness-plugin dotnet-csharp-api-design

For use in Claude.ai and ChatGPT

主要功能

01Comprehensive error reporting strategies including Result patterns and exception hierarchies

02Strategic return type selection for performance and consumer clarity

03Standardized naming conventions for types, methods, and attributes based on .NET guidelines

040 GitHub stars

05Extensibility guidance using composition, interfaces, and builder patterns

06Optimized parameter ordering patterns and overload progression logic

使用场景

01Refactoring existing .NET method signatures to improve developer experience (DX)

02Implementing consistent 'Try' patterns and async workflows across a service layer

03Designing a new public NuGet library or shared internal enterprise SDK

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add rudironsoni/dotnet-harness-plugin dotnet-csharp-api-design

For use in Claude.ai and ChatGPT