Documentation
pick where to start.

All guides in one place. Start with Quick Start if this is your first time, or jump straight to the section that matches what you are trying to do.

Start Here
Quick Start Guide
Zero to first evidence pack in under 5 minutes. The fastest path to useful, regardless of what you're doing.
Installation
Installing from the Chrome Web Store or loading unpacked for development. Pinning to your toolbar.
🪟
Opening the Panel
How to open the side panel, keep it visible while browsing, and navigate the five tabs.
🔐
Permissions Explained
What permissions TraceBrief requests, why each one is needed, and what we explicitly don't do with them.
📸
Screenshots, Selected Area & Full-Page Capture
Visible capture, selected area crop, and full-page scrolling for tall pages — plus what to do on restricted pages.
🎬
Screen Recordings
When to record instead of screenshot. How to keep recordings short and high-signal. Stopping and saving.
✏️
Annotation Editor
The scrollable annotation canvas. Arrows, labels, highlights. Handling tall screenshots. Saving edits.
📋
Step Logger
Writing Steps → Expected → Actual. Environment fields. The format that gets bugs fixed on the first round.
Primary
Copy & Export Output
The fastest workflow: capture in the panel, paste into Jira, Slack, email, or anywhere else. Five copy formats explained.
📄
Export Formats
ZIP, CSV, HTML gallery — when to use each, what each file contains, and who each format is for.
🎯
Jira, GitHub & More
Exactly how to attach or paste a TraceBrief pack into Jira, GitHub Issues, Linear, email, and Slack.
🔒
Privacy & Security
Local-first storage, sandboxed HTML previews, strict CSP, and why we don't have a server ingesting your screenshots.
🛠
Troubleshooting
Screenshot fails, annotator scroll issues, export buttons disabled, recording won't save. Causes and fixes.
Best Practices
How to write high-signal evidence. Naming conventions, what to capture, what to skip, and how to keep packs clean.
📖
Glossary
Evidence Item, Evidence Pack, Step Logger, Sandboxed Preview — every TraceBrief term defined clearly.

Quick Start Guide

Zero to your first evidence pack in under 5 minutes. This works whether you are debugging a product issue, documenting a broken flow, or simply trying to capture what happened clearly the first time.

No account required. No email. Open the extension and go.

The fastest workflow

1
Open TraceBrief
Click the TraceBrief icon in your Chrome toolbar, or open the Chrome side panel and select TraceBrief. It appears alongside your current tab — no new windows.
2
Capture what's broken
On the Capture tab, hit Screenshot (Alt+S) or Screen Record. Capture while the broken thing is still visible. Don't navigate away first.
3
Add reproduction steps
Switch to the Steps tab. Add what you did, what you expected, and what actually happened. Three to five steps is usually enough.
4
Copy and paste — or export
On the Export tab, choose whether you want copied output or a file export. Copy when you want to paste into a ticket or chat. Export when you need a ZIP, CSV, or HTML file.
💡
The side panel stays open while you switch tabs. Reproduce the bug in one tab, paste into your ticket in another — TraceBrief remembers everything.

What you get

A single structured evidence pack containing your screenshots or recording, reproduction steps, expected vs actual behaviour, and auto-captured context (URL, browser, OS, timestamp). Formatted to paste anywhere or export as a file.

Screenshots, Selected Area & Full-Page Capture

Use the screenshot mode that fits the problem: visible viewport, selected area crop, or full-page stitch for tall pages. Everything lands in your evidence list automatically.

Standard screenshot

Click Screenshot in the Capture tab, or press Alt+S from anywhere. The screenshot captures the current visible viewport and appears in your Evidence list immediately.

Selected area capture

When you only need one part of the page, choose Selected area from the screenshot menu, then drag to crop the exact region you want. Press Esc to cancel if you miss it the first time.

Selected area is the fastest way to skip extra annotation work when only one field, card, or button matters.

Full-page capture

For dashboards, long forms, or any page that scrolls — click Full Page. TraceBrief scrolls the page automatically and stitches the images together. Scroll to the top first for the cleanest result.

💡
Some sites prevent full-page capture. If it fails, use standard screenshot and capture the key sections individually.

What happens after capture

Your screenshot appears as an Evidence Item in the Capture tab. You can preview it, rename it, open it in the annotation editor, download it, or delete it. All evidence stays local until you export.

