Skip to content

Commit a93073d

Browse files
committed
docs: strengthen project positioning and visuals
1 parent 87b7a89 commit a93073d

4 files changed

Lines changed: 167 additions & 1 deletion

File tree

README.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,34 @@ It is not meant to be a large production clone. It is meant to show a working de
88
- refine it into a spec
99
- drive implementation across `backend`, `frontend`, and `e2e-test`
1010
- validate the result locally with Docker and k3d
11+
- use AI assistance inside that structured workflow instead of treating AI output as the workflow itself
1112

1213
The core claim of this workspace is simple:
1314

1415
> one good product document should be able to drive one complete feature across multiple projects
1516
16-
## What This Repo Proves
17+
![PRD-driven delivery overview](docs/assets/workspace-delivery-overview.svg)
18+
19+
## What This Demonstrates
1720

1821
- A feature can start in `docs/`, not in source code.
1922
- Product requirements can be made explicit enough to drive API, UI, and test changes.
2023
- The same feature can be validated both in local service mode and in a k3s-style environment.
2124
- A single engineer can keep backend, frontend, QA, and infrastructure aligned through shared documents and conventions.
25+
- AI-assisted workflows can be useful when they are grounded in explicit PRDs, specs, contracts, and validation steps.
26+
27+
## Why This Matters
28+
29+
Modern teams lose time translating intent into implementation.
30+
31+
This workspace demonstrates a structured way to:
32+
33+
- reduce ambiguity between product and engineering
34+
- make backend, frontend, and QA changes easier to coordinate
35+
- keep AI assistance inside a deterministic workflow instead of using it as an unstructured code generator
36+
- validate the same feature in both local service mode and a k3s-style environment
37+
38+
The goal is not to claim “AI replaces engineering.” The goal is to show how one engineer can use structure, documentation, and automation to increase delivery leverage.
2239

2340
## Delivery Model
2441

@@ -55,6 +72,19 @@ That means:
5572

5673
The product-side contribution in this repo is the document package. The code should follow the documents, not lead them.
5774

75+
## AI-Assisted Workflow
76+
77+
AI is useful in this workspace only when it stays attached to real artifacts.
78+
79+
The intended pattern is:
80+
81+
1. Write the PRD in `docs/prd/`.
82+
2. Refine it into an execution-facing spec in `docs/spec/`.
83+
3. Use AI assistance to map the spec into backend, frontend, and e2e work.
84+
4. Validate the result with tests, Docker, and k3d.
85+
86+
The supporting note for that workflow lives in [`docs/ai-workflow.md`](/Users/skshim/git/side-project/example-workspace/docs/ai-workflow.md).
87+
5888
## How To Make A Feature
5989

6090
1. Create a new PRD file under `docs/prd/`.

docs/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ This directory is the starting point for feature work in this workspace.
44

55
- `prd/`: product requirements and problem framing
66
- `spec/`: execution-facing specs, API contracts, validation rules, and acceptance criteria
7+
- `ai-workflow.md`: how AI assistance is intended to fit into the delivery model
78

89
Expected workflow:
910

docs/ai-workflow.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# AI-Assisted Workflow
2+
3+
This workspace is not trying to prove that AI can replace product, engineering, or QA.
4+
5+
It is trying to prove something narrower and more useful:
6+
7+
AI assistance becomes much more reliable when the workflow is anchored in explicit artifacts.
8+
9+
## Intended Use
10+
11+
The expected order is:
12+
13+
1. Product intent is written in `docs/prd/`
14+
2. Execution detail is written in `docs/spec/`
15+
3. Backend, frontend, and e2e changes are derived from those docs
16+
4. Local validation happens through tests, Docker, and k3d
17+
18+
## Where AI Helps
19+
20+
- expanding rough product notes into a structured PRD
21+
- turning a PRD into a tighter implementation-facing spec
22+
- identifying backend/frontend/e2e touchpoints from the spec
23+
- drafting acceptance criteria and validation cases
24+
- keeping multi-project changes aligned
25+
26+
## Where AI Should Not Lead
27+
28+
- inventing product rules that are not in the PRD
29+
- changing API behavior without updating the spec
30+
- skipping validation just because generated code compiles
31+
- replacing test intent with vague smoke coverage
32+
33+
## Practical Rule
34+
35+
In this workspace, AI should accelerate translation between layers:
36+
37+
- PRD
38+
- spec
39+
- implementation
40+
- verification
41+
42+
It should not become an unreviewed source of truth.
Lines changed: 93 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)