New_REP_SYSTEM/ERP-core
8
0
Fork 0
Code Issues Pull Requests 2 Actions Packages Projects Releases Wiki Activity

document update

Browse Source
This commit is contained in:
ImanThiyanga
2026-07-09 14:55:35 +05:30
parent 339d7408ae
commit ec94bac410
3 changed files with 150 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/01-DOC-GUIDE.md
+14 -8
View File
@@ -14,15 +14,17 @@
┌─────────────────┐
any task → │ 00-CORE.md │ (hub: structure, stack, setup, routing)
└────────┬────────┘
┌────────────────┼─────────────────┬───────────────────┐
▼ ▼ ▼ ▼
10-BACKEND-PHASE1 11-BACKEND-PHASE1 20-FRONTEND 01-DOC-GUIDE
(SRS+ER+arch) (API req/res) (flows+rules) (this file)
│ │ │
▼ ▼ ▼
┌────────────┬───┴────────┬─────────────┬────────────┐
▼ ▼ ▼ ▼ ▼
10-BACKEND-P1 11-BACKEND-P1 20-FRONTEND 02-SECURITY 01-DOC-GUIDE
(SRS+ER+arch) (API req/res) (flows+rules) (risks+ (this file)
│ │ │ checklist)
▼ ▼ ▼
Backend/PROGRESS.md (record changes) Frontend/PROGRESS.md
```
02-SECURITY is cross-cutting: consult it alongside the backend/frontend docs, and run its checklist before ticking any feature in a PROGRESS.md.
---
## 2. Document index
@@ -31,13 +33,14 @@
|---|---|---|---|---|
| `00-CORE.md` | High | **Hub.** Structure, tech stack, runnable backend init, routing. | First — every task. | Claude + humans |
| `01-DOC-GUIDE.md` | High | **This file.** Doc map, reading order, tracking conventions. | To understand the doc system. | Claude + humans |
| `02-SECURITY.md` | High (cross-cutting) | **Security review aid:** accepted-risks register + per-feature checklist. | Before ticking any feature in a PROGRESS.md; during security review. | Claude + humans |
| `10-BACKEND-PHASE1.md` | High | Backend spec: **full SRS**, **ER model / 38-entity list**, tech stack detail, layer/architecture rules. Schema is **authoritative** here. | Any backend model / business-rule / requirement work. | Claude + humans |
| `11-BACKEND-PHASE1.md` | High | Backend **API reference**: every endpoint with complete request/response, error catalog, enums. | Any API contract / controller / client work. | Claude + humans |
| `20-FRONTEND.md` | High | Frontend **user-flows**, architecture rules to follow, **validation posture**. | Any frontend work. | Claude + humans |
| `Backend/PROGRESS.md` | Low | Backend **change checklist**, git-shared. | After making backend changes. | **Claude** |
| `Frontend/PROGRESS.md` | Low | Frontend **change checklist**, git-shared. | After making frontend changes. | **Claude** |
Numbering convention: `0x` = high-level hub/guide, `1x` = backend, `2x` = frontend. Numbers sort in read order in any file browser.
Numbering convention: `0x` = high-level hub/guide/cross-cutting, `1x` = backend, `2x` = frontend. Numbers sort in read order in any file browser.
---
@@ -46,6 +49,7 @@ Numbering convention: `0x` = high-level hub/guide, `1x` = backend, `2x` = fronte
1. **`00-CORE.md`** — understand the project, structure, stack, and how to stand up the backend.
2. **`01-DOC-GUIDE.md`** (this file) — understand the doc system and tracking.
3. Then, per task, jump via the hub to `10-`, `11-`, or `20-`.
4. **`02-SECURITY.md`** — read the accepted-risks register once, then use its checklists during development.
You do not need to read `10/11/20` end-to-end before starting; open the section relevant to your task via the hub.
@@ -59,9 +63,11 @@ You do not need to read `10/11/20` end-to-end before starting; open the section
| "What does endpoint Y accept and return?" / "What's the error code?" | `11-BACKEND-PHASE1.md` |
| "How does the user move through the UI?" / "What do I validate on the client vs server?" | `20-FRONTEND.md` |
| "How do I set up / run the project?" | `00-CORE.md` |
| "What security risks apply to this feature?" / "What must I check before shipping it?" | `02-SECURITY.md` |
| "Is this exposure a bug or an accepted Phase-1 risk?" | `02-SECURITY.md` (Part A register) |
| "Where do I record what I changed?" | `Backend/PROGRESS.md` or `Frontend/PROGRESS.md` (this file, §6) |
If a question spans backend + frontend (e.g. a new feature), read the backend spec/API first (the contract), then the frontend doc (how the UI consumes it).
If a question spans backend + frontend (e.g. a new feature), read the backend spec/API first (the contract), then the frontend doc (how the UI consumes it). For any feature that mutates data, also run its `02-SECURITY.md` checklist.
---