Sign in to create and edit playbooks. Sign In Register

Scaffold Project Structure

BSP-3 Order: #3 Elaboration Has Dependencies

Updated 4 months ago

Guidance

Scaffold Project Structure

Objective

Create the directory tree as defined in DTA-04 (Code Organization). This includes all top-level directories, app directories, placeholder files, and __init__.py files where needed.


Process

1. Read DTA-04 Decisions

From SAO.md § Code Organization, extract:
- Repository strategy (monorepo/polyrepo)
- Directory structure with layer separation
- App/module names from DTA-02 (Application Blocks)

2. Create Directory Tree

Example for a Django project:

mkdir -p {app_name}/{models,services,views,templates/{app_name}}
mkdir -p tests/{unit,integration,e2e}
mkdir -p docs/{architecture,process,features,ux,runbooks}
mkdir -p logs
mkdir -p static/{css,js,img}
mkdir -p scripts

3. Create Placeholder Files

For each directory, create the minimum files needed so the structure is functional:

# Python packages need __init__.py
touch {app_name}/__init__.py
touch {app_name}/models/__init__.py
touch {app_name}/services/__init__.py
touch {app_name}/views/__init__.py
touch tests/__init__.py
touch tests/unit/__init__.py
touch tests/integration/__init__.py
touch tests/e2e/__init__.py

# Keep empty directories in Git
touch logs/.gitkeep
touch static/css/.gitkeep
touch static/js/.gitkeep
touch static/img/.gitkeep
touch docs/runbooks/.gitkeep

4. Create docs/ Placeholder Structure

# Architecture docs (from DTA)
touch docs/architecture/.gitkeep
# Process docs (from DSP)
touch docs/process/.gitkeep
# Feature files (from ESM)
touch docs/features/.gitkeep
# UX artifacts (from ESM)
touch docs/ux/.gitkeep

5. Commit Scaffold

git add .
git commit -m "chore(scaffold): create project directory structure per DTA-04"

Deliverables

  • Directory tree created per DTA-04 decisions
  • App packages initialized with __init__.py
  • Test directory structure created (unit/integration/e2e)
  • Docs directory structure created
  • Static assets directories created
  • Scaffold committed

Inputs

Read these before starting this activity. They are produced earlier in the playbook and are authoritative — raise a drift event instead of deviating.

  • IA Guidelines (Document, Required) — produced by Define Information Architecture (#37).
  • System Architecture Overview Template (Template, Required) — produced by Write SAO.md (#59).
  • Makefile Template (Code, Required) — produced by Create Makefile (#93).
Details
Order:
#3
Phase:
Predecessor:
BSP-2 Initialize Repository
Created:
Apr 12, 2026
Last Updated:
May 21, 2026
Workflow
Bootstrap Project

Bootstrap a greenfield project from SAO.md decisions. Install prerequisites, initialize repository, scaffold structure, configure tooling, create Makefile, verify with a …

View Workflow
Assigned Agent

No agent assigned

Required Skills
Rules
Input Artifacts 3
Output Artifacts

No output artifacts