Documentation

Write accurate user, operator, API, and architecture documentation grounded in the implemented product.

nafeeur d949a2c 675 B Updated

File contents

Documentation

  • Verify every command, path, configuration key, and default against the code.
  • Lead with the shortest successful path, then cover providers, workspaces, MCP, skills, troubleshooting, and deployment.
  • Use diagrams for ownership and data flow, not decorative complexity.
  • Distinguish built-in, auto-discovered, credential-gated, and optional capabilities.
  • Include failure symptoms and diagnostic commands users can actually run.
  • Remove aspirational claims that the current implementation does not support.

nafeeur/MaskShift/tree/main/skills/documentation commit d949a2cd1d

Frequently asked questions

npx skillmds@latest add nafeeur/documentation