57 lines
3.7 KiB
Markdown
57 lines
3.7 KiB
Markdown
# Documentation and implementation alignment
|
||
|
||
The [module dependency register](module_dependency_register.md) **Status** column and each module’s summary table should **not silently disagree** with the repo. This doc defines how to keep decomposition docs truthful and where to record **partial** work.
|
||
|
||
---
|
||
|
||
## Roles
|
||
|
||
| Source | Role |
|
||
|--------|------|
|
||
| **Register + module markdown** | Intent, dependencies, contracts, policies (authority, PvP, quests, ops). |
|
||
| **Code + tests** | What actually runs; paths under `server/`, `client/`, etc. |
|
||
| **Plans** | `docs/plans/` (e.g. NEON-* implementation plans) tie stories to acceptance criteria. |
|
||
| **Jira** | Stories under epics; **module grouping = labels** on the story (no Jira **Feature** issues). [Decomposition README — Jira alignment](../README.md#jira-alignment). |
|
||
| **This doc’s tracking table** | Quick **inventory** of modules that have started implementation; expand as work lands. |
|
||
|
||
---
|
||
|
||
## Status column (register)
|
||
|
||
| Status | Meaning |
|
||
|--------|---------|
|
||
| **Planned** | No meaningful implementation toward this module yet, or only unrelated spikes. |
|
||
| **In Progress** | At least one tracked story or code path exists toward the module; contracts may be partial. |
|
||
| **Ready** | Exported contracts meet [contracts.md](contracts.md) “Ready” guidance and dependents may integrate. |
|
||
| **Blocked** | Upstream module or external dependency prevents progress. |
|
||
|
||
**Rule:** When a story merges that implements part of a module (API, store, schema), move that row from **Planned** to **In Progress** (or **Ready** when appropriate) in the same PR or a follow-up doc PR.
|
||
|
||
**Partial modules** stay **In Progress** until the **prototype slice** for that module is satisfied or contracts are explicitly frozen for dependents.
|
||
|
||
---
|
||
|
||
## Per-module docs
|
||
|
||
Optional **`## Implementation snapshot`** (or a short bullet under Summary) on a module page: one paragraph + links to `docs/plans/…`, server paths, and [server README](../../../server/README.md) sections—avoid duplicating the full tracking table on every page.
|
||
|
||
The **Summary** table **Status** field should match the register row for that module.
|
||
|
||
---
|
||
|
||
## Implementation tracking table
|
||
|
||
Rows appear when work starts; default for unlisted modules is **Planned** / not started.
|
||
|
||
|
||
| Module | Register status | Snapshot | Plans / pointers |
|
||
|--------|-----------------|----------|-------------------|
|
||
| E1.M1 | Ready | Prototype milestone **Done** ([NEON-9](https://neon-sprawl.atlassian.net/browse/NEON-9)). Authoritative `PositionState` + **MoveCommand** over HTTP (JSON v1 snap); **in-memory** store by default, **Postgres** when configured ([NEON-5](../../plans/NEON-5-implementation-plan.md)); shared **NpgsqlDataSource** disposed on host shutdown ([NEON-15](../../plans/NEON-15-implementation-plan.md)); Godot sync + path-follow ([NEON-4](../../plans/NEON-4-implementation-plan.md), [NEON-8](../../plans/NEON-8-implementation-plan.md)); **InteractionRequest** + horizontal range ([NEON-6](../../plans/NEON-6-implementation-plan.md)). Follow-on: prediction/reconciliation, Slice 1 telemetry, Protobuf wire per [contracts.md](contracts.md). | [NEON-3](../../plans/NEON-3-implementation-plan.md), [NEON-4](../../plans/NEON-4-implementation-plan.md), [NEON-5](../../plans/NEON-5-implementation-plan.md), [NEON-6](../../plans/NEON-6-implementation-plan.md), [NEON-7](../../plans/NEON-7-implementation-plan.md), [NEON-8](../../plans/NEON-8-implementation-plan.md), [NEON-15](../../plans/NEON-15-implementation-plan.md); `server/NeonSprawl.Server/Game/PositionState/`, `Game/Interaction/`; [server README](../../../server/README.md) |
|
||
|
||
---
|
||
|
||
## Related docs
|
||
|
||
- [Module dependency register](module_dependency_register.md)
|
||
- [contracts.md](contracts.md) — versioning and Ready criteria
|