Chrome's internal pages (chrome://, chrome-extension://) and some secure payment flows block capture. This is a Chrome security constraint — not a TraceBrief bug.

Naming your screenshots

Rename evidence items immediately after capture. "Billing — upgrade button disabled" is useful. "Screenshot 1" is not. You'll thank yourself when you're filing the ticket two hours later.

Previous
Quick Start

Copy & Export Output

The primary workflow. The side panel stays open while you work — capture in your app, paste into your ticket. No file downloads, no tab management, no friction.

The two paths

Copy path (primary): choose a format on the Export tab, hit Copy, switch to your destination, paste. The side panel remembers your evidence while you switch tabs.

Export path (when you need a file): download a ZIP, CSV, or HTML gallery. Use this when you need an attachment, an archived record, or something to email outside your tools.

Copy formats

Format Best for Contains
Plain Text
Email, Slack, any plain field Steps, expected, actual, environment — readable by anyone
Markdown
GitHub Issues, Linear, Notion Full structured report with headers and formatted lists
CSV
Jira (paste into description) Steps and metadata in comma-separated format
HTML
Rich email, internal wiki Formatted HTML you can paste into rich-text editors
JSON
APIs, custom tooling, devs Full structured data — all fields, all evidence references

Export file formats

Format Best for Contains
ZIP Bundle
Ticket attachments, archiving All screenshots, recordings, CSV summary — one file
HTML Gallery
Stakeholder review, sharing Sandboxed click-through gallery — safe to open anywhere
CSV
Lightweight attachment Steps, metadata, file references — no binary assets
HTML gallery exports are sandboxed — they cannot execute scripts. Safe to open and share with anyone, including non-technical stakeholders.
Previous
Step Logger

Step Logger

Steps are what turn a screenshot into a reproducible report. Without them, even a perfect recording can get "I can't reproduce it." With them, you get a fix.

The structure that works

Every good bug report has the same three parts. TraceBrief's Step Logger makes all three easy:

Steps to Reproduce
Numbered steps. Start from a known state ("Log in as admin, go to Billing"). Be specific about what you click. Write like you're instructing someone who has never used the app.
Expected Result
What should happen. One sentence. "File downloads immediately" or "User is redirected to the dashboard."
Actual Result
What actually happened. Be precise. "Page refreshes and no file is downloaded" is better than "it didn't work."

Environment context

TraceBrief auto-captures URL, browser, OS, and timestamp. You can add additional context manually — account role, feature flags, environment (staging vs production). This is the context that turns a 3-round ticket into a 1-round fix.

💡
Three to five steps is usually the right length. More than eight steps and you're probably describing two separate bugs.

What gets exported

Your steps are included in every output format — plain text, Markdown, CSV, HTML, JSON, and all file exports. They stay attached to your evidence wherever you copy or export it.

Previous
Annotation Editor

Privacy & Security

Local-first by design. Your data stays on your machine until you choose to export it or paste it somewhere else. Here's exactly what that means, technically.

Local-first storage

Everything TraceBrief captures — screenshots, recordings, steps, context — is stored in Chrome's local extension storage. It does not leave your machine unless you explicitly copy or export it.

We do not run a server that receives your captures. There is no TraceBrief cloud. Your screenshots are not backed up anywhere we can see.

Permissions we request

TraceBrief requests the minimum permissions required to function — nothing more:

storage
Saves your evidence items and steps locally in Chrome. Nothing is sent anywhere.
sidePanel
Shows the TraceBrief UI in Chrome's side panel.
activeTab / tabs
Accesses the current tab for capture. Only active when you trigger a capture action.
tabCapture (recordings only)
Required for screen recording. Chrome may prompt you to choose what to share — that's Chrome's own permission flow, not ours.

Sandboxed HTML previews

HTML gallery exports are rendered inside a sandboxed iframe using srcdoc. This blocks script execution. You can share HTML galleries with anyone — they cannot run code.

Image validation

TraceBrief validates all image payloads against a strict allow-list (PNG, JPEG, WebP only). Unknown or unexpected data URL types are rejected before processing.

💡
If your screenshots contain sensitive customer data, treat your exports with the same care you'd give any sensitive file. TraceBrief doesn't see them — but your recipients will.
Previous
Jira, GitHub & More

Troubleshooting

Something isn't working. Here are the most common issues, why they happen, and how to fix them.

Screenshot capture fails

