Learn

Docs that actually work,step by step.

Guides, walkthroughs, and quick wins to help you write sharper documentation — faster.

Using the Doc Audit Tool

🩺
Walkthrough

Your First Doc Audit: A Complete Walkthrough

Upload your first document, understand your audit score, and turn the results into a concrete improvement plan.

⏱ 8 min read
📊
Step-by-step

Reading Your Audit Results: What Each Score Means

Break down clarity, structure, completeness, and readability scores — and know which ones to fix first.

⏱ 5 min read
🔁
Quick Win

Before & After: Fixing a Low-Scoring Doc in 20 Minutes

A real-world example of a poorly structured API guide — audited, diagnosed, and improved in one session.

⏱ 4 min read

Using the Template Library

📄
Step-by-step

How to Pick the Right Template for Your Project

Navigate the template library by use case, filter by doc type, and choose the right starting point without second-guessing.

⏱ 4 min read
📊
Quick Win

Getting the Most from Spreadsheet Templates

Tips for adapting the Project Tracker, KPI Dashboard, and Sprint Board to your team's actual workflow in under 10 minutes.

⏱ 5 min read
🧩
Walkthrough

Customising a Template Without Breaking Its Structure

Learn how to safely modify sections, rename fields, and add your brand tone — while keeping the template's logic intact.

⏱ 6 min read

Creating Specific Doc Types

🔌
Walkthrough

How to Write API Documentation Developers Will Actually Use

Structure, tone, code samples, and error handling — everything your REST API docs need to reduce integration time.

⏱ 10 min read
🎯
Step-by-step

Building a Pitch Deck That Wins Rooms

Slide-by-slide breakdown of what investors and stakeholders actually want to see — and how to structure your story.

⏱ 8 min read
📘
Step-by-step

Writing a User Guide from Scratch

How to scope, outline, and write a user guide that gets customers to their "aha" moment faster.

⏱ 7 min read
⚙️
Walkthrough

Technical Specs That Engineers Trust

Write architecture docs and system design specs that engineering teams actually reference — not just file away.

⏱ 8 min read

⚡ Writing Quick Wins

Small changes that immediately make your documentation clearer and more useful.

Start every doc with a single-sentence purpose statement.
Use the active voice. "Click Save" beats "The Save button should be clicked."
Put the most important information first — every time.
Write for the reader's next action, not your feature list.
Add a "What you'll need" section to every technical guide.
Limit each step in a guide to a single action.
Include at least one real code example per API endpoint.
Test your docs with someone unfamiliar with the product.

Documentation Best Practices

✍️
Step-by-step

The DITA Principle: Structure Your Docs Like a Pro

Why separating concepts, tasks, and references makes your documentation dramatically easier to write and maintain.

⏱ 6 min read
👁️
Quick Win

Writing for Scanners: How Technical Readers Actually Read

Most readers skim first. Learn how to format and structure content so the key information is always found — fast.

⏱ 4 min read
🔄
Step-by-step

Building a Documentation Review Process That Sticks

How to set up a lightweight review workflow so your docs stay accurate as your product evolves.

⏱ 5 min read

Ready to improve your docs?

Run a free audit on your existing documentation or grab a template to get started today.