mcaf-documentation
The mcaf-documentation skill restructures and improves project documentation by establishing clear source-of-truth locations, fixing stale or duplicated content, and improving navigation. Use it when documentation is scattered, outdated, or hard to navigate, or when a repository needs cleaner information architecture without writing specific feature specs or ADRs.
git clone --depth 1 https://github.com/managedcode/dotnet-skills /tmp/mcaf-documentation && cp -r /tmp/mcaf-documentation/catalog/Platform/MCAF/skills/mcaf-documentation ~/.claude/skills/mcaf-documentationSKILL.md
# MCAF: Documentation ## Trigger On - docs are missing, stale, duplicated, or hard to navigate - a repo needs a cleaner source-of-truth structure - durable engineering guidance needs to be added without bloating pages ## Value - produce a concrete project delta: code, docs, config, tests, CI, or review artifact - reduce ambiguity through explicit planning, verification, and final validation skills - leave reusable project context so future tasks are faster and safer ## Do Not Use For - writing a specific feature spec or ADR when that skill already fits - dumping large template content into public pages ## Inputs - current docs structure and entry pages - the code, policy, or workflow that the docs should reflect - duplicate or conflicting sources of truth ## Quick Start 1. Read the nearest `AGENTS.md` and confirm scope and constraints. 2. Run this skill's `Workflow` through the `Ralph Loop` until outcomes are acceptable. 3. Return the `Required Result Format` with concrete artifacts and verification evidence. ## Workflow 1. Decide the canonical location for each fact before writing. 2. Prefer navigational docs that link to detail instead of copying detail. 3. Keep bootstrap pages small; move workflow scaffolds into skills. 4. Update stale docs in the same change as the code or policy they describe. ## Deliver - cleaner docs structure - better source-of-truth placement - docs that reflect the code and workflow that actually exist ## Validate - each durable fact has one clear home - entry pages route the reader correctly - pages do not bloat with template or reference dumps - docs match the real repo, not the intended future repo ## Ralph Loop Use the Ralph Loop for every task, including docs, architecture, testing, and tooling work. 1. Brainstorm first (mandatory): - analyze current state - define the problem, target outcome, constraints, and risks - generate options and think through trade-offs before committing - capture the recommended direction and open questions 2. Plan second (mandatory): - write a detailed execution plan from the chosen direction - list final validation skills to run at the end, with order and reason 3. Execute one planned step and produce a concrete delta. 4. Review the result and capture findings with actionable next fixes. 5. Apply fixes in small batches and rerun the relevant checks or review steps. 6. Update the plan after each iteration. 7. Repeat until outcomes are acceptable or only explicit exceptions remain. 8. If a dependency is missing, bootstrap it or return `status: not_applicable` with explicit reason and fallback path. ### Required Result Format - `status`: `complete` | `clean` | `improved` | `configured` | `not_applicable` | `blocked` - `plan`: concise plan and current iteration step - `actions_taken`: concrete changes made - `validation_skills`: final skills run, or skipped with reasons - `verification`: commands, checks, or review evidence summary - `remaining`: top unresolved items or `none` For setup-only requests with no execution, return `status: configured` and exact next commands. ## Load References - read [references/documentation.md](references/documentation.md) for structure and documentation-quality guidance ## Example Requests - "Clean up this docs mess." - "Move process clutter out of public pages." - "Make the repo docs navigable for an agent."
Build, debug, modernize, or review ASP.NET Core applications with correct hosting, middleware, security, configuration, logging, and deployment patterns on current .NET. USE FOR: working on ASP.NET Core apps, services, or middleware; changing auth, routing, configuration, hosting, or deployment behavior; deciding between ASP.NET Core sub-stacks. DO NOT USE FOR: unrelated stacks; generic tasks that do not need this specific guidance. INVOKES: inspect the repository context, edit targeted files, and run relevant build, test, lint, or validation commands when changes are made.
Build, upgrade, and operate .NET Aspire 13.3.x application hosts with current CLI, AppHost, ServiceDefaults, integrations, dashboard, testing, and Azure deployment patterns for distributed apps. USE FOR: Aspire.AppHost.Sdk, Aspire.Hosting.*, DistributedApplication.CreateBuilder, WithReference, WaitFor, AddProject, AddRedis, AddPostgres, aspire run, aspire init, aspire. DO NOT USE FOR: unrelated stacks; generic tasks that do not need this specific guidance. INVOKES: inspect the repository context, edit targeted files, and run relevant build, test, lint, or validation commands when changes are made.
Build, review, or migrate Azure Functions in .NET with correct execution model, isolated worker setup, bindings, DI, and Durable Functions patterns. USE FOR: working on Azure Functions in .NET; migrating from the in-process model to the isolated worker model; adding Durable Functions, bindings, or host configuration. DO NOT USE FOR: unrelated stacks; generic tasks that do not need this specific guidance. INVOKES: inspect the repository context, edit targeted files, and run relevant build, test, lint, or validation commands when changes are made.
Build and review Blazor applications across server, WebAssembly, web app, and hybrid scenarios with correct component design, state flow, rendering, and hosting choices. USE FOR: building interactive web UIs with C# instead of JavaScript; choosing between Server, WebAssembly, or Auto render modes; designing component hierarchies and state. DO NOT USE FOR: unrelated stacks; generic tasks that do not need this specific guidance. INVOKES: inspect the repository context, edit targeted files, and run relevant build, test, lint, or validation commands when changes are made.
Maintain or migrate EF6-based applications with realistic guidance on what to keep, what to modernize, and when EF Core is or is not the right next step. USE FOR: EF6 codebases; runtime versus ORM migration decisions; EDMX, code-first, ObjectContext, and legacy data-access review. DO NOT USE FOR: unrelated stacks; generic tasks that do not need this specific guidance. INVOKES: inspect the repository context, edit targeted files, and run relevant build, test, lint, or validation commands when changes are made.
Design, tune, or review EF Core data access with proper modeling, migrations, query translation, performance, and lifetime management for modern .NET applications. USE FOR: DbContext, migrations, model configuration, EF queries, tracking, loading, performance, transactions, and EF6 migration decisions. DO NOT USE FOR: unrelated stacks; generic tasks that do not need this specific guidance. INVOKES: inspect the repository context, edit targeted files, and run relevant build, test, lint, or validation commands when changes are made.
Build, review, or migrate .NET MAUI applications across Android, iOS, macOS, and Windows with correct cross-platform UI, platform integration, and native packaging assumptions. USE FOR: working on cross-platform mobile or desktop UI in .NET MAUI; integrating device capabilities, navigation, or platform-specific code; migrating Xamarin.Forms or aligning. DO NOT USE FOR: unrelated stacks; generic tasks that do not need this specific guidance. INVOKES: inspect the repository context, edit targeted files, and run relevant build, test, lint, or validation commands when changes are made.
Use ML.NET to train, evaluate, or integrate machine-learning models into .NET applications with realistic data preparation, inference, and deployment expectations. USE FOR: ML.NET integration; local model training or retraining; inference pipelines, model loading, evaluation, and deployment review. DO NOT USE FOR: unrelated stacks; generic tasks that do not need this specific guidance. INVOKES: inspect the repository context, edit targeted files, and run relevant build, test, lint, or validation commands when changes are made.