Example manual: publish your first guide

Before you start

This example shows how to organize a task in a manual using the actual Manual Tools publishing workflow. You need a signed-in account, a product or process to document, and permission to use any files you upload. One manual is included in the free plan.

Expected result: A guide with a table of contents, a published reader link, and a downloadable PDF of the release.

Write the guide

1. Open your workspace and choose New manual. Give the manual a title that identifies the product or process.
2. Add a topic for the first reader task. Give it a title a reader can recognize in the table of contents.
3. Write the starting conditions, numbered actions, and expected result. Add images or tables where they explain a detail.
4. Add the remaining topics. Reorder or nest them to create a clear path through the guide.

Your topic changes autosave in the draft. If a save fails or a conflict appears, keep the local draft available while you review the message.

Review the draft

1. Follow each task from the stated starting point. Check labels, product versions, units, and results.
2. Ask someone familiar with the product to review the instructions and any safety information.
3. Check the media and links. Add the publishing organization's name and a way for readers to report an issue.

Use the review checklist to keep the checks consistent.

Publish for readers

1. Choose Publish in the editor.
2. Select public or private reader access. Private access requires the paid plan.
3. Choose whether search engines may index the manual. Indexing starts disabled.
4. Confirm publication and wait for it to complete. Open the reader link and check the released guide.
5. Choose Generate PDF for an offline copy. Open the exported file and check the pages.

After publication, further saves remain in the draft. Publish again when those changes are ready for readers.

Troubleshooting

The reader shows an earlier instruction

Check whether the changed draft has been published. The reader uses the last published release.

A private reader cannot open the guide

Check the invited email address or access key, its expiry, and whether access was revoked.

The PDF differs from the draft

PDFs use published content. Publish the reviewed draft, then generate a new PDF.

A problem continues

Keep the manual URL and the error message, then contact support. Do not include passwords or access keys in the request.