You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+43-1Lines changed: 43 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,6 +18,10 @@ Use this repository when you want to:
18
18
19
19
This repository is best understood as a **working application**, not just a framework or document set.
20
20
21
+
## Maturity
22
+
23
+
This is a **working app and analytics prototype**. It is useful for structured problem-solving demos, Lean Six Sigma practice, PM/quality workflows, and internal process-improvement exploration. It is not a substitute for certified Black Belt review, validated statistical software, production quality systems, or domain-expert decision-making.
24
+
21
25
## What you get
22
26
23
27
### 1. Project Wizard
@@ -113,12 +117,44 @@ examples/ # Example projects and outputs
113
117
tests/ # Smoke tests for documented fallback path
114
118
```
115
119
120
+
## Architecture roadmap
121
+
122
+
The app already works, but the next quality step is to make the architecture easier to maintain and review.
123
+
124
+
Target direction:
125
+
126
+
```text
127
+
app.py # Thin Streamlit entry point
128
+
ui/
129
+
theme.py # Styling and visual constants
130
+
layout.py # Shared page layout
131
+
pages/
132
+
project_wizard.py # Project-input and package-generation flow
133
+
analytics_workbench.py # Statistical tool views
134
+
export_center.py # Export controls and previews
135
+
services/
136
+
assessment_service.py # Business logic orchestration
This would make `app.py` smaller, reduce coupling between UI and logic, and make the analytics tools easier to test independently.
150
+
116
151
## Design principles
117
152
118
153
-**evidence discipline** so users can separate facts from hypotheses
119
154
-**graceful degradation** so the app still works without an API key
120
155
-**role-aware framing** so the same work can be expressed for different audiences
121
156
-**quantitative plus narrative** so the repo is useful for actual improvement work
157
+
-**transparent technical debt** so limitations are named and improvements are trackable
122
158
123
159
## Current quality guardrails
124
160
@@ -128,7 +164,13 @@ The repository currently has:
128
164
- smoke coverage for the documented CLI fallback path
129
165
- a bundled sample project input for repeatable demos
130
166
131
-
The main remaining technical debt is app modularity. `app.py` still carries too much responsibility relative to a gold-standard app architecture.
167
+
The main remaining technical debt is app modularity. `app.py` still carries too much responsibility relative to a gold-standard app architecture. The architecture roadmap above documents the intended direction before deeper refactoring.
168
+
169
+
## Scope and disclaimer
170
+
171
+
This repository is shared in a personal capacity. It is not statistical certification, process certification, legal advice, compliance certification, or official Lean Six Sigma training material.
172
+
173
+
AI-generated outputs should be treated as structured drafts and hypotheses. Validate assumptions, measurements, root causes, statistical interpretations, and improvement actions with real process data and qualified domain experts.
0 commit comments