diff --git a/wiki/Architecture.md b/wiki/Architecture.md new file mode 100644 index 0000000..493bd12 --- /dev/null +++ b/wiki/Architecture.md @@ -0,0 +1,35 @@ +# Architecture + +> Keep this page in sync with the "Architecture & Design" section of the project +> specification. The specification captures the *decision*; this page captures the +> *current, evolving state* of the system for people working in the codebase day to day. + +## Overview + +One paragraph: what the major pieces are and how they fit together. Include or link a +diagram. + +## Components + +| Component | Responsibility | Depends on | +|---|---|---| +| | | | + +## Data flow + +Describe how data moves through the system, from input to output. + +## External dependencies + +| Dependency | Purpose | Notes | +|---|---|---| +| | | | + +## Key design decisions + +A short log of significant decisions and the reasoning behind them (an ADR-style list is +fine here if you don't have a separate `docs/adr/` folder). + +| Decision | Date | Reasoning | +|---|---|---| +| | | | diff --git a/wiki/FAQ.md b/wiki/FAQ.md new file mode 100644 index 0000000..abf9b56 --- /dev/null +++ b/wiki/FAQ.md @@ -0,0 +1,10 @@ +# FAQ + +> A running list of questions that came up more than once. If you find yourself answering +> the same question in an issue or chat, add it here. + +**Q: ``** +A: `` + +**Q: ``** +A: `` diff --git a/wiki/Getting-Started.md b/wiki/Getting-Started.md new file mode 100644 index 0000000..f4e1765 --- /dev/null +++ b/wiki/Getting-Started.md @@ -0,0 +1,37 @@ +# Getting Started + +## Prerequisites + +- Python `` +- `` + +## Installation + +```bash +git clone +cd + +``` + +## Configuration + +- Environment variables / config file(s) needed, and where to get their values +- Any secrets or credentials required, and how to obtain them safely (never commit them) + +## Running the project + +```bash + +``` + +## Running the tests + +```bash + +``` + +## Common issues + +| Symptom | Cause | Fix | +|---|---|---| +| | | | diff --git a/wiki/Project-Specification.md b/wiki/Project-Specification.md new file mode 100644 index 0000000..fb0c529 --- /dev/null +++ b/wiki/Project-Specification.md @@ -0,0 +1,28 @@ +# Project Specification + +The authoritative project specification lives in +[`docs/PROJECT_SPECIFICATION.md`](../docs/PROJECT_SPECIFICATION_TEMPLATE.md) (based on the +[project specification template](../docs/PROJECT_SPECIFICATION_TEMPLATE.md)), not on this +wiki page — it needs version control and review history that the wiki doesn't give you. + +This page exists so the specification is easy to find. Keep it updated with: + +- **Current version:** `` +- **Status:** Draft / In Review / Approved +- **Last approved:** `` + +## Summary + +Paste the 3–5 sentence summary from Section 1 of the specification here, so readers get the +gist without leaving the wiki. + +## Key goals + +- Goal 1 +- Goal 2 +- Goal 3 + +## Notable non-goals + +- Non-goal 1 +- Non-goal 2 diff --git a/wiki/Value-Stream-Mapping.md b/wiki/Value-Stream-Mapping.md new file mode 100644 index 0000000..544a744 --- /dev/null +++ b/wiki/Value-Stream-Mapping.md @@ -0,0 +1,37 @@ +# Value Stream Mapping + +The current and future state value stream maps live in +[`docs/value-stream-mapping/`](../docs/value-stream-mapping/) as an OpenDocument +Presentation (`.odp`), editable in LibreOffice Impress, OpenOffice Impress, or (with +conversion) PowerPoint/Google Slides. + +## Current state summary + +Briefly describe the current process, its main bottlenecks, and the headline metrics +(total lead time, total cycle time, %C&A) once the current state map is complete. + +| Metric | Value | +|---|---| +| Total lead time | | +| Total cycle time (value-added time) | | +| Process cycle efficiency | | + +## Future state summary + +Briefly describe the target process and what changes once the future state map is +complete. + +| Metric | Value | +|---|---| +| Target lead time | | +| Target cycle time | | +| Target process cycle efficiency | | + +## Improvement actions + +Pulled from the action plan slide in the map — kept here for visibility, updated from the +`.odp` file when it changes. + +| Action | Owner | Due | Status | +|---|---|---|---| +| | | | |