All products

Organise technical guides with AI

Organise a documentation set so a first-time learner, a user completing a task and someone looking up a detail can find the right page.

Organise technical guides with AI around the reader's immediate need. Someone opening an app for the first time needs a different page from a colleague checking whether an export accepts a date filter. The documentation skill uses the Diátaxis framework to distinguish those jobs before it proposes an outline.

A useful starting point is an overgrown “getting started” page. Keep the first successful task together, move exhaustive option lists into a reference and give an experienced user a shorter route to a specific result. An explanation can then cover the reasoning without interrupting either practical path.

What it does

  • Split a crowded introductory page into useful destinations.
  • Outline a tutorial that a new user can follow from start to finish.
  • Write a short task guide for someone who already knows the basics.
  • Design a reference section around information people repeatedly look up.
  • Add a separate explanation of why a feature works the way it does.

Install and use

  1. Give your agent the draft or page list and a representative reader question. No publishing account is needed.
  2. Decide whether the reader is learning, completing a task, looking up a fact or exploring a reason.
  3. Review the proposed structure by following one real task and checking how easily the answer can be found.

FAQ

Source

Made by Matteo Collina. Original skill: documentation, published on GitHub under the MIT licence.

View on GitHub