A Complete Docs as Code Workflow — A Case Study of the platformOS Developer Portal

  • Fachvortrag
  • Software Documentation
  • 11. Juni
  • 11:00 - 12:00 Uhr (MEZ)
  • | Online
  • beendet
  • Folien
  •  Diana Lakatos

    Diana Lakatos

    • platformOS

Inhalt

See a real-life example of a complete docs as code workflow. In this session, Diana Lakatos shows you how they produce and manage content, use plain text formats, a style guide and templates, track issues, and review and edit contributions from a fully remote team and community for their UKTC Award winning developer portal.

Was der Zuhörer lernt

Learn about docs as code including a complete editorial workflow for remote teams, examples of content, style guide, templates, and insights into developer relations and community contributions.

Vorkenntnisse

I will briefly explain all main concepts like docs as code and CI/CD in my presentation but I think it would help audience members to be familiar with the basics of technical writing (e.g. what text formats are, what is a style guide, what is an editorial workflow, etc.).

Referent(in)

 Diana Lakatos

Diana Lakatos

  • platformOS
Biografie

I'm a Technical Writer specialised in developer documentation. As the Director of Documentation, I developed the documentation processes for the platformOS Developer Portal. I manage the editorial workflow, create templates, incorporate best practices, and write, edit, and review content.