Skip to main content

Welcome

Mariam Yusuff

Technical Writer | API & ML Documentation Specialist

About me

I transform complex technical concepts into clear, accessible documentation that helps developers and teams succeed.

Reduce onboarding time

Clear documentation that helps new developers get up to speed quickly.

Minimize confusion

Precise, well-structured content that answers questions before they're asked.

Boost productivity

Documentation that helps developers focus on building, not figuring things out.

Let's Work Together →

Core expertise & featured projects

01. Documentation auditing & SSGs

Explored Static Site Generators and refined the documentation for PixiEditor, an open source 2D drawing tool, focusing on structure, clarity, and consistency.

  • View Project →

    • 02. API documentation & OpenAPI

    Enhanced documentation for Chimoney API, rendered OpenAPI specs, and drafted new Dribbble API Quickstart & Authentication pages.

  • View Project →

    • 03. DevOps & Cloud documentation

    Created a step-by-step guide for setting up GitHub Actions, including a sample CI/CD pipeline with Lychee broken-link checker.

  • View Project →

    • 04. Documentation automation

    Implemented automated checks using Vale, Spectral, and GitHub Actions to ensure style consistency, link integrity, and build reliability across projects

  • View Project →

    • 05. AI for documentation

    Documented a model card for Qwen-3 and used AI-assisted techniques to generate FAQ sections for accessibility.

  • View Project →

    • 06. Technical writing in Web3

    Documented two endpoints of the Moralis Web3 API, creating clear reference guides that simplify blockchain concepts for developers.

  • View Project →

    • My approach

    • Collaboration: Partnering with engineers, designers, and PMs to build docs grounded in real workflows.
    • Continuous learning: Every project is an opportunity to learn a new tool, framework, or documentation best practice.
    • Clarity & empathy: Writing for both the engineer and the end-user, because great docs serve both.

    Tools & technologies​

    Docusaurus • Markdown • OpenAPI • GitHub Actions • Vale • Spectral • Postman • CI/CD

    Connect with me

    💬 Let’s talk about improving developer experiences through documentation.