All products

Edit technical documentation with AI

Review a single guide for voice, headings, code examples and references, with specific edits the author can accept or change.

Writers can edit technical documentation with AI when the content already exists and the work is chiefly editorial. The docs-helper skill applies a compact house-style checklist to an existing page, looking for active sentences, consistent headings and code fences whose language is clear.

A setup guide might say that a configuration file “must be created”. If the reader has to create it, an active instruction will be clearer. If the application creates it automatically, the proposed wording should reflect that instead. A small edit like this can be reviewed without disturbing useful instructions around it.

What it does

  • Find passages that obscure who performs an action.
  • Check the page has a single main heading and consistent heading case.
  • Label fenced code examples with the appropriate language.
  • Identify examples that need to be realistic and runnable.
  • Point reference sections towards the canonical source.

Install and use

  1. Install the skill and provide the target guide or README. Local text review needs no separate account.
  2. Ask “Review the installation page. Quote each unclear sentence and propose the smallest edit that explains the next action.”
  3. Compare the edits with the project’s actual behaviour before accepting them.

FAQ

Source

Made by Gary Gentry. Original skill: docs-helper, published on GitHub under the MIT licence.

View on GitHub