Business & Professional Services

Publishing a sample documentation outline page

A sample outline page lets a prospective client judge your structural thinking before hiring. This guide walks through building one that shows readers, tasks and sections clearly, using a realistic product as the worked example.

Step one: choose a believable subject — MatrixWritingMatrixWriting · Health

01

Step one: choose a believable subject

Pick a small product a visitor can imagine, such as a scheduling app for dental clinics. State the subject in one line and name two or three reader roles: front desk staff, clinic manager and IT administrator. Avoid real client material and avoid claiming the example was delivered for anyone. Label the page clearly as a sample. The goal is to show how you think, so choose a subject with enough variety in tasks that the outline needs real decisions about order, depth and what to leave to a separate reference section rather than to a single long manual.

Step two: build the grid before the headings — MatrixWritingA useful path from inputto understanding

02

Step two: build the grid before the headings

Draw the matrix first. Rows list reader roles, columns list task types such as setup, daily use, troubleshooting and administration. Mark each cell as needed, optional or not applicable. In the dental example, the front desk needs daily use and troubleshooting, the manager needs reporting and permissions, and IT needs setup and security. Only then convert filled cells into headings. This order prevents the common failure of copying the product menu into the table of contents. Publish the grid itself on the page, because it demonstrates the method visitors would be buying.

Step three: annotate and invite a response — MatrixWritingA useful path from inputto understanding

03

Step three: annotate and invite a response

Under each proposed section add one short note explaining who it serves, what the reader should be able to do afterward and how long it should run. Include a brief line on how you would check accuracy, such as review by a subject expert and a test read by a new user. Close with a plain invitation to request an outline for the visitor's own product, describing what information you would need. Keep the page short, scannable and printable, so a manager can forward it to colleagues without rewriting anything or adding commentary of their own.

Brand direction

Explore MatrixWriting

Held for potential development. Acquisition inquiries may be considered.

Domain options ↗