Quick Start Guide¶
Get up and running with CMS Planner in minutes. This guide walks you through generating your first Functional Requirements Document.
Basic Usage¶
1. Run the Command¶
In your project directory, run:
2. Answer Discovery Questions¶
Claude will guide you through project discovery by asking about:
Business & Users - What are your business objectives? - Who are your target users? - What success metrics matter?
Technical - What platform/framework? (Drupal, WordPress, custom) - Any technical constraints or preferences? - Architecture patterns? (recipe-based, microservices, monolithic) - Required integrations?
Team & Timeline - How many developers? - Estimated sprint velocity? - Target launch date? - Budget considerations?
Scope - What features are must-have vs nice-to-have? - MVP vs future phases? - Compliance or regulatory requirements?
3. Review Generated Files¶
CMS Planner creates two files:
1. Functional Requirements Document (docs/functional-requirements.md)
# Functional Requirements Document: [Project Name]
## Executive Summary
- Vision, objectives, scope
- Business value, target launch
## Technical Requirements
- Platform & architecture
- Tech stack with justifications
- Dependencies, integrations
## Functional Requirements
- FR-001: Feature Name [PRIORITY]
- User stories
- Acceptance criteria
- Story point estimates
## Implementation Plan
- Phase 1: [Name] [X points]
- Epic 1: [Name] [X points]
- Story 1: [Name] [X points]
...
2. Teamwork CSV Backlog ([project-name]-backlog-teamwork.csv)
Tasklist,Task,Description,Priority,Tags,Status
"Phase 1","[EPIC] Setup [21 points]","...",high,"SP-21,Phase-1",Active
"Phase 1","- [STORY] Repository [5 points]","...",high,"SP-5,Phase-1",Active
...
Example: Drupal Healthcare Site¶
Command¶
Inline Answers¶
I need to build a healthcare website for a hospital system.
**Platform**: Drupal CMS 2.0+ with recipe-based architecture
**Target**: DrupalCon Chicago launch (Feb 2026)
**Features**: Provider directory, services, locations, events, news, alerts
**Team**: 3 developers, ~28 points/sprint velocity
**Compliance**: WCAG 2.2 Level AA, HIPAA-aware (no PHI)
**Architecture**: Recipe-based using Saplings collection + Vital site template
Generated Output¶
FRD Structure: - Executive Summary with DrupalCon target - Technical Requirements (Drupal CMS 2.0+, recipe architecture) - 8 Functional Requirements (FR-001 through FR-008 for each recipe) - Recipe dependency diagram in appendix - Shared field storage matrix in appendix - 8 implementation phases totaling 720 story points - Risk assessment for recipe dependencies - Success criteria (functional, technical, business)
CSV Backlog: - 31 epics organized by 8 phases - Phase tags (Phase-1, Phase-2, etc.) - Story point tags (SP-21, SP-34, etc.) - Complete descriptions with acceptance criteria - Ready for Teamwork import
Example: WordPress Theme¶
Command¶
Inline Answers¶
Building a custom WordPress theme for a marketing agency.
**Platform**: WordPress 6.4+ with block editor
**Features**:
- Custom block patterns
- Dynamic homepage builder
- Portfolio showcase
- Blog with custom post types
- Contact forms
- SEO optimization
**Team**: 2 developers, part-time (15 points/sprint)
**Timeline**: 3 months
**Design**: Figma designs provided
Generated Output¶
FRD includes: - WordPress-specific technical requirements - Theme structure and block patterns - Custom post types and taxonomies - ACF or Gutenberg block specifications - Performance requirements (Core Web Vitals) - Browser compatibility matrix - Implementation phases - Story point estimates
Pro Tips¶
Provide Context Upfront¶
Instead of answering questions one-by-one, provide comprehensive context:
/functional-requirements
I'm building [project type] with these details:
- Platform: [specific versions]
- Features: [bulleted list]
- Team: [size and velocity]
- Timeline: [target date]
- Architecture: [pattern]
- Integrations: [list]
Claude will acknowledge what you've provided and only ask about missing information.
Use Existing Documentation¶
If your project has existing docs:
/functional-requirements
Please review:
- README.md for project overview
- docs/architecture.md for technical decisions
- docs/content-model.md for data structures
Then generate FRD based on these + my answers to your questions.
Specify Output Location¶
/functional-requirements
Save FRD to docs/requirements/functional-requirements.md
Save CSV to planning/backlog-import.csv
Request Specific Focus¶
/functional-requirements
Focus on recipe-based architecture with:
- Detailed shared field storage documentation
- Recipe dependency diagram
- Installation order requirements
- Demo content integration
Common Workflows¶
New Project Planning¶
- Run
/functional-requirements - Answer discovery questions
- Review and refine FRD
- Import CSV to Teamwork
- Review backlog with team
- Begin sprint planning
Existing Project Documentation¶
- Gather existing docs (README, architecture, etc.)
- Run
/functional-requirementswith context - Claude analyzes existing work
- Generates FRD documenting current state + future plans
- Export backlog for remaining work
Client Proposal¶
- Run
/functional-requirementswith high-level requirements - Focus on executive summary and business value
- Include MVE (Minimum Viable Experience) vs full feature set
- Use story points to estimate timeline and budget
- Present FRD to client for feedback
Understanding Output¶
Story Points¶
Points represent complexity, not time directly:
- 1-3 points: Can be completed within a day
- 5-8 points: Multi-day tasks requiring integration
- 13 points: Week-long epic, should be broken down
- 21+ points: Multi-week epic, must be decomposed
Phases¶
Implementation organized into logical phases:
- Phase 1: Usually foundation/setup (environment, dependencies)
- Phase 2-N: Feature development phases
- Final Phase: Often polish, testing, launch prep
CSV Import¶
To import CSV into Teamwork:
- Open Teamwork project
- Navigate to Tasks
- Click Import
- Upload CSV file
- Map columns (usually auto-detected)
- Review and confirm import
See Teamwork CSV Import Guide for details.
Next Steps¶
- Recipe Projects Guide - Drupal recipe support
- Story Point Estimation - Detailed estimation guide
- Teamwork Import - CSV import instructions
- Command Reference - Full command documentation
Troubleshooting¶
FRD Too Generic¶
Provide more specific details: - Exact platform versions - Specific architecture patterns - Technical constraints - Integration requirements
Story Points Seem Off¶
Calibrate with your team: - Review velocity history - Adjust multiplier in sprint calculation - Consider team experience level - Account for part-time resources
CSV Format Issues¶
Verify format matches Teamwork requirements: - Column headers must match exactly - Use proper hierarchy prefixes (-, --, ---) - Tags format: SP-X,Phase-X (comma-separated) - Status must be "Active"
Getting Help¶
- Documentation: https://kanopi.github.io/cms-planner/
- GitHub Issues: https://github.com/kanopi/cms-planner/issues
- Email: code@kanopi.com