Join us at Write The Docs Prague 2020

Write the Docs brings everyone who writes the docs together in the same room: Programmers, Tech Writers, Support, Designers, Developer Advocates, and more. Join us online at Write The Docs Prague on Oct 18-20, 2020, where we will speak about Helping Your Community Contribute to Developer Documentation.

How to encourage and help your community to contribute to your developer documentation? In this session, Diana Lakatos shows you various — fully remote — processes platformOS developed to help community members contribute content and code to their UKTC Award-winning developer portal.

Processes

• How the platformOS team developed a fully remote editorial workflow that everyone can be a part of (developers, writers, product owners, etc.)
• Why we follow the docs as code approach and how we implemented it through GitHub
• How we facilitate the contribution of code and content
• How we continuously improve contributor experience and reward contributions

Tools

• How we iteratively developed our Documentation Style Guide and how we use it
• How we help contributors by providing templates for specific types of content (concept topics, tutorials, etc.)
• Why we chose the Markdown format and how we use it

Communication

• How we communicate with community members
• How we collect and use feedback from our community for all aspects of our documentation (content, design, navigation, etc.)
• How we encourage people to write who are otherwise not confident in their writing skills or don’t enjoy writing

Write the Docs conferences cover a wide range of topics related to documentation in the software industry — check out all conference speakers and their session abstracts. 

We will share the schedule with you as soon as it becomes available. See you there! 

Documentation 

Content production 

• PLANNED Review documentation accessibility
• PLANNED Update GraphQL `or` example 
• PLANNED Explain property argument in the compact filter
  

Development

To learn more about the most recent changes, improvements and fixes in platformOS, check out our latest release note: platformOS Release Note Sep 7, 2020 — Deleted user profiles not returned by default

• IMPROVED Do not include deleted UserProfiles in GraphQL results 

------

Subscribe: get weekly reports in email