When documenting database systems, ensure all documentation includes complete end-to-end data flows. Both diagrams and textual descriptions should clearly indicate:

  1. Where and how user requests enter the system
  2. The complete path data takes through system components
  3. How responses/confirmations are returned to clients
  4. Precise timing and conditions for internal processes

For diagrams:

For technical descriptions:

Example improvement:

// Before: Incomplete diagram missing user entry point
┌────────────┐           ┌────────────┐
│flush buffer│──────────►│ wal buffer │
└────────────┘           └────────────┘

// After: Complete diagram showing user entry point and process flow
    User Write
        │
        ▼
┌────────────┐           ┌────────────┐
│flush buffer│──────────►│ wal buffer │ (Step 1: Buffer incoming writes)
└────────────┘           └────────────┘
                              │
                              ▼
                        (Step 2: Flush to disk)

Complete documentation helps new team members understand the system and makes debugging easier during incidents.