chore: add project documentation framework

This commit is contained in:
brother7 committed 2026-08-18 16:51:02 +08:00
1 parent e1a0a14028
commit 469f72bdf7
35 files changed
+700

No files matched your search

@@ -0,0 +1,18 @@
# Data Flow
## Primary Flows
| Flow | Source | Destination | Notes |
|---|---|---|---|
## State Ownership
- {state owner or persistence rule}
## External Interfaces
- {API, file, service, or user-facing boundary}
## Last Updated
{YYYY-MM-DD}
@@ -0,0 +1,18 @@
# Module Map
## Source Layout
| Path | Responsibility | Owner Notes |
|---|---|---|
## Dependency Direction
- {dependency direction rule}
## Risky Or Sensitive Areas
- {module or path that needs extra care}
## Last Updated
{YYYY-MM-DD}
@@ -0,0 +1,22 @@
# System Overview
## Current Architecture
{short description of the current system shape}
## Main Components
| Component | Responsibility | Notes |
|---|---|---|
## Important Boundaries
- {boundary that future work should respect}
## Related Decisions
- {ADR reference}
## Last Updated
{YYYY-MM-DD}