Portfolio
As a technical writer and editor, the documents I work on for organizations and clients are their property. To showcase my skills, I have created a set of samples. Some are written entirely from scratch, while others are adapted from selected sections of comprehensive guides I worked on. These samples highlight different aspects of my writing and editing abilities while respecting confidentiality and ownership rights. They are not official product documentation.
Quick Start Guide
I created this sample to help new Brizy users build a one-page website with ease. My focus was on clear steps, simple language, and a clean layout to match Brizy's design-first philosophy and brand voice. I have built my own WordPress site using Brizy, so I am familiar with the product, but I noticed that most of its instructions are video-based. This gap gave me the opportunity to create something new. This sample showcases my ability to translate workflows into user-centered documentation that also aligns with a brand's voice.
The creation process involved:
- Defining the key tasks to be documented
- Designing the structure and flow of the guide
- Selecting the template, fonts, layout, and visuals
- Documenting the workflow
- Building a sample site in Brizy to capture step-by-step procedures
- Ensuring accuracy through hands-on testing
- Editing and proofreading
- Publishing the final guide
Configuration Guide
This sample is based on a detailed configuration guide and includes both conceptual and task-based topics. It demonstrates my ability to present complex technical information in clear, structured, and easy-to-follow documentation.
The creation process involved:
- Understanding features and use cases
- Structuring the guide to identify concept, task, and reference topics
- Ensuring accuracy through hands-on testing and SME reviews
- Editing and proofreading
- Publishing the final guide
REST API Guide
This sample is based on a comprehensive REST API guide. It demonstrates my ability to create clear, structured, and developer-focused API documentation. A Markdown version of the guide is also available, making it easy to review the content in a portable, developer-friendly format.
The guide describes the API authentication method, endpoint structure, request parameters, and response formats. It includes request and response examples to show how developers can use the API to automate configuration and management tasks.
To complement the written documentation, I also created an OpenAPI specification for the API and generated interactive Swagger documentation. The live Swagger interface allows users to explore endpoints and view request and response schemas.
The creation process involved:
- Understanding API design, workflows, and use cases
- Documenting endpoints, parameters, and request and response examples
- Ensuring accuracy through hands-on testing
- Creating an OpenAPI specification to define endpoints, request bodies, and response schemas
- Generating interactive Swagger documentation from the OpenAPI file
- Verifying examples for consistency
- Editing and proofreading
- Publishing the final guide
Setup Guide
This sample is based on a quick start guide and focuses on guiding users through initial platform setup and configuration. It includes task-oriented content and demonstrates my ability to create concise, user-focused documentation for a first-time experience.
The creation process involved:
- Understanding product capabilities and setup workflows
- Identifying and organising setup tasks in a logical sequence
- Writing clear procedures
- Ensuring accuracy through hands-on testing and SME reviews
- Editing and proofreading
- Getting required approvals
- Publishing the final guide
Documentation Links
A selection of publicly-accessible guides I worked on during my full-time role as a technical writer:
Knowledge Base
This presentation combines my hands-on experience with various knowledge bases and my perspective on creating them effectively. It outlines the structure, content types, and writing techniques that work best.
I also created a sample knowledge base by reimagining Brizy’s existing knowledge base. As a Brizy user, I found their Academy and YouTube content extremely helpful. This sample explores how information could be brought together into a more centralized, structured, and easy-to-navigate knowledge base.
Original Knowledge Base
Redesigned Knowledge Base
This sample is intended purely as a portfolio exercise. It represents an alternative documentation perspective often brought by technical writers, complementing the excellent work done by engineering and support teams in fast-growing companies. The creation process involved:
- Reviewing existing help articles and video resources
- Identifying opportunities to improve structure, navigation, and user flow
- Designing a documentation-friendly layout in Brizy
- Writing articles using technical writing best practices
To create this sample, I used Brizy itself, which made the process fun and easy. The complete sample is available on request.
UX Writing
This sample is part of the Fundamentals of UX Writing course by UX Content Collective. The course covers everything from developing a voice and tone guide to writing UI elements, such as tooltips, onboarding headlines, microcopy, CTAs, and customer emails. The project in this course is centered around the fictional “Handshake” payments app. It was a valuable hands-on learning experience to craft a copy that is both user-friendly and consistent with a brand’s voice across multiple touchpoints.
Editing
These editing samples include the original and revised sections of a networking guide I edited for a client. My focus was on improving clarity and making the content easier to follow and precise without losing technical accuracy. These samples showcase my ability to turn complex technical content into something polished and user-friendly.
Content Writing
Blending learnings from Patanjali’s Yoga Sutras with the teachings of Lao Tzu and Adyashanti, this article reflects on the importance of stillness and how non-doing can be equally transformative.
A foundational yoga practice course combining clear concepts with practical guidance. This course is designed for structured, self-paced practice.
A yoga tip card from a beginner-friendly deck, offering clear guidance for Tadasana.
