project-documentation

name: project_documentation description: Standardized templates and workflows for creating comprehensive Project Logic documentation and Product Plans.

Project Documentation Skill

Use this skill when asked to document the codebase, explain project logic, or plan a new product/feature.

1. Project Logic Documentation (PROJECT_LOGIC.md)

Goal: Explain how the project works to a developer or architect.

Template Structure:

1. High-Level Architecture:
   • Mermaid diagram showing the flow of data between components (Agents, Frontend, Backend, Database).
2. Core Components:
   • Detailed breakdown of key modules (e.g., orchestrator, data_pipeline, ui).
   • Explain the responsibility of each file/module.
3. Data Flow:
   • Step-by-step walkthrough of a primary user action (e.g., "User clicks 'Analyze' -> Request hits API -> Agent starts -> Result returned").
4. Key Decisions:
   • Why specific technologies or patterns were chosen.

2. Product Plan (PRODUCT_PLAN.md)

Goal: Define what to build and why.

Template Structure:

1. North Star:
   • The single critical metric or vision statement (e.g., "Make daily consistency effortless").
2. MVP Scope:
   • The non-negotiable "Must-Haves" for the first release. Be ruthless in cutting scope.
3. User Experience (UX/IA):
   • Key screens and user journey map.
4. V1 / Future Enhancements:
   • Features to add after the MVP is successful.