skills.rest
lossyrob
lossyrobCOMMUNITY
Explore all skills by this author →
𝕏@lossyrobGitHub

paw-docs-guidance

Generate standardized PAW project documentation using a Docs.md template.

39|6|Updated Oct 8, 2025
Search Tags:#template#architecture#documentation#guidelines#user-guide#Docs.md#PAW
One-click install
npx skills add https://github.com/lossyrob/phased-agent-workflow --skill paw-docs-guidance
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: paw-docs-guidance
Source: https://github.com/lossyrob/phased-agent-workflow/tree/main/skills/paw-docs-guidance
Command: npx skills add https://github.com/lossyrob/phased-agent-workflow --skill paw-docs-guidance

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about paw-docs-guidance

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
What is a Docs.md template and why do I need it for PAW project documentation?▼

To create a Docs.md for a PAW project, place the file at the project root and populate it using the provided template, tailoring sections like Architecture and Design to reflect your specific implementation decisions and plans.

What documentation guidelines should I follow to decide what to include or exclude from my project docs?▼

Documentation guidelines for PAW workflows help teams determine what to capture at each implementation phase and what to omit from the main Docs.md, keeping project documentation focused, clear, and properly aligned with ongoing architecture updates.

How do I update project documentation as my PAW implementation evolves?▼

Yes, PAW documentation governance applies across all implementation phases, guiding engineers on architecture, user guides, testing, and maintenance documentation to ensure consistent practices regardless of project scale or complexity.

What sections are required in a standardized PAW Docs.md file?▼

A standardized PAW Docs.md requires sections for Overview, Architecture and Design, User Guide, API Reference, Testing, and Future Work. These sections ensure comprehensive coverage of project documentation from initial design through maintenance.

Related Skills

Explore More Software Engineering Skills→
lossyroblossyrob
39

paw-init

Initialize PAW project structure, WorkflowContext.md, and a Git branch.

Community
Basic
lossyroblossyrob
39

paw-workflow

Reference PAW workflow rules and artifact structures across implementation phases.

Community
Basic
keodubokeodubo
9

paw-tp-final-migration

Migrate PAW projects from MVC to REST API and SPA architectures.

Community
Advanced
lgzarturolgzarturo

Astro SEO Validator

Validate Astro SEO standards and generate a Markdown report.

Community
Advanced