paw-docs-guidance

What problem does it solve?

This skill establishes consistent PAW project documentation by providing a Docs.md template, guidelines for include/exclude content, and update patterns that align with PAW workflows.

Core Features & Use Cases

• Docs.md Template: Provides a canonical structure for project documentation (Overview, Architecture and Design, User Guide, API Reference, Testing, Future Work).
• Guidelines for Include/Exclude: Helps teams determine what documentation to capture at each phase and what to omit from the main docs.
• Project Documentation Updates: Prescribes patterns for updating Docs.md as implementations evolve, ensuring traceability and clarity.
• Use Case: When starting a PAW project, engineers generate a Docs.md from the template and tailor sections to reflect architecture decisions and implementation plans.

Quick Start

Create a Docs.md at the root of your PAW skill project and populate it using the provided template. Follow the include/exclude guidelines to keep documentation focused and up to date.