Technischer Redakteur für verständliche Projektdokumentation

# FORME.md - ${name} ## 1. The Big Picture (Project Overview) ${description_placeholder} **What problem does this solve?** ${problem_statement_placeholder} **Who is it for?** ${target_audience_placeholder} **The user journey in plain words:** ${user_journey_placeholder} **If this were a restaurant:** ${analogy_placeholder} --- ## 2. Technical Architecture - The Blueprint ``` ┌─────────────────────────────────────────────────────────┐ │ USER (Customer) │ └──────────────────────────┬──────────────────────────────┘ │ ▼ ┌─────────────────────────────────────────────────────────┐ │ FRONTEND (The Front Desk) │ │ What users see and interact with │ └──────────────────────────┬──────────────────────────────┘ │ ▼ ┌─────────────────────────────────────────────────────────┐ │ API LAYER (The Kitchen) │ │ All the real work happens here │ └──────────┬──────────────────────────────┬───────────────┘ │ │ ▼ ▼ ┌─────────────────────┐ ┌─────────────────────────┐ │ DATABASE │ │ EXTERNAL SERVICES │ │ (The Pantry) │ │ (The Suppliers) │ │ Stores everything │ │ Payments, Email, etc. │ └─────────────────────┘ └─────────────────────────┘ ``` **A building tour of the system:** ${architecture_tour_placeholder} **Why this architecture?** ${architecture_rationale_placeholder} **Clever choices worth noting:** ${clever_choices_placeholder} --- ## 3. Codebase Structure - The Filing System ``` ${folder_tree_placeholder} ``` **What lives where:** ${folder_explanations_placeholder} **Naming conventions to know:** ${naming_conventions_placeholder} **Entry points (where things start):** ${entry_points_placeholder} --- ## 4. Connections & Data Flow - How Things Talk to Each Other ### User Action 1: ${action_1_name} ${action_1_walkthrough_placeholder} ### User Action 2: ${action_2_name} ${action_2_walkthrough_placeholder} ### User Action 3: ${action_3_name} ${action_3_walkthrough_placeholder} **External service connections:** ${external_services_placeholder} **Authentication flow (how the app knows who you are):** ${auth_flow_placeholder} --- ## 5. Technology Choices - The Toolbox | Technology | What It Does Here | Why This One | Watch Out For | |-----------|------------------|-------------|---------------| | ${tech_1} | ${purpose_1} | ${rationale_1} | ${caution_1} | | ${tech_2} | ${purpose_2} | ${rationale_2} | ${caution_2} | | ${tech_3} | ${purpose_3} | ${rationale_3} | ${caution_3} | | ${tech_4} | ${purpose_4} | ${rationale_4} | ${caution_4} | **Cost implications:** ${cost_placeholder} --- ## 6. Environment & Configuration **Environment variables (the control panel):** | Variable | What It Controls | Where to Find It | What Happens If Wrong | |----------|-----------------|------------------|----------------------| | ${env_var_1} | ${purpose_1} | ${location_1} | ${impact_1} | | ${env_var_2} | ${purpose_2} | ${location_2} | ${impact_2} | **Environments (development vs staging vs production):** ${environments_placeholder} **"If you need to change X, you'd update Y - but be careful because Z":** ${change_impact_placeholder} **Secrets and keys (what connects to what - NOT the actual values):** ${secrets_placeholder} --- ## 7. Lessons Learned - The War Stories ### Bugs & Fixes **Bug 1: ${bug_1_title}** - **What happened:** ${bug_1_symptom} - **Root cause:** ${bug_1_cause} - **How we fixed it:** ${bug_1_fix} - **How to avoid it again:** ${bug_1_prevention} **Bug 2: ${bug_2_title}** - **What happened:** ${bug_2_symptom} - **Root cause:** ${bug_2_cause} - **How we fixed it:** ${bug_2_fix} - **How to avoid it again:** ${bug_2_prevention} ### Pitfalls & Landmines ${pitfalls_placeholder} ### Discoveries ${discoveries_placeholder} ### Engineering Wisdom ${wisdom_placeholder} --- ## 8. Quick Reference Card **How to run the project locally (step by step):** ${local_setup_placeholder} **Key URLs:** - Production: ${production_url} - Staging: ${staging_url} - Admin panel: ${admin_url} - Dashboard: ${dashboard_url} **Who/where to go when something breaks:** ${support_contacts_placeholder} **Most commonly needed commands:** | Task | Command | |------|---------| | ${task_1} | `${command_1}` | | ${task_2} | `${command_2}` | | ${task_3} | `${command_3}` | --- *This document was generated from analysis of the ${name} codebase. It reflects the current state of the project and should be updated as the system evolves.*