Reviewing your writing

A review reads your article and points out places where it could be clearer, more consistent, easier to use, or easier for an assistant to answer questions from. A review never changes your text by itself, and it never stops you from saving or publishing.

The three kinds of review

Review	What it looks at
Style review	Wording, terminology, tone and editorial conventions, according to the style guides you choose
Accessibility	Whether the article can be read and navigated by everyone, including people who use assistive technology
AI readiness	Whether the article is organized so that an assistant, or a search tool, can find and use the right part of it

Style review

A style guide is a published set of writing rules. DocSpade includes Google, Microsoft and Healthcare. You can turn on one or several, and they all check the same text. Each shows how many rules it contains.

The Healthcare guide checks wording used in health-related content. It does not replace clinical or privacy review by a qualified person.

Accessibility

The accessibility review checks things such as the order of headings, empty headings, links whose text does not say where they go, and long blocks of text that are hard to take in. It reports how many rules it checked.

AI readiness

AI readiness checks how well an article will work when its content is split into passages and used to answer questions. It groups its findings into seven categories.

Category	What it is about
Structure	Heading order, section and paragraph length, lists, and whether sections start with a clear introduction
Code	Code samples that say which language they are in and are introduced before they appear
Media	Descriptions for images, and tables that have headers
Safety	Passwords, keys, personal details and similar information that should not be published
Metadata	A clear title and description at the top of the article
Freshness	Out-of-date wording, old years, and dates such as “last month” that stop being true
Clarity	Very long sentences and reading level

Secrets that are found are hidden in the results, so a finding never repeats them.

Article types

You can tell DocSpade what kind of article you are writing. It then also checks that the article has the structure readers expect from that kind.

Article type	Readers expect
Getting Started & Quickstarts	A short path to a first useful result
Guides & How-To Tutorials	The steps for completing a specific task
Concepts & Architecture	Mental models, relationships and reasons
Reference Specifications	Exact parameters, formats and limits
Troubleshooting & FAQs	Problems, causes and actions that fix them
Release Notes & Changelogs	Changes, grouped by version and kind
Glossary & Terminology	Terms, definitions and preferred usage

Choosing a type is optional. With Not specified, no article-type findings appear.

Findings

Each finding tells you:

Which check found it, and where, as a line and position in the article.
What is wrong, in a sentence.
The text it applies to, shown highlighted.
A severity. An error is the most serious, a warning is a likely problem, and a suggestion is an improvement you can choose to skip.
Guidance, when there is a page that explains the rule.
A recommended change, when the check can propose a specific fix. You can accept it with one click.

A finding is advice. A review cannot tell whether an article is correct, complete or ready to publish. That judgment is yours.

Findings describe the article as it was when you ran the review. If you change the article afterwards, run the review again.