neon-sprawl/docs/decomposition/README.md

43 lines
2.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

# Decomposition Workspace
This workspace contains detailed planning artifacts derived from the finalized master plan:
- Source of truth: [`neon_sprawl_vision.plan.md`](../neon_sprawl_vision.plan.md)
- Tech stack baseline: [`docs/architecture/tech_stack.md`](../architecture/tech_stack.md)
- Scope here: executable decomposition (epics, modules, milestones)
## Folder Layout
- `epics/` - One file per epic with implementation slices.
- `modules/` - [Contract definitions](modules/contracts.md), [client vs server authority](modules/client_server_authority.md), [PvP × combat engine](modules/pvp_combat_integration.md), [full module dependency register](modules/module_dependency_register.md) (all epic modules), [per-module docs](modules/module_dependency_register.md#per-module-documentation), and interface notes.
- `milestones/` - Phase-gated implementation tracks and pass/fail checklists.
## Working Rules
1. Do not rewrite baseline vision in these files; link back to the master plan.
2. Keep slices backlog-ready (clear owner, dependencies, acceptance criteria).
3. Use stable IDs (E1, E1.M1, P1.M1, etc.) to preserve traceability.
4. Every new slice must reference telemetry and validation where applicable.
## Epic Files
| Epic | Document |
|------|----------|
| 1 - Core Player Runtime | [epics/epic_01_core_player_runtime.md](epics/epic_01_core_player_runtime.md) |
| 2 - Classless Progression | [epics/epic_02_classless_progression.md](epics/epic_02_classless_progression.md) |
| 3 - Crafting Economy | [epics/epic_03_crafting_economy.md](epics/epic_03_crafting_economy.md) |
| 4 - World Topology | [epics/epic_04_world_topology.md](epics/epic_04_world_topology.md) |
| 5 - PvE Combat | [epics/epic_05_pve_combat.md](epics/epic_05_pve_combat.md) |
| 6 - PvP Security | [epics/epic_06_pvp_security.md](epics/epic_06_pvp_security.md) |
| 7 - Quest / Faction | [epics/epic_07_quest_faction.md](epics/epic_07_quest_faction.md) |
| 8 - Social / Guild | [epics/epic_08_social_guild.md](epics/epic_08_social_guild.md) |
| 9 - LiveOps / Integrity | [epics/epic_09_liveops_integrity.md](epics/epic_09_liveops_integrity.md) |
Template for new epics or major revisions: [epics/_epic_template.md](epics/_epic_template.md)
## Next Actions
1. Expand slices into engineering tickets; keep module IDs aligned with the master plan.
2. Populate `modules/module_dependency_register.md` as contracts stabilize.
3. Refine `milestones/phase_execution_plan.md` with dates and owners when execution starts.