Technical Writing
Developer Documentation
Note: This guide is live on the Avalara Developer website. This PDF file reflects the work I've done and does not include any changes made after November 12, 2024.
At Avalara, I developed a standalone integration guide for software developers that describes the steps and requirements for earning an Address Validation Certification.
​​
As a result, technology partners and API customers have a fuller and intuitively designed guide to integrate the address validation service via AvaTax APIs.
Tools Used
-
MadCap Flare
-
Acrolinx
-
Swagger
-
Visual Studio Code
-
GitLab
-
​Avalara Style Guide
Skills Demonstrated
-
Developer Documentation
-
API Documentation​
-
Style Guide Adherence
-
Search Engine Optimization (SEO)
Background
During my internship, I had the invaluable opportunity to create an integration guide specifically designed for developers leveraging the AvaTax REST APIs to validate and resolve addresses within their systems—be it for e-commerce platforms or online marketplaces. This guide equips them with the vital information they need to succeed.
Design Process
I crafted this guide to mirror the structure of existing integration documents, making it an integral part of our comprehensive collection. Utilizing MadCap Flare, a cutting-edge help authoring tool for content management and publication, I ensured the content was polished with Acrolinx while rigorously adhering to the Avalara style guide.
Result
Quality documentation is critical for software engineers, enabling them to effectively utilize one another's code in building innovative systems. My objective is to empower developers with straightforward and easy-to-follow documentation, as exemplified in this guide, fostering collaboration and efficiency.
Email Signature Print Instructions
Sometimes, you only need something simple like an email signature to make yourself appear professional.
​​
I designed these print instructions for an older audience, showing them the steps they can complete to create a stunning email signature in Microsoft Outlook while maintaining Microsoft's style guide and branding.
Tools Used
-
Canva
-
Microsoft Writing Style Guide
Skills Demonstrated
-
Instructional Design
-
Audience Analysis​
-
Accessibility​
-
Brand Consistency
Background
Inspired by my mother, a Peruvian woman, I wanted to design an easy-to-follow resource tailored to her needs. She uses Outlook for her job but only knows how to read and send emails. By giving her this useful guide, I aim to empower her to present herself more professionally in her communications.
Design Process
The instructions feature helpful screenshots and indicators that visually guide readers through each action. I’ve carefully chosen large, readable typography to ensure accessibility for those who may struggle with eyesight due to age. This detail makes the instructions welcoming and easy to navigate.
Result
Written in an engaging and friendly tone, these instructions prevent boredom and eliminate any feelings of condescension. I’ve incorporated Microsoft’s branding elements, including its logo and colors, to enhance familiarity. By simplifying the process with the fewest necessary steps, I’m excited to help users effortlessly achieve a polished email signature.