Skip to content

Project Structure

Jump to bottom
iDorgham edited this page Nov 28, 2025 · 3 revisions

Project Structure Reference

Complete reference for the project structure generated by DoPlan CLI.

Generated Project Layout

When you run DoPlan CLI, it generates a complete project structure with all necessary files and directories.

my-project/
├── .cursor/
│   ├── agents/              # AI agent personas
│   ├── commands/            # Command definitions
│   └── rules/              # Rules library
│       ├── README.md       # Rules overview
│       └── library/        # Embedded rules (15 categories)
├── .plan/
│   ├── 00_System/          # Planning documents
│   ├── TASKS.md            # Implementation tasks
│   └── active_state.json   # Project state
├── .github/
│   └── workflows/          # GitHub Actions workflows
├── src/                    # Source code
├── CHANGELOG.md            # Version history
├── STANDUP.md              # Daily standup notes
├── README.md               # Project documentation
└── [IDE config files]     # IDE-specific configuration

Directory Explanations

.cursor/ - AI Configuration

Contains all AI-related configuration files.

.cursor/agents/

Purpose: AI agent persona definitions.

Contents:

  • 18 agent markdown files
  • Each file defines an agent's role, responsibilities, and behavior

Files:

  • project_orchestrator.md
  • product_manager.md
  • engineering_lead.md
  • system_architect.md
  • frontend_lead.md
  • backend_lead.md
  • devops_engineer.md
  • security_lead.md
  • performance_engineer.md
  • design_manager.md
  • ui_ux_designer.md
  • qa_manager.md
  • qa_engineer.md
  • release_manager.md
  • release_captain.md
  • growth_coach.md
  • documentation_lead.md
  • documentation_writer.md

Customization: Edit agent files to customize behavior.

.cursor/commands/

Purpose: Command definitions for slash commands.

Contents:

  • Command markdown files
  • Each file defines a command's trigger, action, and behavior

Files:

  • tell.md - Capture idea
  • improve.md - Brainstorm
  • write.md - Generate plans
  • change.md - Edit documents
  • good.md - Approve plan
  • tasks.md - Generate tasks
  • build.md - Start coding
  • progress.md - Track progress
  • finished.md - Complete task
  • team.md - Show agents
  • load.md - Inject context
  • ship.md - Release management
  • safe.md - Security audit
  • cheap.md - Cost optimization

Customization: Edit command files to customize behavior.

.cursor/rules/

Purpose: Rules library for best practices.

Contents:

  • README.md - Rules overview
  • library/ - 15 categories of rules

Structure:

rules/
├── README.md
└── library/
    ├── 01-core-workflow/
    ├── 02-ai-agents/
    ├── 03-languages/
    ├── 04-frameworks/
    ├── 05-ui-libraries/
    ├── 06-cloud-infrastructure/
    ├── 07-databases/
    ├── 08-testing/
    ├── 09-devops-ci-cd/
    ├── 10-code-quality/
    ├── 11-documentation/
    ├── 12-security/
    ├── 13-development-practices/
    ├── 14-mcp-tools/
    └── 15-project-specific/

Customization: Add or modify rules as needed.

.plan/ - Planning and Tasks

Contains planning documents and task management.

.plan/00_System/

Purpose: System-level planning documents.

Contents:

  • IDEA.md - Project idea (created with /tell)
  • BRAINSTORM.md - Brainstorming results (created with /improve)
  • PRD.md - Product Requirements Document (created with /write)
  • ARCHITECTURE.md - Technical Architecture (created with /write)
  • DESIGN_SYSTEM.md - Design System (created with /write)

Workflow:

  1. /tell → Creates IDEA.md
  2. /improve → Creates BRAINSTORM.md
  3. /write → Creates PRD.md, ARCHITECTURE.md, DESIGN_SYSTEM.md
  4. /good → Locks the plan

.plan/TASKS.md

Purpose: Implementation tasks.

Contents:

  • Tasks organized by phases
  • Dependencies
  • Effort estimates
  • Acceptance criteria

Created: With /plan command

Updated: When tasks are completed with /finished

.plan/active_state.json

Purpose: Current project state.

Structure:

{
  "phase": "idea|brainstorm|writing|approved|tasks|building",
  "active_task": null | "task_id",
  "completed": ["task_id", ...],
  "locked": false | true
}

