Hello. I’m Mariam Yusuff, a Technical Writer specializing in APIs, DevOps, and Cloud documentation.
I help developers and product teams transform complex systems such as APIs, CI/CD workflows, and infrastructure, into clear, actionable documentation that:
- Reduces onboarding time
- Minimizes confusion
- Boosts developer productivity
My mission: to bridge the gap between humans and technology, one clear explanation at a time.
🚀 Want to elevate your product docs or API guides?
Let’s collaborate →
| Project | Overview |
|---|---|
| Documentation auditing & SSGs | Explored SSGs and refined the documentation for PixiEditor, an open source 2D drawing tool, focusing on structure, clarity, and consistency |
| API documentation & OpenAPI | Enhanced documentation for Chimoney API, rendered OpenAPI specs, and drafted new Dribbble API Quickstart & Authentication pages. |
| 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 |
| Docs automation | Implemented automated checks using Vale, Spectral, and GitHub Actions to ensure style consistency, link integrity, and build reliability across projects |
| AI for documentation | Documented a model card for Qwen-3 and used AI-assisted techniques to generate FAQ sections for accessibility. |
| Technical writing in Web3 | Documented two endpoints of the Moralis Web3 API, creating clear reference guides that simplify blockchain concepts for developers |
- 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.
Docusaurus • Markdown • OpenAPI • GitHub Actions • Vale • Spectral • Postman • CI/CD
- 📞 +2348069794294
- 📫 Email: [email protected]
- 💻 GitHub: github.com/MwithHeart
- 💼 LinkedIn: linkedin.com/in/yusuff-mariam
- 📝 Hashnode: mwithheart.hashnode.dev
💬 Let’s talk about improving developer experiences through documentation.