DocOps: Engineering great documentation

DocOps: Engineering great documentation

Great documentation is hard to build, maintain and continually improve on. Developers have exceptionally high expectations when it comes to documentation and will often judge a product on how articulately it communicates how to use the product as much as the actual offerings of the platform or tool itself.

You may have the best product on the market, maybe even the most competitively priced, but if nobody understands how to actually use it then its failure is almost certainly inevitable. Poor documentation often stems from lack of deep insight, the kind of insight where one understands the quirks and edge cases that if not addressed can lead to confusion and a lost customer. It’s important to put documentation into the hands of the people who understand the product the best, to enable people and to allow those who have faced challenges to put it right for the next person.

This talk is about the open-source platform and tools that I built when developing Nexmo Developer and how it has enabled us to build a powerful and flexible platform for writing rich documentation collaboratively with ease. I’ll cover our goals and how we met them, the challenges we faced during development and our tooling including our custom Markdown pipeline, Open API Specification generated API Reference Pages and the various components we use throughout our documentation.

Discover more featured events

Ladies That UX Bristol

Thu Sep 24 2020 at 5:30 PM

Where to do with all the research

👉🏽 Repositories (aka repos). 👈🏽 As UX-ers we sometimes struggle to get enough research done in the first place so it's great when we finally get the research ball rolling and start accumulating eye-opening insight but... what do we do with it all? Survey results, usability test findings and discovery research interviews... where should it all go? How do we make sure knowledge keeps being seen and built upon rather than be put in a dusty report to never be surfaced again?

Jane Hostler (a well versed member of our group!) faced this problem in her work and will be sharing her experiences with us. 🌈

Here's a bit more:

Jane is a User Experience Designer who’s worked in the digital industry for the last 20 years. Primarily working as a UI designer on websites (plus some brief dabbling with front end development back when it was all tables), she landed a new job two years ago that brought the chance to gain product design and research experience and everything that comes with it. Like, what do you do with all that stuff!?

She’ll be giving a quick whistle stop tour of how Airtable has helped her to pull together the feedback and insights she uncovers in this role, and looking at the pros and the cons of Airtable as a research repository.

We're all invited to actively participate in what will definitely be a very interesting conversation and chip in with our own experiences of dealing with insight stacks.

Looking forward to seeing you there. Feel free to BYOB and food, light candles, anything goes! Details for how to join will be provided nearer the time. Please RSVP and feel free to share or invite others. We're @LadiesThatUXBRS on twitter.

1 person is attending this event

Subscribe to our newsletter

No spam. Just simple and infrequent platform updates when something big happens.

© 2020 Limited. All rights reserved.