메뉴
Generate or update README.md and XML doc-comments for an Acontplus library. Use when documenting a library, refreshing package docs, or adding missing XML summaries.
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
SOC 직업 분류 기준
| name | generate-documentation |
| description | Generate or update README.md and XML doc-comments for an Acontplus library. Use when documenting a library, refreshing package docs, or adding missing XML summaries. |
Acontplus.NotificationsPath: src/Acontplus.<Name>/README.md
Follow readme-conventions.md steering strictly — no version-stamped content, no change history.
Canonical section order — this order is mandatory:
## Features — current capabilities, no version refs## Installation## Quick Start## Configuration — JSON snippet + C# registration## Usage Examples## Requirements## Troubleshooting (optional)## LicenseBadge template:
[](https://www.nuget.org/packages/Acontplus.<Name>)
[](https://dotnet.microsoft.com/download/dotnet/10.0)
[](LICENSE)
Only add a diagram to the README for packages with non-obvious internal structure.
Add a diagram (place after ## Features, before ## Installation, ≤ ~20 nodes):
Core — Domain/, Abstractions/, Validation/, DTOs/ layer relationshipsBilling — SRI async authorization sequenceInfrastructure — the 5 subsystems (Caching, Resilience, HTTP, Middleware, HealthChecks)Persistence.SqlServer / Persistence.PostgreSQL — EF Core vs ADO.NET dual-accessNotifications — multi-channel map (Email/WhatsApp/SES/Templates)Do NOT add a diagram (text description is sufficient):
Reports, Services, Utilities, Analytics, Barcode, Logging, S3Application, ApiDocumentation, Persistence.CommonIf adding one: one sentence above the diagram block. Use Mermaid v11 markdown strings with config: htmlLabels: false.
For complex diagrams that would exceed ~20 nodes, link to the wiki instead:
> Full architecture diagrams: [Architecture](https://github.com/acontplus/acontplus-dotnet-libs/wiki/Architecture)
Every public and protected member must have <summary>.
Classes/Interfaces:
/// <summary>One sentence describing what this type does.</summary>
/// <remarks>Optional: threading notes, usage context.</remarks>
public class MyService : IMyService
Methods:
/// <summary>One sentence describing what this method does.</summary>
/// <param name="id">The unique identifier.</param>
/// <param name="cancellationToken">Token to cancel the operation.</param>
/// <returns>
/// A <see cref="Result{T}"/> containing the entity on success,
/// or a failure result with code "NOT_FOUND" if not found.
/// </returns>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="id"/> is null.</exception>
public async Task<Result<T>> GetByIdAsync(string id, CancellationToken cancellationToken = default)
Properties: /// <summary>Gets or sets X.</summary>
Enums: document the type and each member individually.
Use <inheritdoc /> on implementations to avoid duplication.
public/protected members have <summary>Result<T> returns document both success and failure pathsCancellationToken params documented<exception> tags where exceptions are thrown<inheritdoc /> on overrides/implementations<NoWarn>1591</NoWarn> in .csprojdotnet build src/Acontplus.<Name>
0 errors and 0 CS1591 warnings required before finishing.
Generate a Mermaid architecture diagram for Acontplus libraries. Use when visualizing package dependencies, request flows, DDD layers, or interaction sequences.
Scaffold a new Acontplus NuGet library package following all monorepo conventions. Use when adding a new library to the repository under src/.
Document package changes by interviewing the author, then produce a CHANGELOG entry, updated PackageReleaseNotes in .csproj, and a conventional commit message. Use when finishing work on an Acontplus library.
Generate xUnit unit and integration tests for an Acontplus library or class following monorepo conventions. Use when adding tests or improving test coverage.