Most likely cause: restricted pages. Chrome blocks capture on internal pages (chrome://), some payment flows, and pages with strict security headers.

Fix: refresh the tab and try again. If it fails on a specific page type, use standard screenshot and capture the area manually. This is a Chrome constraint.

Annotator scroll stuck or unresponsive

Most likely cause: mouse is outside the scrollable editor container.

Fix: ensure your cursor is inside the editor when scrolling. Close and reopen the annotator. In rare cases, reducing Chrome's zoom level (Ctrl/Cmd + -) helps. The annotator scroll stability was a v1 priority fix — if you're seeing persistent issues, check for a newer version.

Recording doesn't save

Most likely cause: the browser share prompt wasn't completed, or Stop Recording wasn't clicked properly.

Fix: ensure you clicked Stop Recording in the panel (not just closed the share prompt). Try again with tab-only recording selected in Chrome's share dialog.

Export buttons are greyed out

This is intentional. TraceBrief disables export actions when they can't complete successfully — and shows you exactly why. Hover the disabled button to see the reason. Common causes: no items selected, no steps logged, export still generating.

Disabled actions explain why they're disabled. If you're unsure, hover the button — TraceBrief will tell you what's missing.

Full-page capture misses content

Scroll to the top of the page before triggering full-page capture. Some pages with lazy-loaded content or fixed headers don't scroll cleanly — use standard screenshots for those sections and capture in two passes.

Previous
Privacy & Security

Installation

Installing TraceBrief from the Chrome Web Store, or loading it unpacked for development. Takes under a minute.

From the Chrome Web Store

Search for TraceBrief in the Chrome Web Store and click Add to Chrome. Chrome will ask you to confirm the permissions. Once installed, pin it to your toolbar for fast access.

Load Unpacked (Developer / Pre-release)

If TraceBrief is provided as a folder or zip before it's on the store:

1
Unzip the folder
Make sure the folder contains a manifest.json file at the root. That's the extension root.
2
Open chrome://extensions
Type that address into Chrome's URL bar. Don't Google it — type it directly.
3
Enable Developer Mode
Toggle it on in the top-right corner of the extensions page.
4
Click "Load Unpacked"
Select the folder where manifest.json lives. TraceBrief will appear in your extensions list.
5
Pin to toolbar (optional)
Click the puzzle piece icon in Chrome's toolbar → find TraceBrief → click the pin. Makes opening the side panel faster.
💡
If Chrome shows errors after loading, check that you selected the correct root folder (the one with manifest.json, not a parent or child folder).
Previous
Quick Start

Opening the Panel

TraceBrief lives in Chrome's side panel — visible alongside your tab while you browse, so you never lose your place.

How to open it

Click the TraceBrief icon in your Chrome toolbar. If you've pinned it, it'll open the side panel directly. If not, click the puzzle piece icon first → find TraceBrief → click it.

You can also open the side panel via Chrome's View menu → Side Panel and then select TraceBrief from the dropdown.

The side panel stays open as you navigate tabs. You don't need to reopen it every time you change pages.

The five tabs

Capture
Screenshot and recording controls. Your evidence list. This is where you spend most of your time.
Steps
The step logger. Write your Steps → Expected → Actual here.
Context
Auto-captured environment data (URL, browser, OS, timestamp). Add extra fields manually.
Export
Copy your pack in 5 formats, or download as ZIP / HTML gallery / CSV.
History
Browse past evidence packs. Useful when a bug resurfaces and you need the original evidence.

Keyboard shortcuts

Alt+S — capture a screenshot using the current mode (works while the panel is open, even if you're focused on the page).

Alt+R — start or stop a screen recording.

Previous
Installation

Permissions Explained

TraceBrief is built on least-privilege. We request only what's needed, and nothing leaves your machine unless you export it or paste it somewhere else.

What we request and why

storage
Saves your evidence items, steps, and context locally in Chrome's extension storage. Nothing is sent anywhere automatically.
sidePanel
Lets TraceBrief appear in Chrome's side panel. Without this, there's no UI.
activeTab / tabs
Accesses the current tab for screenshot capture. Only active when you explicitly trigger a capture — not in the background.
tabCapture (recordings only)
Required for screen recording. When you start recording, Chrome will prompt you to choose what to share. That's Chrome's own security flow — TraceBrief doesn't see anything until you confirm.
Host access (http/https)
Broader access is needed for full-page capture and selected-area capture to work reliably across sites. Capture only happens on explicit user action — no background activity.
Capture only happens when you click capture. TraceBrief has no always-on observers, no background data collection, and no network calls to our servers.

What we explicitly don't do

We don't have a server receiving your screenshots. We don't collect analytics on what pages you visit or what you capture. We don't share data with third parties. The extension does its job locally and stays out of everything else.

See the Privacy & Security guide for the full technical breakdown.

Previous
Opening the Panel

Screen Recordings

For timing bugs, animation glitches, and multi-step flows. Moving proof for things a screenshot will never capture.

When to record instead of screenshot

Use a recording when the problem is about behaviour over time — a spinner that never stops, an animation that glitches, a multi-step flow that fails on step 4. Screenshots can't show timing. Recordings can.

For static state issues (wrong label, missing field, incorrect value), a screenshot is faster and clearer.

Audio options

Click the ▾ caret next to Screen Record to choose your audio mode before starting:

None
Video only. Best for most bug reports — keeps file size small and avoids capturing private conversations.
Mic
Records your microphone. Useful if you want to narrate what you're doing as you reproduce the issue.
System
Records tab/system audio. Good for capturing audio glitches or confirming that sounds are missing.
Mic + System
Records both. Use when you're explaining out loud and also need the on-screen audio.

Recording a clip

Click Screen Record (or press Alt+R). Chrome will ask what to share — choose the tab with the issue. Reproduce the problem, then click Stop Recording (or press Alt+R again). The recording saves as an evidence item automatically.

💡
Keep recordings under 30 seconds. Pause briefly on the final broken state before stopping. Long recordings get skipped — short ones get fixed.
If the recording doesn't save, make sure you clicked Stop Recording in the panel — not just dismissed Chrome's share dialog. Try again selecting tab-only in Chrome's share prompt.
Previous
Screenshots

Annotation Editor

Point directly at the problem. The annotation editor gives you a scrollable canvas for tall screenshots — arrows, text labels, highlights.

Opening the editor

In your Evidence list, click any screenshot to open it in the annotation editor. The canvas scrolls for tall screenshots — v1 included a specific stability fix for this.

What you can do

Draw arrows
Point directly at the broken element. One arrow is worth three paragraphs of explanation.
Add text labels
Short labels like "Expected here" or "This field is missing" turn an annotated screenshot into a self-contained explanation.
Highlight areas
Draw attention to the exact region of the page that matters. Works well for layout bugs and misalignment issues.

Saving your annotations

Click Save / Done when finished. The evidence item updates in your list — the original is replaced with the annotated version. If you want to keep both, duplicate the item before annotating.

💡
If scrolling feels stuck, make sure your cursor is inside the editor area (not outside the modal). Close and reopen if needed. Reducing Chrome's zoom level helps in rare cases.
The scroll container is separate from the editing stage — tall screenshots up to full-page length are fully supported without locking up.
Previous
Screen Recordings

Context Tab

Auto-captured environment data that turns a screenshot into a reproducible report. The stuff developers ask for every single time.

What's captured automatically

Every time you capture evidence, TraceBrief records:

URL
The exact page where the issue occurred. No more "which page was it on?"
Browser & version
Chrome version number included. Eliminates "what browser are you using?" entirely.
Operating system
Mac / Windows / Linux. Relevant for rendering and OS-specific bugs.
Viewport size
Screen dimensions at time of capture. Essential for responsive layout bugs.
Timestamp
Exact date and time of capture — useful for correlating with server logs.

Adding custom context

In the Context tab you can manually add fields like account role, feature flags, environment (staging vs production), or any other relevant info. These get included in all export formats.

The Context tab is the single thing that most reduces ticket back-and-forth. Fill it out before exporting.

Evidence & History

The evidence section is where captures stay organized. Rename items, remove noise, select what matters, and reopen older packs later from History.

What this section does

Your evidence list is the working area for everything you captured in the current pack. It is where you review assets, clean up duplicates, and decide what should be included before export.

What stays in a pack

An Evidence Pack bundles together:

Evidence Items
Screenshots and/or recordings captured during the session.
Steps to Reproduce
Your numbered steps, Expected result, and Actual result.
Environment Context
Auto-captured and manual fields: URL, browser, OS, timestamp, and anything you added.

Managing evidence items

Rename immediately after capture. "Checkout — payment error on mobile" is infinitely more useful than "Screenshot 3" when you're filing the ticket an hour later.

Delete noise before exporting — screenshots you took by mistake, duplicates, or captures from the wrong state. A clean pack is a fast fix.

Select items before exporting to send only what's relevant. You don't have to export everything.

History

Past packs are saved in the History tab. Open them when a bug resurfaces later and you need the original evidence without reproducing everything from scratch.

💡
Rename packs and evidence items early. History is much more useful when it says what happened instead of "Screenshot 4".

Export Formats

ZIP, CSV, HTML gallery — three file formats for when you need an attachment rather than a paste.

Choosing the right format

Format Best for Contains
ZIP Bundle
Ticket attachments, archiving, sharing everything All screenshots, recordings, CSV summary — one file, everything included
HTML Gallery
Stakeholder review, PM sign-off, sharing with non-technical viewers Sandboxed click-through gallery — safe to open anywhere, no scripts run
CSV
Lightweight attachment, pasting steps into text fields, tracking multiple reports Steps, metadata, file references — no binary assets, small file size

ZIP Bundle

The recommended format for most ticket workflows. Contains every screenshot and recording, plus a structured summary file. Attach to Jira, email it, or archive it. Everything travels together.

HTML Gallery

A click-through gallery that renders your screenshots and steps in a clean, readable layout. Designed for stakeholders who just need to see what happened without opening a ticket tool.

HTML galleries are sandboxed — rendered in an iframe that blocks script execution. Safe to open and forward to anyone, including external stakeholders.

CSV

Best when you need a lightweight, text-only attachment — or you want to paste your steps and metadata into a spreadsheet, import them into a tracker, or quickly copy them into a plain text field.

Previous
Copy & Export Output

Jira, GitHub & More

TraceBrief uses open formats, so you can move the output into the tools your team already use without building your workflow around an integration.

Jira

Best approach: paste the format that reads best in your Jira setup — usually Plain Text or Markdown for the description, plus a ZIP attachment if you want the full evidence pack.

GitHub Issues

Best approach: paste Markdown directly into the issue body. GitHub renders it perfectly — headers, lists, and code blocks all come through. Drag-and-drop any screenshots from the ZIP into the comment.

Linear

Best approach: paste Markdown into the issue description. Linear has excellent Markdown support. Attach images from the ZIP as inline attachments.

Slack

Best approach: paste Plain Text for the most predictable result, or use Markdown if your workspace formatting supports it the way you want. Attach the ZIP or individual screenshots when needed.

Email

Best approach: paste HTML into a rich-text email composer (Gmail, Outlook), or paste Plain Text for plain email. Attach the ZIP or HTML gallery for recipients who need to view everything.

Notion / Confluence / Docs

Best approach: paste Markdown — most modern wikis convert it on paste. Or use HTML in rich-text editors. Attach screenshots inline for visual evidence.

TraceBrief avoids fragile API integrations. Copy or export the format you need, then drop it into the tool your team already uses.
Previous
Export Formats

Best Practices

How to write high-signal evidence that gets issues resolved first time.

The golden rules

1
Capture at the moment of failure
Screenshot or record while the broken state is visible. Don't navigate away and come back — the exact state matters.
2
Name everything immediately
"Checkout — payment button disabled on mobile" is useful. "Screenshot 3" is not. Rename right after capture.
3
Keep recordings short
10–30 seconds is ideal. Pause briefly on the final broken state before stopping. Long recordings get skimmed or skipped.
4
Always add Expected vs Actual
One sentence each. "Expected: file downloads. Actual: page refreshes." This is the most important part of any report.
5
Export only what matters
Select relevant items before exporting. Noise in a pack is almost as bad as no pack at all.
Previous
Troubleshooting

Glossary

Every TraceBrief term defined clearly.

Terms

Evidence Item
A single captured asset — a screenshot or a recording — stored in TraceBrief with a title, timestamp, and optional notes.
Evidence Pack
A named bundle containing evidence items, steps, and context. The complete, shareable record of what happened.
Step Logger
The Steps tab interface for recording reproduction steps, expected result, actual result, and environment context.
Sandboxed Preview
HTML gallery exports are rendered in a sandboxed iframe. Scripts cannot execute. Safe to open and share.
Local-first
All data stays on your machine in Chrome's local extension storage until you explicitly copy or export it.
MV3
Manifest V3 — Chrome's current extension architecture. Enforces cleaner boundaries, better security defaults, and least-privilege permissions.
Previous
Best Practices