Skill page Architecture v1.0.0

MCAF: Documentation

Apply MCAF documentation guidance for docs structure, navigation, source-of-truth placement, and writing quality. Use when a repo’s docs are missing, stale, duplicated, or hard to navigate, or when adding new durable engineering guidance.

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

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

Load References

Related skills

v1.0.0

Apply MCAF feature-spec guidance to create or update a feature spec under `docs/Features/` with business rules, user flows, system behaviour, verification, and Definition of Done.

dotnet skills install mcaf-feature-spec