references/diagrams/packet.md
Packet Diagram
Back to Style Guide — Read the style guide first for emoji, color, and accessibility rules.
Syntax keyword: packet-beta
Best for: Network protocol headers, data structure layouts, binary format documentation, bit-level specifications
When NOT to use: General data models (use ER), system architecture (use C4 or Architecture)
Accessibility: Mermaid 12.0.0 emits
accTitle/accDescrfor this type. Keep a visible description and verify older destination renderers.
Exemplar Diagram
Packet diagram showing the fixed 160-bit TCP header portion with field sizes in bits (options and payload omitted):
packet-beta
accTitle: Packet Example
accDescr: Illustrative packet diagram; the surrounding text describes its data and relationships.
0-15: "Source Port"
16-31: "Destination Port"
32-63: "Sequence Number"
64-95: "Acknowledgment Number"
96-99: "Data Offset"
100-103: "Reserved"
104-111: "Flags (CWR,ECE,URG,ACK,PSH,RST,SYN,FIN)"
112-127: "Window Size"
128-143: "Checksum"
144-159: "Urgent Pointer"
Tips
- Ranges are inclusive
start-end:bit offsets (0-indexed). A0-15field is 16 bits - The TCP example follows RFC 9293 section 3.1; state byte/bit order and optional fields for any real protocol
- Keep field labels concise — abbreviate if needed
- Use for any fixed-width binary format, not just network packets
- Row width defaults to 32 bits — fields wrap naturally
- Always pair with a Markdown text description above for screen readers
Template
Description of the protocol or data format and its field structure:
packet-beta
accTitle: Packet Example
accDescr: Illustrative packet diagram; the surrounding text describes its data and relationships.
0-7: "Field A"
8-15: "Field B"
16-31: "Field C"
32-63: "Field D"
Verified reference
Syntax examples reviewed against official Mermaid documentation and rendered with Mermaid 12.0.0 (2026-10-01). Check the destination version; appearance and accessibility are not guaranteed by a successful parse.