


How to build developer documentation in a fully remote team for a community scattered all over the globe? In our session at DevRelCon Earth 2020, we showed the steps and iterations in our journey of building the platformOS developer portal, and talked about the approaches, processes, and tools we used from the discovery phase that led to the platformOS team winning the UKTC Award.
Information Architecture
Approaches discussed: Design Thinking, personas, remote UX workshops, card sorting, remote usability testing
Tools discussed: content inventory, sitemap, online research tools, Mural, Miro, Figma, lookback, playbookUX, UsabilityHub, OptimalWorkshop, SurveyMonkey, HotJar
Layouts, navigation, and design
Approaches discussed: iterative design, branding
Tools discussed: wireframes, Sketch, Figma
Content production
Approaches discussed: Content First, open source, community contributions, editorial workflow for distributed communities
Tools discussed: style guide, templates, Markdown, GitHub
Implementation
Approaches discussed: docs as code, auto-generated documentation, automated tests, extreme performance
Tools discussed: GitHub, performance tests
Approaches discussed: community-driven documentation, contributor experience, user research, feedback, asynchronous communication
Tools discussed: contributor guide, status reports, release notes, roadmap, blog, real-time chat, video conferencing
Ensure your project’s success with the power of platformOS.