Review technical documentation with AI
Get a review that points to a specific passage, explains the defect and proposes a small correction. Claims can be checked against the sources available to you.
Review technical documentation with AI when the question is whether readers can rely on a guide. A sentence can be perfectly grammatical and still name a button that no longer exists. The reviewing-technical-prose skill asks the agent to locate the problem and explain what would change for the reader.
It also leaves room for an editor to do less. If a paragraph already expresses the author’s meaning and the evidence supports its claims, a preference for another tone is a poor reason to replace it. A review can end with no findings.
What it does
- Check a documented result against the source that supports it.
- Identify ambiguity that would lead readers to take different actions.
- Order findings by severity and give each one a location.
- Suggest a targeted fix without rewriting approved language.
- Examine a revision for details it accidentally removed or introduced.
Install and use
- Install the maker’s technical-writer bundle in your agent so the shared truth and style references are available.
- Supply the draft, its intended readers and any authorised source of truth.
- Ask, “Review this import guide. Flag claims the reference contradicts and give the smallest correction for each.”
- Check the evidence behind each finding before accepting changes.
FAQ
Source
Made by riekelt. Original skill: reviewing-technical-prose, published on GitHub under the MIT licence.
View on GitHub