---
title: Testing
slug: books/technical-writing/testing
createdAt: 2025-04-29T17:04:01.617Z
---

It might seem like final approval from the SME is the last step in your documentation journey. Think again! Testing, and particularly *regular* testing, is essential for keeping your documentation usable, accurate and complete.

::Image[]{src="https://api.archbee.com/api/optimize/fh9Kla9lm_P4ujQJfZyJC/32GKA6unT1KMHecvnl--k_image.png" size="60" width="800" height="500" position="center" showCaption="false"}

# Types of Tests

Testing technical documentation involves a combination of **manual** and **automated** approaches. Depending on the tools and knowledge you have available, you can choose the right mix of the two.

- **Manual testing** works best for subjective or visual issues that tools can’t reliably detect.
  For example, evaluating the tone of a document or checking image clarity.
- **Automated testing** is recommended for repetitive or technical issues.
  For example, link validation or spell checking.

::Image[]{src="https://api.archbee.com/api/optimize/fh9Kla9lm_P4ujQJfZyJC/y0mtUt3QmLC96h2nwCGiU_nke5a6zhs6a61.png" size="40" width="486" height="601" position="center" showCaption="false"}

# Documentation Testing Checklist

This is a non-exhaustive list of tests you can run in you documentation:

::::LinkArray
:::LinkArrayItem
🔗

**Check all internal/external links**, to avoid broken links or bookmarks.
:::

:::LinkArrayItem
🖼️

**Validate alt text on images**, for accessibility.
:::

:::LinkArrayItem
🪜

**Ensure consistent heading structure**, to make sure you didn't skip a heading level (for example, H1 followed by H3).
:::

:::LinkArrayItem
✍️

**Spell check**, to avoid typos.
:::

:::LinkArrayItem
💻

**Test all embedded code snippets and commands**, to ensure that they can be copied and run correctly.
:::

:::LinkArrayItem
📱

**Preview layout on mobile and desktop**, to ensure good UX.
:::

:::LinkArrayItem
🧭

**Confirm navigation and TOC integrity**, to catch any topics that may be missing from the TOC.
:::

:::LinkArrayItem
🏷️

**Check metadata (title, description, tags)**, for correct indexing.
:::

:::LinkArrayItem
🖼️

**Check image quality**, to have a professional-looking documentation&#x20;
:::

:::LinkArrayItem
🗑️

**Find unused files**, to avoid storing and publishing useless or out of date content.
:::

:::LinkArrayItem
🗂️

**Check file naming**, for standardization purposes and to avoid cross-OS issues.
:::

:::LinkArrayItem
🔄

**Update variables**, to make sure they apply to the current version.
:::

:::LinkArrayItem
🎨

**Validate adherence to the style guide**, for consistency.
:::

:::LinkArrayItem
📅

**Periodically check if old content needs to be updated**, to avoid stale pages.
:::
::::

:::hint{type="info"}
The content-level tests are generally done during the review phase and are detailed in [Reviewing](docId\:SgN6dkQZatDpsLqXvEc5z)&#x20;
:::

Some tools that can be used for testing documentation are presented in [Documentation Workflows](docId:5H9MQcOHv_PPrU4JM6sVe).

***

# Next Step

After testing, you can call your documentation complete. The only remaining step is making it available to the users: [Delivering](docId:4n7AoKMcvTzxCq5khMOw3).
