Projects

API Documentation

In progress: Documentation of a fictitious REST API.

The endpoints documentation is generated with an OAS file and rendered by SwaggerHub. The guides are hosted in WordPress.

Click here to read the sample documentation.

How-to guide

Help Minecraft builders join a Minehut server where they can play together.

The audience is already familiar with Minecraft and only needs help setting up the server correctly to join the group.

Click here to read the sample guide.

Documentation brief template

Confluence template developed to ensure the success of a technical documentation project.

The audience is a technical writer with project management experience.

Click here to view or download the PDF.

Click here for more information on documentation briefs.

Client implementation guide

Training material for a fictitious client implementation team whose role is to onboard new clients.

The audience is technical and knowledgeable.

Click here to view or download the PDF.