Portfolio
Below are some samples of previous work. This includes user guides, developer docs, and an internal style guide.
Skills Used
- Technical Writing
- Developer Collaboration
- Technical Editing
- Writer Collaboration
- Research
- Learning Software
- Process Development
WooCommerce Subscriptions
WooCommerce Subscriptions is a complex, popular extension used with WooCommerce and WordPress to allow an online store to sell on a subscription model. This software is used by store managers to run their store, as well as their customers to buy from the store. The documentation I worked on is for end-users and developers and was often made in collaboration with other writers or built upon previous versions.
In writing the Subscriptions documentation I was working within the guidelines of the broader WooCommerce ecosystem. The process included software research, drafting, review, collaboration, and publishing.
Subscriptions Early Renewal Guide
This document is a guide for users to understand and use an early renewal feature. This includes instructions for store managers, some FAQs, and a developer reference. The process in generating this document included exploring the software to understand the feature and acquire screenshots, consulting with developers, and observing the conventions of the wider WooCommerce documentation ecosystem.
Subscriptions Limited Payment Coupon Guide
This is a guide for users to understand a specific coupon feature. This includes what the store manager will view as well as what their customers will view. It also delves into some specific use cases and different scenarios that can come about with the use of these coupons. This document was a result of collaboration with developers and writers as well as exploration of different technical possibilities with the software.
Subscriptions and the GDPR
This document is both for users to understand more about how this software deals with their data and for store managers to learn how to use the offered tools for GDPR compliance. This included learning about how the wider WordPress ecosystems handles GDPR compliance and elaborating on how the subscriptions software builds on that system.
Documentation Workflow & Style Guide
This sample represents a process for the documentation-writing workflow used internally for our team. This was drafted to standardize the process our team used to write and edit the documentation. This also includes a brief style guide to aid other developers in their documentation writing.