Docs as Code 101: Bridging the Gap Between Writers and Developers
- Presentation
- Docs as Code
-
27. May
-
11:20
AM
(CEST)
- 12:00
PM
(CEST)
-
E.11 Training Room
Contents
'Docs as Code 101: Bridging the Gap Between Writers and Developers' is a an entry-level presentation of the Docs-as-Code method for creation and management of technical content.
Docs as Code is a method based on the idea that technical documentation should be created and managed using the same tools as code. This includes following the same workflows as development teams and integrating writers into the product team, with the main benefits being improved communication and collaboration between writers and developers.
The main purpose of the presentation is to introduce the audience to what this method is all about, showcase its main principles and benefits, demonstrate live how content is created, and then mention the most commonly used tools. It consists of a theoretical introduction to the topic and a live demonstration done by the presenters.
Takeaways
Participants will learn:
- What Docs as Code is
- Why and when Docs as Code is a worthwhile approach
- How to work with the Docs as Code approach
- Which tools are available for employing Docs as Code
Prior knowledge
No prior knowledge needed
Speakers
Biography
A philologist by training, a writer and language lover at heart, Ekaterina Stoyanova enjoys working on a variety of technical communication tasks such as maintenance of product user guides, translation, editorial support and content consulting. Her previous experience includes the traditional approach to technical content creation using CMS tools, while her current daily work involves the use of various tools, including wikis, translation tools and software for creation of web-based trainings.
An integral part of her daily work is the creation and maintenance of software documentation using the innovative Docs-as-Code method, for which she happily shares her knowledge with anyone who is interested.
Biography
As an experienced technical writer, Anita Lüders is familiar with a wide range of approaches to creating information products in technical communication. Her expertise spans from traditional content management systems (CCMS) and wikis to modern software documentation practices like Docs as Code.
Many editorial teams, in companies of all sizes, are either already using or considering the Docs as Code method. To address this growing interest, Anita is dedicated to sharing her knowledge on the subject. Her goal is to empower technical writers to make well-informed decisions about adopting this innovative approach.