Phases:

  • idea - Idea captured
  • brainstorm - Brainstorming complete
  • writing - Planning documents generated
  • approved - Plan approved and locked
  • tasks - Tasks generated
  • building - Actively building

.github/workflows/ - CI/CD

Purpose: GitHub Actions workflows.

Files:

  • ci.yml - Continuous Integration (runs on all branches)
  • release.yml - Automated releases
  • changelog.yml - Auto-updates changelog
  • branch-protection.yml - Branch protection rules

Customization: Modify workflows as needed.

src/ - Source Code

Purpose: Your application source code.

Contents: Boilerplate code based on project type.

Structure: Varies by project type (Next.js, Tauri, Expo, etc.)

Customization: This is your code - modify freely!

File Purposes

Root Files

README.md

Purpose: Project documentation and overview.

Contents:

  • Project description
  • Quick start guide
  • Commands reference
  • Workflow overview
  • Agent list

Customization: Update with your project details.

CHANGELOG.md

Purpose: Version history and changes.

Contents:

  • Version history
  • Changelog entries
  • Breaking changes
  • Migration notes

Updated: Automatically with /finished command.

STANDUP.md

Purpose: Daily standup notes.

Contents:

  • Daily progress
  • Blockers
  • Next steps

Customization: Update daily with your progress.

IDE Configuration Files

IDE-specific configuration lives in two places:

  • Cursor / Windsurf / Antigravity / Cline / OpenCode: .cursor/rules/ (shared rules library)
  • Claude Code: docs/CLAUDE.md

Configuration Files

Project Configuration

No explicit configuration file is required. Configuration is:

  • Embedded in agent definitions
  • Embedded in command definitions
  • Embedded in rules
  • Stored in active_state.json

IDE Configuration

IDE-specific configuration files are generated automatically.

Generated Files Reference

Always Generated

  • .cursor/agents/*.md - All 18 agents
  • .cursor/commands/*.md - All commands
  • .cursor/rules/library/** - All rules
  • .plan/00_System/*.md - Planning document templates
  • .plan/active_state.json - Initial state
  • .github/workflows/*.yml - All workflows
  • README.md - Project README
  • STANDUP.md - Standup template
  • CHANGELOG.md - Changelog template

Conditionally Generated

  • src/** - Boilerplate code (varies by project type)
  • IDE config files (based on IDE choice)

Customization Points

1. Agent Customization

Location: .cursor/agents/

How: Edit agent markdown files to customize:

  • Agent roles
  • Responsibilities
  • Behavior
  • System prompts

2. Command Customization

Location: .cursor/commands/

How: Edit command markdown files to customize:

  • Command triggers
  • Actions
  • Agent involvement
  • File operations

3. Rules Customization

Location: .cursor/rules/library/

How:

  • Edit existing rules
  • Add new rules
  • Create custom categories

4. Workflow Customization

Location: .github/workflows/

How: Edit workflow YAML files to customize:

  • CI/CD pipelines
  • Release processes
  • Automation

5. Project Structure Customization

Location: Root directory

How:

  • Add new directories
  • Modify existing structure
  • Add configuration files

Directory Tree Examples

Minimal Project

my-project/
├── .cursor/
│   ├── agents/
│   ├── commands/
│   └── rules/
├── .plan/
│   └── active_state.json
└── README.md

Full Project

my-project/
├── .cursor/
│   ├── agents/ (18 files)
│   ├── commands/ (14 files)
│   └── rules/
│       └── library/ (15 categories, 1000+ files)
├── .plan/
│   ├── 00_System/ (5 files)
│   ├── TASKS.md
│   └── active_state.json
├── .github/
│   └── workflows/ (4 files)
├── src/
│   └── [project code]
├── CHANGELOG.md
├── STANDUP.md
├── README.md
└── [IDE config]

File Examples

Example: active_state.json

{
  "phase": "building",
  "active_task": "1.2",
  "completed": ["1.1"],
  "locked": true
}

Example: Agent File Structure

# Agent Name

## Role
Brief role description

## System Prompt
Detailed persona and responsibilities

## Responsibilities
- Responsibility 1
- Responsibility 2

Example: Command File Structure

# Command Name

## Trigger
Command trigger pattern

## Action
What happens when command is used

## Agent Involvement
- Agent 1
- Agent 2

Related Pages

Last Updated: 2025
Maintained By: Documentation Team

Clone this wiki locally