Documentation

Documentation. Use when writing docs or reviewing documentation. Use when this capability is needed.

tomevault-io Updated

File contents

Documentation

This skill provides documentation guidelines and standards.

See @REFERENCE.md for detailed documentation.

Quick Reference

  • README: Installation, quick start, config, commands
  • CHANGELOG: Keep a Changelog format
  • ADR: Architecture Decision Records for major choices
  • Code: Comments explain WHY, not WHAT
  • API: OpenAPI/Swagger specs

Converted and distributed by TomeVault — claim your Tome and manage your conversions.

tomevault-io/skills-registry/tree/main/thebeardedbearsas--claude-craft--documentation commit d052c400b1

Frequently asked questions

npx skillmds@latest add tomevault-io/documentation-88