How do I write in the documentation editor?
Last verified October 18, 2026
Open Documentation, click New Entry and start typing. Type / for headings, tables and artifacts, @ to mention a person, task, event or wiki page, and paste Markdown straight in. Everything saves as you go.
Start an entry
- Go to Work > Documentation.
- Click New Entry. To start from a layout, click the arrow next to it (Start from a template) and pick one, such as Design Iteration, Test Log, Meeting Log or Competition Recap.
- Give it a title and set Work happened on to the day of the session.
Nothing is saved until you type something, so opening a blank entry and closing it leaves nothing behind. After that, the status next to the title shows Saving… and Saved. If several teammates open the same entry, you all write in it at once, their avatars appear in the header and the status reads Shared.
Any team member can write in any entry. Only the person who wrote an entry, or someone with the Manage documentation permission, can delete it.
The toolbar and the / menu
The toolbar has bold, italic, underline, strikethrough, inline code, headings, lists, a checklist, quotes, code blocks, tables, dividers and links.
Type / anywhere for the same blocks plus a few more: Toggle (a section that folds away) and four callouts: Note, Tip, Warning and Danger. Keep typing after the slash to filter, for example /table.
Mentions and page links
Type @ (or click the @ button in the toolbar) to mention:
- a team member
- a task
- an event from your schedule
- a wiki page
Mentioning a task also drops a task card at the end of the entry, showing its status, dates and who is on it.
Type [[ to link a wiki page by name.
Artifacts
Artifacts are structured blocks for the things judges look for. Click Insert an artifact in the toolbar, or find them in the / menu.
| Group | Artifacts |
|---|---|
| Planning | Task, Checklist |
| Design | Requirements, Decision matrix, Port map, Iterations |
| Testing | Test log, Failure report |
| Outreach | Outreach log, Award note |
Task and Checklist embed a live record. A checklist lets you pick an existing run or start a new one from a template, and the team can tick it off inside the entry. Some artifacts count as evidence for a particular award, so inserting one adds that award to the entry's Awards list.
Pasting Markdown
Paste Markdown from a doc, chat or README and it turns into real formatting: headings, lists, checkboxes, tables, bold, links and code. Two ways to keep it as plain text:
- hold Shift while pasting
- paste inside a code block
Top-level # headings become regular headings. Image links in pasted Markdown come through as links, so upload the photos themselves.
Photos
Paste a photo, drag one into the entry, or click Add photo. JPEG, PNG and WebP work. Large photos are shrunk in your browser first, and each one has to be 5 MB or smaller after that. Photos count against your team's storage.
Tag the entry
The panel beside the text holds Linked records, Subsystem, Type, Stage, Authors and Awards. These drive the filters on the Documentation page and the Board view.