Field notes
Build documentation people can inspect and maintain.
Task-focused guides with copyable examples, explicit limitations, and links back to the browser tools used to verify the result.
Markdown Tables
04 guidesGUIDE 01
Convert CSV to a Markdown Table Without Breaking Quoted Data
A practical CSV-to-Markdown workflow that handles quoted commas, escaped quotation marks, alignment, and destination-specific validation.
Read guideGUIDE 02
Markdown Table Alignment: Left, Center, and Right
Learn how separator-row colons control Markdown table alignment and when each alignment improves technical documentation.
Read guideGUIDE 03
Escape Pipes and Line Breaks in Markdown Table Cells
Prevent broken Markdown columns by handling literal pipes, backslashes, HTML line breaks, code spans, and renderer differences.
Read guideGUIDE 04
Design Better Tables for GitHub README Files
A review-friendly workflow for concise GitHub README tables, including headers, alignment, links, badges, and mobile readability.
Read guideMermaid Diagrams
04 guidesGUIDE 05
Mermaid Flowcharts: Nodes, Decisions, Labels, and Direction
Build readable Mermaid flowcharts with stable node IDs, explicit direction, decision labels, subgraphs, and practical syntax checks.
Read guideGUIDE 06
Mermaid Sequence Diagrams for API and Service Calls
Model API requests, responses, loops, alternatives, and failures with readable Mermaid sequence diagrams.
Read guideGUIDE 07
Mermaid ER Diagrams for Database Relationships
Document entities, attributes, primary keys, foreign keys, and relationship cardinality with Mermaid ER diagrams.
Read guideGUIDE 08
Mermaid Gantt Charts for Lightweight Project Plans
Create maintainable Mermaid Gantt charts with explicit dates, task IDs, dependencies, milestones, and honest limitations.
Read guideDocumentation Workflow
02 guidesGUIDE 09
Debug Mermaid Syntax Errors Systematically
A repeatable process for isolating Mermaid parser errors involving diagram types, reserved words, labels, blocks, and version differences.
Read guideGUIDE 10
A Reviewable Diagram-as-Code Workflow for Engineering Teams
Keep Mermaid diagrams useful by defining ownership, source-of-truth boundaries, pull request checks, and update triggers.
Read guide