Technical writing & related work
Overview
- Technical editor/writer available for contract work in software and developer documentation
- Background in software engineering and technical education
- Comfortable in all online documentation publishing platforms and docs-as-code workflows
- Experience with API documentation, including OpenAPI reference generation and interactive API documentation
Writing samples
- LXD - How to set up a virtual IP for high availability (PDF)
- LXD - How to harden security (PDF)
- Understanding local vs. distributed storage in MicroCloud (PDF)
- MicroCloud’s networking approach (PDF)
- FluidStack - Get Started (PDF)
- FluidStack - How to use the Python SDK (PDF)
- FluidStack - How to use SSH keys (PDF)
- MobiusWP (PDF)
- Fern Quickstart (PDF)
- Docusaurus Opens in a new tab
- OpenAPI reference generation Opens in a new tab
API documentation presentation
In 2024, I presented a talk on Web API Documentation & OpenAPI for the local chapter of the Society for Technical Communication Opens in a new tab . It included an interactive demonstration, in which attendees used cURL Opens in a new tab commands to send requests to an API server Opens in a new tab . I’m a huge believer in hands-on learning — you can read many pages about a topic, but it’s when you do something with it that you truly start to understand it.Find out more about that talk here: