Tutorial: A Design Doc with a Diagram Beside It
This is the walkthrough that shows off what makes DocuShark different: prose and a diagram in one document, side by side. In about 15 minutes you'll write a short design doc and build the architecture diagram that goes with it — no app-switching, no pasted screenshots.
What you'll build: a one-page "URL Shortener" design doc — a written spec on the left, a live architecture diagram on the right.
You'll learn: prose pages, the Write · Split · Diagram focus, drawing shapes and smart connectors, auto-layout, and exporting the result.
Before you start: just open DocuShark — no setup needed. New here? Skim How DocuShark Is Organized first.
1. Create and name the document
From the Documents home, click New. The document opens on an empty canvas. Click Untitled Document in the toolbar and rename it to URL Shortener — Design.
2. Write the spec
You'll start in writing mode. If you're not already in it, click Write in the Write · Split · Diagram control in the toolbar.
In the document editor, write a short spec. Type naturally, and use the toolbar (or Markdown shortcuts) for structure:
# URL Shortener
## Goal
Turn long URLs into short, shareable links and redirect visitors quickly.
## Requirements
- Create a short code for any URL
- Redirect a short code to its original URL
- Count how many times each link is usedAdd a callout to flag an open question — from the toolbar's block menu, insert a block quote (or type >), and note: "Open question: how long should codes be?"
TIP
The document editor is a full rich-text surface — headings, tables, code, LaTeX math, and callouts all work. See Rich Text & Notes.
3. Bring in the canvas
Now put the diagram next to the writing. Click Split in the Write · Split · Diagram control. The document editor stays on the left and an infinite canvas opens on the right — the same document, two views.
4. Draw the architecture
You'll sketch four boxes: Browser → API → Database, with a Cache beside the API.
- Press
R(Rectangle) and drag out a box near the top-left of the canvas. Double-click it and typeBrowser. - Repeat for three more boxes:
API,Database, andCache. PressRagain before each (or grab it from the toolbar). - Press
Vto return to the Select tool, and drag the boxes into a rough left-to-right row, withCachesitting belowAPI.
Don't fuss over alignment — step 6 tidies it automatically.
5. Connect the boxes
- Press
C(Connector). - Hover over the Browser box until its connection points appear as small circles on the edges. Click one, then click a connection point on API. The connector routes itself between them.
- Connect API → Database, and API → Cache the same way.
- Add labels: click a connector's label area and type — for example
HTTPon Browser → API, andcache readon API → Cache.
Move any box (press V first) and watch the connectors follow — they stay attached. See Connectors for routing styles.
6. Tidy it with auto-layout
Let DocuShark arrange the diagram for you. Select the connected shapes (Ctrl/Cmd+A selects everything on the page), then open the command palette with Ctrl/Cmd+K and search "layout" — run the auto-layout command. The boxes snap into a clean, evenly-spaced flow with tidy connector routing.
7. Read it as one document
Switch focus back to Split (or Write) and scroll: your spec and its diagram are one thing now. Edit the prose and the diagram is still right there; move a box and the writing doesn't budge. Nothing to keep in sync by hand.
8. Save, share, or export
DocuShark auto-saves as you go. To share or hand it off:
- Share live: connect the document to a workspace and invite others to edit in real time — see Collaboration.
- Export: use Export for a PDF (prose and diagram, in order), or PNG/SVG of the current canvas. See Export & Import.
What you learned
You built a document that holds both a written spec and its live diagram — the core DocuShark workflow. You used prose pages, the Write · Split · Diagram focus, rectangles and smart connectors, auto-layout, and export.
Next steps
- Tutorial: Diagram an AWS Architecture — go deeper on shape libraries and cloud icons.
- Citations & References — cite sources in your spec and generate a bibliography.
- Document Fields — reuse values like a service name across the whole document at once.
