Technical Writing Samples

The samples in this book have been designed to help you implement your own Technical Writing Process. They’re available free to subscribers of this book. Use and adapt them as required to suit your project.

To access the samples:

  1. Subscribe to the Boffin Education website. Purchasers of the paperback or e-book version can use the coupon code located in this chapter for one year of free access to all content on the site, including the online version of this book.
  2. Download the samples in their original Microsoft Office format. They’ve been created in common Microsoft Office programs: Word, Excel, PowerPoint, and Project.

Here are several helpful tips for using the samples:

  • Text in [square brackets] is placeholder text for you to replace with your own version. Don’t leave the text in square brackets in your version.
  • Text in italics is instructions on using the samples. Don’t leave the instructions in your version.

The samples have been designed to be as easy to use as possible. However, they do assume a level of basic competence with the Microsoft Office program they were created in.

You may have to adjust the size of tables or spreadsheet columns to suit your requirements.

SampleShort Description
Sample Document Control TableFramework for managing key information in your documents, such as document ID, version, revision history, and approval details.
Sample Documentation Project SchedulePractical example of how to organize and manage the timing of tasks in a technical documentation project.
Sample Message to Stakeholders Announcing PublicationSample wording for a formal announcement to stakeholders about the successful publication of a document, acknowledging contributions, and providing access information.
Sample Request for ApprovalSample wording for an email seeking the final approval of a document. Outlines the context, timeframe, approval mechanism, and individual approval responsibilities.
Sample Request for ReviewSample wording for requesting stakeholders to review a document. Focuses on their role in the review process and the expected timeline.
Sample User GuidePractical example of structuring techniques in technical documentation, using a fictional scenario of an intraoperative surgical device.