A collection of technical writing samples, including user guides, FAQs, and documentation.
API Documentation Public / No-Auth APIs
Lightweight APIs perfect for learning, testing, or demo purposes.
- JSON Placeholder API Markdown file | PDF
- Reqres API Documentation Markdown file
- Rook Memory Management API Markdown file | PDF
Authenticated APIs (Intermediate–Advanced) These documentation samples reflect more advanced interaction with APIs that require authentication, including handling tokens, building multi-step workflows, and demonstrating real-world developer use cases.
This markdown-based documentation demonstrates a complete, real-world API interaction flow using the Spotify Web API.
It guides developers through:
- Authenticating via the Client Credentials Flow
- Searching for an artist by name
- Retrieving the artist’s albums
- Accessing their top tracks by market
The guide includes:
- Clear endpoint descriptions
- Sample requests and responses (using real artist IDs)
- Parameter explanations
- Practical notes on query customization
- A professional error handling reference table
What This Demonstrates:
- Hands-on experience using REST APIs with Postman
- Understanding of OAuth 2.0 authentication (Client Credentials Flow)
- Ability to interpret and document API endpoints
- Clarity in technical communication using Markdown
- Organizing complex data flows into readable developer-facing documentation
- Providing practical developer guidance for chaining API requests
Accessibility & Compliance Documentation:
- How to Correct Common Web Accessibility Issues - A guide to correct the most common ADA web page issues.
- How to Optimize Your Flyers for ADA - A guide to prepare your flyers to export to live text in PDF using settings in Adobe InDesign and Adobe Illustrator.
- Compliancy Policy: Ensuring Content Accessibility - Compliance Policy for Accessible Content.
SEO & Content Writing:
- Creating SEO Friendly Web Content - A brief guide to creating web content that is search engine optimized.
User Guides:
- OmniCMS Quick Guide for Page Management
- DataCleaner User Guide - A user guide installing the Datacleaner application.
- How to Convert a Markdown file to PDF - Step by Step instructions on converting a Markdown .md file to a PDF document.
More samples of my writing will be added to expand this portfolio.
I specialize in technical writing, documentation, and content management, with a focus on clear and user-friendly documentation. My skills include:
- Digital Accessibility
- Writing & structuring documentation in Markdown
- Creating user guides, FAQs, and SaaS documentation
- Organizing content for clarity, accessibility, and SEO
- Publishing technical content on GitHub & WordPress
- Graphic Design
- HTML, CSS, Bootstrap
- AI-Assisted Content Strategy
- Critical Thinking & Research
- Portfolio Website: Website
- LinkedIn: LinkedIn Profile
- GitHub: Your GitHub Profile