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

  • Fachvortrag
  • Softwaredokumentation
  • 11. Juni
  • 11:00 - 12:00 AM (MEZ)
  • 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.

Das lernen Sie

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.
https://live.tekom.de/evolution21/conference/conference-program/detail/a-complete-docs-as-code-workflow-a-case-study-of-the-platformos-developer-portal
live.tekom.de
CC-MAIN-2024-26
38854
application/http; msgtype=response
sha1:XUER2WJMOHVQQCJL4MMAICJYHNUHHZT7
<urn:uuid:b0827f78-3644-4530-9b86-f1dd55f12818>
2024-06-16T10:07:14Z
159.69.64.87
text/html
sha1:YEEIJYM7YYEU7W5NLMW434QEDFQD7THU
<urn:uuid:38675c52-9470-4a2a-a6b0-0b3fd7abe428>
https://live.tekom.de/evolution21/conference/conference-program/detail/a-complete-docs-as-code-workflow-a-case-study-of-the-platformos-developer-portal
response
<urn:uuid:dd9dee48-6a4b-46a1-936e-ab2c8ce98617>
isPartOf: CC-MAIN-2024-26
publisher: Common Crawl
description: Wide crawl of the web for June 2024
operator: Common Crawl Admin (info@commoncrawl.org)
hostname: ip-10-67-67-105
software: Apache Nutch 1.20 (modified, https://github.com/commoncrawl/nutch/)
robots: checked via crawler-commons 1.5-SNAPSHOT (https://github.com/crawler-commons/crawler-commons)
format: WARC File Format 1.1
conformsTo: https://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/