Implementing a docs-as-code workflow
ScyllaDB - 2020
I'm helping ScyllaDB to modernize their documentation stack and break their core docs into multiple independent projects. Hoping to be able to share more soon!
Work
Here are a few projects I've done for clients. It's not a complete list, but a sneak peek to show what I can do for you.
Launching a developer portal
NEM.io Foundation Ltd - 2019
Working closely with the engineering team and the community to launch the Symbol documentation portal.
Over the space of two years, I owned the product documentation roadmap for the new product and authored resources to onboard developers, including reference documentation, how-to guides, and sample applications.
Designing a CLI tool
NEM.io Foundation - 2018
Working with NEM to design and implement the Symbol CLI, the tool that helps developers to architect blockchain-based solutions from the command line prompt.
Ways I can help you
Writing documentation for developers
I author straightforward but complete documentation for your product, including guides for technical audiences, OpenAPI specifications, and sample applications.
Launching a developer portal
How to structure the content? Where should docs live? Which tools should you use? Who will maintain them? How long will it take? Together, we review the status of your documentation, answer all these questions, and take action.
Automating workflows
Automate literally anything you can think of, including migrating platforms, running tests, publishing builds to production, previewing PRs, linting your docs and code, and much more. GitHub Actions, Netlify CI and Vale linter are my tools of trade.
Designing APIs
Your API is the entry point for newcomers, and it needs to be the very best to accelerate the product adoption. Let me play with it and share with you recommendations to enhance the developer experience.