universal-planner
npx skills add https://github.com/synapsync/synapse_registry --skill universal-planner
Agent 安装分布
Skill 文档
Universal Planner
Purpose
Produce professional, structured planning documentation for any software engineering scenario. This skill adapts its workflow, depth, and output structure based on the type of work â from full SDLC documentation for a new product idea to a focused root-cause analysis and fix plan for a bug.
It replaces the need for separate planning skills by detecting the planning mode from the user’s input and activating only the relevant workflow phases.
Critical Rules
RULE 1 â PLANNING ONLY: NEVER EXECUTE
This skill produces documentation only. It MUST NOT implement, code, build, deploy, or carry out any task defined in the plan. Once all planning documents are complete, summarize what was produced and stop. Execution is a separate responsibility.
RULE 2 â CONTEXT-FIRST: RESPECT EXISTING PATTERNS
Before making any planning decision on an existing codebase, this skill MUST explore and understand the project’s established patterns, conventions, and architecture. Every proposal MUST align with what already exists. When something genuinely new is needed, the deviation must be explicitly documented and justified â never silently introduced.
This rule does not apply to NEW_PROJECT mode (there is no existing codebase to discover).
RULE 3 â ADAPTIVE MODE DETECTION
Detect the planning mode from the user’s input (see Mode Detection below). If the mode is ambiguous, ask the user. Never force a mode that doesn’t match the scenario â the wrong mode produces irrelevant documentation.
RULE 4 â PROFESSIONAL QUALITY
Output must read as if produced by a senior engineering team. Avoid vague language, placeholder text, or generic filler. Every statement must be specific to the project. Quantify non-functional requirements. Use Mermaid diagrams for architecture, data models, and flows. Use ADR format for architecture decisions.
RULE 5 â COMPLETENESS
Generate ALL documents required by the active mode. No file should be skipped or left empty. Each file must contain substantive, meaningful content specific to the project. Verify completeness before handoff.
RULE 6 â ASSUMPTION TRANSPARENCY
When information is missing or vague, infer reasonable defaults and document every assumption in the analysis. Never silently assume technical decisions. The development team must be able to validate all assumptions before implementation begins.
Planning Modes
Mode Detection
Detect the mode from the user’s input using these signals:
| Mode | Signals | Example Inputs |
|---|---|---|
| NEW_PROJECT | Product idea, app concept, “build from scratch”, no existing codebase | “I need an app to track expenses”, “Build a SaaS for team scheduling” |
| NEW_FEATURE | Adding functionality to existing project, “add”, “implement”, “create” within existing codebase | “Add dark mode to the app”, “Implement payment integration” |
| REFACTOR | Restructure, reorganize, migrate patterns, improve architecture of existing code | “Refactor the auth module”, “Migrate from Redux to Zustand” |
| BUG_FIX | Fix, issue, broken, regression, error, not working | “Fix the login timeout bug”, “Users can’t submit forms on mobile” |
| TECH_DEBT | Cleanup, dead code, outdated, deprecated, missing tests, duplication | “Clean up the orders module”, “Reduce tech debt in the API layer” |
| ARCHITECTURE | System design, architecture evolution, scaling, infrastructure change | “Design the microservices migration”, “Plan the monorepo restructure” |
Mode Capabilities Matrix
| Document | NEW_PROJECT | NEW_FEATURE | REFACTOR | BUG_FIX | TECH_DEBT | ARCHITECTURE |
|---|---|---|---|---|---|---|
| README.md | Yes | Yes | Yes | Yes | Yes | Yes |
| discovery/CONVENTIONS.md | â | Yes | Yes | Yes | Yes | Yes |
| requirements/* (7 files) | Yes | â | â | â | â | â |
| design/* (6 files) | Yes | â | â | â | â | Yes |
| analysis/ANALYSIS.md | Yes | Yes | Yes | Yes | Yes | Yes |
| planning/PLANNING.md | Yes | Yes | Yes | Yes | Yes | Yes |
| execution/EXECUTION.md | Yes | Yes | Yes | Yes | Yes | Yes |
| sprints/PROGRESS.md | Yes | Yes | Yes | Yes | Yes | Yes |
| sprints/SPRINT-*.md | Yes | Yes | Yes | Yes | Yes | Yes |
Output Structure
All output goes into .synapsync/planning/{project-name}/.
.synapsync/planning/{project-name}/
âââ README.md # Project overview and document navigation
â
âââ discovery/ # Codebase Discovery (all modes except NEW_PROJECT)
â âââ CONVENTIONS.md # Existing patterns, components, conventions
â
âââ requirements/ # SDLC Phase 1 (NEW_PROJECT only)
â âââ problem-definition.md # Problem statement and value proposition
â âââ goals-and-metrics.md # SMART goals and KPIs
â âââ stakeholders-and-personas.md # User personas and stakeholder map
â âââ functional-requirements.md # MoSCoW-prioritized requirements
â âââ non-functional-requirements.md # Performance, security, scalability targets
â âââ assumptions-and-constraints.md # Inferred assumptions and known constraints
â âââ out-of-scope.md # Excluded features and boundary definitions
â
âââ design/ # System Design (NEW_PROJECT + ARCHITECTURE)
â âââ system-overview.md # System context and technology recommendations
â âââ architecture-decisions.md # ADRs for key decisions
â âââ high-level-architecture.md # Component diagram and communication patterns
â âââ data-model.md # Entity relationships and storage strategy
â âââ core-flows.md # Sequence diagrams for critical flows
â âââ non-functional-design.md # Performance, security, and scalability design
â
âââ analysis/ # Analysis (all modes â content adapts per mode)
â âââ ANALYSIS.md
â
âââ planning/ # Strategy (all modes)
â âââ PLANNING.md
â
âââ execution/ # Concrete task breakdown (all modes)
â âââ EXECUTION.md
â
âââ sprints/ # Sprint tracking (all modes)
âââ PROGRESS.md # Master progress dashboard
âââ SPRINT-{N}-{name}.md # Detailed sprint plans with checkboxes
Naming Convention
Use kebab-case for {project-name}, inferred from the user’s input:
- “expense tracker app” â
expense-tracker - “Refactor the auth module” â
refactor-auth-module - “Fix login timeout bug” â
fix-login-timeout - “CI/CD pipeline manager” â
cicd-pipeline-manager
Shared Workflow Steps
These steps are shared across all modes. Mode-specific steps are documented in the next section.
Step: Codebase Discovery (all modes except NEW_PROJECT)
Before any planning begins, explore the existing project to understand its patterns, architecture, and conventions. This step is non-negotiable.
Deliverable: discovery/CONVENTIONS.md
What to explore:
- Project Structure: Folder organization, module boundaries, monorepo vs single-app
- UI Patterns (if applicable): Component library, design system, reusable components, styling approach, design tokens
- Backend Patterns (if applicable): API structure, error handling, middleware, service/repository layers, validation
- State Management: How the app manages state
- Data Layer: ORM/database patterns, migration conventions, model definitions
- Naming Conventions: File naming, variable naming, component naming, route naming
- Testing Patterns: Framework, file location, mocking approach, coverage expectations
- Shared Utilities: Existing helpers, hooks, services, and abstractions already available
- Dependencies & Tooling: Key libraries in use, build tools, linters, formatters
Output format:
# Project Conventions: {Project Name}
## Architecture
- Pattern: [e.g., Feature-based modules, MVC, Clean Architecture]
- Key directories: [e.g., src/features/, src/shared/, src/core/]
## UI Components (if applicable)
- Design system: [e.g., Custom components in src/components/ui/]
- Key components: [e.g., Button, FormField, Modal â with paths]
- Styling: [e.g., Tailwind CSS with tokens in tailwind.config.ts]
## Backend Patterns (if applicable)
- API style: [e.g., REST with Express routers in src/routes/]
- Error handling: [e.g., Custom AppError class in src/utils/errors.ts]
- Validation: [e.g., Zod schemas in src/schemas/]
## State Management
- Approach: [e.g., Zustand stores in src/stores/]
## Naming Conventions
- Files: [e.g., kebab-case for files, PascalCase for components]
- Functions: [e.g., camelCase, verbs for actions]
## Testing
- Framework: [e.g., Vitest + Testing Library]
- Location: [e.g., __tests__/ adjacent to source]
## Shared Utilities
- [List key reusable modules with paths]
## Key Dependencies
- [List critical libraries and their purpose]
IMPORTANT: Every subsequent document MUST reference CONVENTIONS.md. If a planning decision conflicts with an established convention, it must be explicitly called out and justified.
Step: Analysis
Investigate and document what you need to build or change. The analysis content adapts per mode (see Mode-Specific Workflows below).
Deliverable: analysis/ANALYSIS.md
Common sections (all modes):
- Executive Summary: What are we doing and why?
- Current State Assessment: What exists today?
- Conventions Reference (if applicable): Which existing patterns are relevant
- Technical Analysis: Technologies, tools, architectural implications
- Constraints & Risks: Limitations, risks with probability and mitigation
- Success Criteria: How we measure done
Step: Planning
Define the implementation strategy based on analysis findings. All proposals must align with CONVENTIONS.md (when applicable).
Deliverable: planning/PLANNING.md
Common sections (all modes):
- Implementation Strategy: High-level approach â how it fits within existing architecture
- Conventions Alignment (if applicable): Patterns to reuse, justified deviations
- Execution Phases: Major milestones with name, description, objectives, deliverables, dependencies
- Resource Plan: Who/what is needed
- Risk Mitigation: Handling identified risks
Step: Execution Plan
Define concrete tasks structured by phase. Each task specifies which existing patterns/components to use.
Deliverable: execution/EXECUTION.md
Common sections (all modes):
- Execution Overview: Summary of phases
- Phase Breakdown: For each phase â objectives, tasks, success criteria
- Resource Allocation: Task ownership
- Risk Monitoring: Ongoing risk assessment
Task format requirement: Every task in the execution plan must follow the standard task structure (see Sprint Structure Standards below).
Step: Sprint Plans (Optional)
Before generating sprint documents, ASK the user:
“The analysis, planning, and execution plan are complete. Do you want me to generate the sprint tracking documents (PROGRESS.md and SPRINT-*.md files) now, or would you prefer to stop here and generate them later with
universal-planner-executor?”
- If the user says yes â Generate
sprints/PROGRESS.md+sprints/SPRINT-{N}-{name}.mdfollowing the Sprint Structure Standards below. - If the user says no â Skip sprint generation and proceed directly to Handoff. The user can later use
universal-planner-executorto generate sprints from the execution plan.
Deliverables (when generated): sprints/PROGRESS.md + sprints/SPRINT-{N}-{name}.md
See Sprint Structure Standards for format specifications.
Step: Handoff
Summarize all produced documents and their locations. Indicate the plan is ready for execution. This skill STOPS here.
Mode-Specific Workflows
NEW_PROJECT Mode
For building a product from scratch. Produces the most comprehensive documentation.
Workflow: Analyze Idea â Requirements â System Design â Analysis â Planning â Execution â Sprints â Handoff
Additional Step: Adaptive Architecture Detection
Before writing documentation, detect the product domain and adapt:
| Domain | Typical Architecture |
|---|---|
| Web app | SPA/SSR + REST/GraphQL API + Database |
| Mobile app | Native/Cross-platform + Backend API + Push notifications |
| Backend/API | Microservices or monolith + Message queues + Database |
| CLI tool | Single binary + Config files + Local storage |
| CI/CD pipeline | Pipeline stages + Artifact registry + Environment configs |
| Data platform | ETL pipelines + Data warehouse + Analytics layer |
| IoT system | Edge devices + Gateway + Cloud backend + Telemetry |
| Desktop app | Native UI framework + Local DB + Optional cloud sync |
| Browser extension | Content/background scripts + Popup UI + Storage API |
| SaaS platform | Multi-tenant architecture + Auth + Billing + API |
| E-commerce | Storefront + Cart/Checkout + Payment + Inventory |
| Real-time system | WebSockets/SSE + Event bus + State synchronization |
Additional Step: Requirements Analysis (7 files in requirements/)
Generate all 7 requirement files. See Requirements Specifications below.
Additional Step: System Design (6 files in design/)
Generate all 6 design files. See Design Specifications below.
Analysis adapts to: Product feasibility, technology selection, resource assessment, market analysis.
Scale adaptation:
| Scale | Indicators | Depth |
|---|---|---|
| Small | Personal tool, single user, simple domain | 2 personas, 3-4 ADRs, simpler architecture |
| Medium | Team tool, multiple user types, integrations | 3 personas, 5-6 ADRs, standard architecture |
| Large | Platform, multi-tenant, complex domain | 4+ personas, 7+ ADRs, detailed architecture |
NEW_FEATURE Mode
For adding functionality to an existing project.
Workflow: Discovery â Analysis â Planning â Execution â Sprints â Handoff
Analysis adapts to:
- Feature architecture and component breakdown
- Integration points with existing modules
- Data flow and interface definitions
- Dependencies on existing code and shared utilities
Recommended sprint structure:
- Sprint 1: Setup â scaffolding, models, interfaces
- Sprint 2: Core â business logic, services
- Sprint 3: UI/Integration â components, views, integration
- Sprint 4: Testing â unit, e2e, polish
REFACTOR Mode
For restructuring existing code without changing behavior.
Workflow: Discovery â Analysis â Planning â Execution â Sprints â Handoff
Analysis adapts to:
- Current vs target architecture comparison
- Code duplication identification (percentage where possible)
- Architectural inconsistencies and pattern violations
- Folder responsibility definitions (what SHOULD go where vs what IS where)
- Missing abstractions or over-engineering
- Dependency issues (circular, incorrect layering)
Recommended sprint structure:
- Sprint 1: Cleanup â delete legacy code, consolidate duplicates
- Sprint 2: Migration â state/architecture migration
- Sprint 3: Extraction â logic extraction and pattern enforcement
- Sprint 4: Verification â testing and documentation
BUG_FIX Mode
For investigating and planning a fix for a specific issue.
Workflow: Discovery â Analysis â Planning â Execution â Sprints â Handoff
Analysis adapts to:
- Root Cause Analysis: Trace the bug to its source, identify all affected code paths
- Impact Assessment: Severity (Critical/High/Medium/Low), affected features/users, regression risk
- Solution Design: Proposed fix approach, alternative solutions, trade-offs
- Test Cases: Verification tests and regression prevention tests
Recommended sprint structure:
- Sprint 1: Investigation â reproduce, trace, identify root cause
- Sprint 2: Implementation â implement fix, refactor if needed
- Sprint 3: Verification â test, review, deploy
TECH_DEBT Mode
For reducing technical debt in an existing codebase.
Workflow: Discovery â Analysis â Planning â Execution â Sprints â Handoff
Analysis adapts to:
- Debt Inventory: Dead code, deprecated dependencies, outdated patterns, code duplication, missing tests, documentation gaps
- Impact vs Effort Matrix: Categorize items as Quick Wins (high impact, low effort), Critical Fixes, Strategic Improvements, Nice-to-Have
- Prioritization: Ordered by impact on maintainability, developer experience, and risk
- Modernization Path: Patterns to migrate to, dependencies to update, code to sunset
Recommended sprint structure:
- Sprint 1: Quick Wins â easy fixes with high impact
- Sprint 2: Cleanup â delete dead code, consolidate duplicates
- Sprint 3: Modernization â update patterns, upgrade dependencies
- Sprint 4: Testing â add missing test coverage
ARCHITECTURE Mode
For evolving system architecture or planning major structural changes.
Workflow: Discovery â System Design â Analysis â Planning â Execution â Sprints â Handoff
Additional Step: System Design (6 files in design/)
Same as NEW_PROJECT, but for an existing system. The design documents describe the target architecture, while CONVENTIONS.md documents the current architecture.
Analysis adapts to:
- Current vs target architecture gap analysis
- Migration path and backwards compatibility strategy
- Risk assessment for each architectural change
- Feature flag and rollback strategies
- Data migration requirements
Recommended sprint structure:
- Sprint 1: Foundation â infrastructure, base patterns, feature flags
- Sprint 2: Migration â core component migration
- Sprint 3: Integration â reconnect migrated components
- Sprint 4: Cleanup â remove legacy code, feature flags, verification
Requirements Specifications (NEW_PROJECT mode)
problem-definition.md
| Section | Content |
|---|---|
| Problem Statement | 2-3 paragraphs describing the problem in concrete terms |
| Current Alternatives | How users solve this today and why those solutions fall short |
| Proposed Solution | High-level description of what the product will do |
| Value Proposition | Why this solution is better than alternatives |
goals-and-metrics.md
| Section | Content |
|---|---|
| Primary Goals | 3-5 measurable goals using SMART criteria |
| Success Metrics | Specific KPIs with target values |
| Timeline Goals | MVP, v1.0, and long-term milestones |
| Business Impact | Expected outcomes for stakeholders |
stakeholders-and-personas.md
| Section | Content |
|---|---|
| Stakeholders | Table: role, interest, influence level |
| User Personas | 2-4 detailed personas: name, role, goals, pain points, tech proficiency |
| User Journey Summary | High-level journey per persona |
functional-requirements.md
Use MoSCoW prioritization: Must Have, Should Have, Could Have, Won’t Have (this release).
| Section | Content |
|---|---|
| Requirements Table | ID, description, priority, persona |
| Feature Groups | Organize requirements into logical groups |
| Acceptance Criteria | 2-3 criteria per Must-Have requirement |
| Dependencies | Requirements that depend on other requirements |
non-functional-requirements.md
| Category | What to Specify |
|---|---|
| Performance | Response times, throughput, concurrent users |
| Scalability | Growth projections, horizontal/vertical scaling needs |
| Security | Authentication, authorization, encryption, compliance |
| Reliability | Uptime targets, disaster recovery, data backup |
| Usability | Accessibility standards, supported devices/browsers |
| Maintainability | Code standards, documentation, monitoring |
| Compatibility | Integration requirements, API versioning |
assumptions-and-constraints.md
| Section | Content |
|---|---|
| Technical Assumptions | Stack, infrastructure, third-party services assumed |
| Business Assumptions | Market, user behavior, budget assumptions |
| Constraints | Technical, legal, resource, and timeline constraints |
| Risks | Known risks with probability and mitigation |
This file is critical â it captures everything inferred from vague input.
out-of-scope.md
| Section | Content |
|---|---|
| Excluded Features | Features explicitly not included in this phase |
| Future Considerations | Features deferred to later phases with reasoning |
| Boundary Definitions | What the system will and won’t do |
Design Specifications (NEW_PROJECT + ARCHITECTURE modes)
system-overview.md
| Section | Content |
|---|---|
| System Context | Where this system sits in the larger ecosystem |
| Key Components | Major system components with one-line descriptions |
| Technology Recommendations | Suggested technologies with justification |
| System Boundaries | What the system controls vs delegates |
architecture-decisions.md
Document each key decision using ADR format:
### ADR-{N}: {Decision Title}
**Status:** Proposed
**Context:** {Why this decision is needed}
**Decision:** {What was decided}
**Alternatives Considered:**
- {Alternative 1}: {Why rejected}
- {Alternative 2}: {Why rejected}
**Consequences:** {Trade-offs and implications}
Include ADRs for: application architecture style, frontend framework (if applicable), database selection, authentication approach, API design style, hosting and deployment strategy.
high-level-architecture.md
| Section | Content |
|---|---|
| Architecture Diagram | Mermaid diagram showing major components |
| Component Descriptions | Each component’s responsibility, inputs, outputs |
| Communication Patterns | How components interact (sync, async, event-driven) |
| External Integrations | Third-party services and connections |
data-model.md
| Section | Content |
|---|---|
| Entity Descriptions | Each entity with attributes and descriptions |
| Relationships | Entity relationships with cardinality |
| ER Diagram | Mermaid ER diagram |
| Data Flow | How data moves through the system |
| Storage Strategy | Where different data types are stored and why |
core-flows.md
Document the 3-5 most critical flows using:
### Flow: {Flow Name}
**Actor:** {Who initiates}
**Trigger:** {What starts this flow}
**Preconditions:** {What must be true}
**Steps:**
1. {Step description}
2. {Step description}
**Postconditions:** {What is true after completion}
**Error Scenarios:** {What can go wrong and how to handle it}
Include a Mermaid sequence diagram for each flow.
non-functional-design.md
| Section | Content |
|---|---|
| Performance Design | Caching, CDN, query optimization, lazy loading |
| Security Design | Auth flow, encryption, input validation, CORS, rate limiting |
| Scalability Design | Load balancing, horizontal scaling, database sharding/replication |
| Monitoring & Observability | Logging, metrics, alerting, health checks |
| Error Handling | Global error strategy, retry policies, circuit breakers |
| Disaster Recovery | Backup strategy, failover, RTO/RPO targets |
Sprint Structure Standards
All sprint documents across all modes MUST follow these standards.
PROGRESS.md Format
# Progress: {Project Name}
## Executive Summary
{One paragraph describing the project and current status}
## Sprint Overview
| Sprint | Name | Status | Objectives |
|--------|------|--------|------------|
| 1 | {Name} | NOT_STARTED / IN_PROGRESS / COMPLETED | {One-line objective} |
| 2 | {Name} | NOT_STARTED / IN_PROGRESS / COMPLETED | {One-line objective} |
## Global Metrics
| Metric | Target | Current | Status |
|--------|--------|---------|--------|
| {Metric 1} | {Goal} | {Current} | NOT_STARTED / IN_PROGRESS / COMPLETED |
## Blockers & Issues
| Issue | Impact | Resolution | Status |
|-------|--------|------------|--------|
| {Issue} | {What it blocks} | {Mitigation} | OPEN / RESOLVED |
## Document Index
- [CONVENTIONS.md](../discovery/CONVENTIONS.md) (if applicable)
- [ANALYSIS.md](../analysis/ANALYSIS.md)
- [PLANNING.md](../planning/PLANNING.md)
- [EXECUTION.md](../execution/EXECUTION.md)
- Sprint plans: [Sprint 1](./SPRINT-1-{name}.md), [Sprint 2](./SPRINT-2-{name}.md), ...
SPRINT-{N}-{name}.md Format
# Sprint {N}: {Sprint Name}
**Duration:** {X-Y days}
**Objective:** {Clear one-line objective}
**Status:** NOT_STARTED | IN_PROGRESS | COMPLETED
**Dependencies:** {Prerequisites from other sprints}
---
## Phase {N}.1: {Phase Name}
**Objective:** {What this phase achieves}
### Prerequisites
- [ ] {Required items before starting}
### Tasks
#### Task {N}.1.1: {Task Description}
**File(s):** `{paths}`
**Convention:** {Which existing pattern/component to use, if applicable}
**Changes:**
```{language}
// BEFORE
{existing code}
// AFTER
{proposed code}
Steps:
- {N}.1.1.1 â {Specific action}
- {N}.1.1.2 â {Specific action}
Verification:
{command to verify task completion}
# Expected: {what should happen}
Phase {N}.2: Final Verification
Code Verifications
- {Verification 1}:
{command}â Expected: {result} - {Verification 2}:
{command}â Expected: {result}
Functional Verifications
- Build succeeds
- Tests pass
- Manual smoke test passes
Definition of Done
Sprint {N} is completed when:
- {Criterion 1}
- {Criterion 2}
- {Criterion N}
Risks
| Risk | Probability | Impact | Mitigation |
|---|---|---|---|
| {Risk 1} | High/Medium/Low | {Impact} | {Strategy} |
Rollback Strategy
{How to revert changes from this sprint if something goes wrong}
Notes
{Space for implementation notes during execution}
### Task Granularity
| Level | Name | Scope | Example |
|-------|------|-------|---------|
| L1 | Sprint | Major milestone (3-7 days) | "Sprint 1: Foundation Setup" |
| L2 | Phase | Logical grouping (0.5-2 days) | "Phase 1.1: Database Schema" |
| L3 | Task | Discrete work item (1-4 hours) | "Task 1.1.1: Create users table" |
| L4 | Subtask | Single action (5-30 min) | "1.1.1.1: Define column types" |
Every task must:
- Have a checkboxed action
- Include file paths when applicable
- Show before/after code snippets for changes
- Include a verification command
- Reference which existing patterns/components to use (when applicable)
---
## Critical Patterns
### Pattern 1: Planning Only â Never Execute
This skill MUST NOT begin implementing, coding, or deploying any planned task. Its output is strictly documentation. Once all documents are created, the skill's work is done.
**Bad**: Creating the plan and then starting to implement Phase 1 tasks
**Good**: Creating all documents, summarizing what was produced, then stopping
### Pattern 2: Respect Existing Patterns â Never Reinvent
Every planning decision on an existing codebase must align with established conventions. Before proposing any component, pattern, or approach, check what already exists.
**Bad**: "Create a new `<button>` element with custom CSS"
**Good**: "Use existing `Button` component from `src/components/ui/Button.tsx` with variant='primary'"
**Bad**: "Set up Redux for state management"
**Good**: "Use existing Zustand store pattern in `src/stores/` as the project already uses Zustand"
### Pattern 3: Justify Every Deviation
When something genuinely new IS needed, the plan must document:
1. **What exists today** and why it doesn't solve the problem
2. **What is proposed** as the new approach
3. **Why the deviation is justified** â concrete technical reasoning
4. **How it aligns** with the project's broader architecture
This goes in the **Conventions Alignment** section of PLANNING.md.
### Pattern 4: Adaptive Depth
Match documentation depth to project scale. A personal CLI tool doesn't need 4 user personas and 7 ADRs. A multi-tenant SaaS platform does. Infer scale from the user's input and adjust.
### Pattern 5: Specific Over Generic
Quantify everything. Measurable statements are testable; vague ones are not.
**Bad**: "The system must be scalable"
**Good**: "The system must handle 1,000 concurrent WebSocket connections with <100ms latency"
**Bad**: "Implement the feature"
**Good**: "Create API endpoint POST /api/v1/registrations with validation for email, password, and name"
### Pattern 6: Diagrams Over Prose
Use Mermaid diagrams for architecture, data models, and flows. Visual representations are faster to understand and less ambiguous than paragraph descriptions.
### Pattern 7: ADR Discipline
Document every significant architectural decision with context, alternatives considered, and consequences. Future team members need to understand the reasoning behind decisions.
### Pattern 8: Cross-Reference Consistency
Reference related documents using relative links. Never duplicate content across files. Every document should be navigable from the README.
### Pattern 9: Phase Dependencies
Always declare phase and sprint dependencies explicitly:
```markdown
### Phase 2: API Integration
**Dependencies**: Phase 1 (Foundation Setup) must be complete
**Blocks**: Phase 3 (Frontend Implementation)
Pattern 10: Task-to-Phase Mapping
Every task in a sprint must map back to an execution phase. No orphan tasks.
Configuration
Project Scale
| Scale | Sprint Count | Phase Count | Detail Level |
|---|---|---|---|
| Small (1-2 weeks) | 1-2 | 2-3 | Concise, fewer personas/ADRs |
| Medium (1 month) | 3-4 | 3-5 | Standard depth |
| Large (2+ months) | 5-8+ | 4-6+ | Comprehensive, detailed design |
Sprint Duration
- Weekly: Standard for most projects (recommended)
- Bi-weekly: For slower-moving or larger projects
- Align sprints with execution phases â each sprint should focus on completing 1-2 phases
Integration with Other Skills
| Skill | Integration |
|---|---|
code-analyzer |
Use before REFACTOR or TECH_DEBT mode to get a detailed technical report as input |
skill-creator |
Reference when building skills that complement planning outputs |
| Execution skills | Hand off all planning documents for implementation |
Troubleshooting
“Analysis is never-ending”
Set a hard scope boundary. Document unknowns as risks, not blockers. Move to planning with incomplete analysis if needed â the plan can account for investigation tasks.
“Plan proposes patterns that conflict with existing codebase”
Codebase Discovery was skipped or incomplete. Go back and create/update CONVENTIONS.md. Review every proposal against documented conventions.
“Not sure which mode to use”
Ask the user. If the work involves both a new feature and refactoring, use NEW_FEATURE mode and include refactoring as a phase within the execution plan.
“Input is too vague”
Make broader assumptions and document them prominently in ANALYSIS.md. For NEW_PROJECT mode, document in assumptions-and-constraints.md. Still generate all required files.
“Sprint todos get out of sync with execution phases”
Create sprint plans AFTER finalizing the execution plan. Map each sprint task to a specific execution phase. Review alignment before handoff.
“Tasks don’t fit into a single phase”
Cross-cutting concerns (testing, documentation, monitoring) should be tracked as support tasks within the sprint where they’re most relevant, or as a dedicated verification phase at the end of each sprint.
Limitations
- Planning only: Produces documentation, never executes
- Requires input: Cannot plan without a description of the work (however vague)
- Assumptions must be validated: Inferred decisions need team review before implementation
- Technology recommendations are suggestions: The development team makes final choices
- Manual tracking: Sprint progress must be updated manually during execution
- No automated validation: Cannot verify that plans match codebase reality â relies on thorough discovery
Version History
| Version | Date | Changes |
|---|---|---|
| 1.0 | 2026-02-04 | Initial release â unified from project-planner v1.2, sdlc-planner v1.0, and universal prompt templates |