Portfolio
Sample 1: Software User Guide
HospitalRun is a free, open-source health information system software. HospitalRun faces two major problems: it has no documentation and it is a large software with multiple discrete audiences. I learned the software and researched hospital workflows to identify the main audience and limit the scope of the project.
​
HospitalRun is aimed at hospitals and clinics with limited resources, including staff, so I created a user guide for the hospital administrator user who is responsible for configuring, maintaining, and using the software daily.
​
I created and followed project plan deadlines in order to complete every aspect of the project independently, from proposal to sending to print.
​
Using FrameMaker, I created templates to ensure consistency throughout the guide. I also used a TOC, mini-TOCs, an index, and cross-references to create scannability and multiple points of access.
See a larger sample.
Sample 2: Whitepaper
This whitepaper explores why the emerging technology of swarm robotics is integral to forwarding space exploration.
I limited the scope by researching in which fields swarm robotics has an application and by identifying the audience that would benefit from understanding this topic.
​
This paper uses the structure for the whitepaper genre so that the reader knows what to expect and where to find information. I used a clear hierarchy of headings to make the text scannable and callouts that offset additional information related to the topic.
See my resume
Contact me
See the full sample.
Sample 3: Online Help
I used MadCap Flare to create an online help site for OverDrive, an app for borrowing electronic materials from libraries, including Toronto Public Library.
​
I created multiple points of access by using glossary, index, and cross-references. I also created micro-content for topics that are most likely to be searched by readers.
​
I used single-sourcing for the content that appears in more than one topic to reduce time spent on editing and any future changes.
​
To achieve a cohesive look, I used an online tool to create a colour palette from the company's brand guidelines and styled the project template using CSS.
Sample 4: API Documentation
In this project, our team was given a list of API definitions to document that allow third-party developers create solutions for managing vehicle orders.
​
I used the Swagger Editor to describe the APIs in order to use the standard OpenAPI Specification. I wrote the schemas and an API method that allows users to create a new vehicle order.
​
Additionally, I created a repository on GitHub for the project and used Render to create a static site to showcase the final output.
​
This project allowed me to discover a new skill. As someone who loves learning, my next step is to complete a course in documenting APIs.
Contact me
See my resume
Note: These samples were written for educational assignments only and do not portray work done directly for any of the mentioned companies.