MY
Mariam Yusuff
Technical Writer specializing in APIs, DevOps, and Cloud documentation
About Me
Technical Writer specializing in API documentation and DevOps, with a passion for simplifying complex concepts into clear, developer-friendly docs. Experienced with Docs-as-Code workflows, CI/CD pipelines, and static site generators like Docusaurus. Collaborative, detail-oriented, and committed to improving developer experience through technical accuracy and clarity.
Skills
Technical Skills
- GitHub
- Swagger
- Postman
- Markdown
- VS Code
- Google Docs
- Docusaurus
- Vercel
- Mintlify
- CI/CD concepts (pipelines, workflows, automation)
- Developer documentation
- API documentation
- REST APIs
- Python basics
- Style guides
Soft Skills
- Collaboration
- Teamwork
- Communication
- Time Management
- Attention to detail
- Adaptability
- Critical Thinking
Experience
Personal Documentation Projects • Aug 2025 - Present
PixiEditor Documentation Refinement
- Optimized the content structure of an open-source 2D graphics editor using Docusaurus and Markdown, improving readability and reducing cognitive load on users
- View Project → PixiEditor Documentation
DevOps CI/CD Documentation
- Documented a complete guide for setting up GitHub Actions with Lychee Broken Link Checker, showcasing knowledge of pipelines and workflow automation
- View Project → CI/CD Guide
Chimoney API Reference
- Documented two API endpoints for the fintech using Swagger and tested with Postman; improved endpoint clarity and usability
- View Project → Chimoney API Reference
Dribble API Docs
- Created Quickstart and Authentication guides while applying Docs-as-Code approach to reduce onboarding time for developers.
- View Project → Dribble API Docs
Technical Writer (Volunteer)
The BIRDS Satellite Project • Dec 2024 - June 2025
- Rewrote and structured existing documentation using the Docs-as-Code approach
- Developed glossaries and structured new documentation to improve usability and comprehension
Education
Technical Writing Accelerator Program
WriteTech Hub • 2025 - Present
Advanced training in technical writing best practices and modern documentation tools.
Technical Writing Certification
WriteTech Hub • June 2024
Comprehensive training in technical documentation principles and practices.