Technical Writing
Projects and Samples
REST API Documentation
Let me help you provide documentation for your REST-based API. I'll work with your technical subject matter experts to create crisp, clean copy describing your interface's endpoints, parameters, requests, and responses. I'll structure your content either using the OpenAPI spec or your spec of preference.
Using either your preferred tools or applications like Postman, Stoplight Studio, and Swagger Editor, I will dig through your JSON to find the right structure for your documentation, whether it be the core reference material or the "Getting Started" section.
Follow this link to see a sample I've mocked up on Postman [INSERT LINK].
Software Documentation
I'm currently in development on a technical writing sample for software documentation. That said, I've used the the Sphinx library in Python to create documentation projects based on YAML markup files, and I've also used Oxygen XML Editor to create DITA projects for an XML-based workflow.
As a technical writer working on your project, I'll collaborate with your team to dig through your UML diagrams and find to right approach for varied user profiles.
Other Technical Writing
The descriptor "technical writer" describes many roles amid countless disciplines, and many of those require advanced degrees and training. While I do not have an advanced degree, I am hopelessly interested in science and technology. I am confident that I can help you with your project regardless of its complexity.
Many years ago, I worked as the News Editor for Bio Online, a biotechnology and pharmaceutical news portal. I was lucky enough to be working at that now-defunct website when the human genome was first sequenced. With an audience largely consisting of bench scientists, I explored the state of the art in their field.
I would love the opportunity to help make your nerdiest content more palatable to interested audiences like me. Here is an example of a technical writing sample I recently prepared for a prospective employer. In this example, I explored a DITA-based approach to creating an car owner's manual (OEM). [INSERT LINK]