Documentation

Index for the Cine Power Planner documentation tree. The product pitch and install instructions live in the root README; this folder is the canonical home for user guides, developer references, and per-feature specs.

By audience

Users

Doc	What it covers
Quick Start	Set up the app in under five minutes
User Guide	Feature walkthroughs and workflows
Authentication	Account setup and profile management
Provider System	Provider assignment and export filters
Collaboration	Sharing projects and resolving conflicts
Accounting	Expense tracking, SKR04 categories, Anlage EÜR + UStVA exports, Bewirtungsbeleg compliance
PDF Tools	86 offline PDF utilities + Document Scanner (camera capture w/ paper-edge detection + OCR)
FAQ	Frequently asked questions
Troubleshooting	Common issues and fixes

Developers

Doc	What it covers
Development Setup	Environment, dev server, tooling
Onboarding Guide	New-contributor orientation
Architecture Overview	Layers, data flow, design patterns (system-level — start here)
Architecture Index	One-screen orientation + Quick Lookup
Codebase Map	File & component catalog with per-feature appendixes
Data Layer	Services (storage, sync, auth, scanner/OCR, expenses, PDF) + full schema
Orchestration	App-layer hooks and view models
Data Storage	IndexedDB, OPFS, sync
Sync Architecture	Sync engine + conflict resolution
Schema History	IDB migration registry (v33 head)
Data Flow Diagrams	Visual flow diagrams for key operations
Component Map	Component interaction patterns
State Machines	State machine documentation
Testing Guide	Vitest + Playwright patterns
Commands Reference	Available npm scripts
API Reference	Service and hook APIs
Style Guide	Code style + German inclusive-language rules
Contributing	How to contribute (developer-facing)

Per-feature specs

Every feature follows the SDD pipeline. Each entry under features/ contains requirements.md, design.md, tasks.md, and status.md. Use these as the authoritative source for what a feature does and how it was built.

Reference

Doc	What it covers
Documentation Index	Full catalog of every doc in this tree
Roadmap	Planned features and milestones
Changelog	Documentation-side changelog
Project Changelog	Product release history
What's New	Recent user-facing highlights

Subtree map

docs/
├── user/         # End-user guides, FAQ, troubleshooting
├── dev/          # Architecture, codebase map, testing, setup
│   └── architecture/   # ADRs, data flow, component & state diagrams
├── features/     # Per-feature SDD specs (requirements, design, tasks, status)
├── INDEX.md      # Full doc catalog
├── ROADMAP.md    # Forward-looking plans
└── CHANGELOG.md  # Documentation-side changelog

Contributing to docs

See CONTRIBUTING.md at the project root. The four-table documentation-sync rule in CLAUDE.md — which file to update for which change type — is the contract.

← Back to Project README | Documentation Index

Last Updated: 2026-06-04 Version: 0.255.0