Akademy/2018/DocumentationTraining: Difference between revisions

Latest revision as of 08:54, 1 April 2020

Time and place: Friday, Aug 17th, 9:30 - 10:30 (talk), 10:30 - 12:30 (practical work on KDE documentation) (preliminary time), Room 121

Trainer: Stefan Knorr, documentation writer at SUSE (filling in for Tanja Roth, documentation writer at SUSE)

You need to write technical documentation now and then? But you are not sure how to structure it, how to phrase your content, or how to best address your readers? This hands-on workshop shows you how to optimize texts to make them easier to understand (and translate).

Get to know universal principles that, to a large extent, can also be applied to other texts types in software projects, like release notes, bug reports, error messages, or e-mails. In a practical exercise, we will analyze existing texts and fix their weak points.

In the final part of this workshop, we will discuss existing KDE documentation and you will be able to work on improving it.

Slides: Link to slides

Participants:

Camilo Higuita(camiloh)
Caio Jordão Carvalho (cjlcarvalho)
Kevin Kofler
Sandro Andrade
Michael Pyne
Bhushan Shah
Neofytos Kolokotronis
Abhijeet Sharma
Maria Jessica Wiesinger
Bhavisha Dhruve
Devaja Shah
Louise Stolborg
Sune Vuorela (svuorela)
Valorie Zimmerman (valorie)
Luigi Toscano (tosky)
Nicolás Alvarez
Jure Repinc
Claus Christensen

@@ Line 1: / Line 1: @@
-=Training in Documentation Writing=
+'''Time and place:''' Friday, Aug 17th, 9:30 - 10:30 (talk), 10:30 - 12:30 (practical work on KDE documentation) (preliminary time), Room 121
-Time and place: Friday, Aug 17th, 9:30 - 12:30 (preliminary time), Room 121
+'''Trainer:''' Stefan Knorr, documentation writer at SUSE ''(filling in for Tanja Roth, documentation writer at SUSE)''
-Trainer: Tanja Roth, professional documentation writer working at SUSE
+You need to write technical documentation now and then? But you are not
+sure how to structure it, how to phrase your content, or how to best
+address your readers? This hands-on workshop shows you how to optimize
+texts to make them easier to understand (and translate).
-Topics: (to be added)
+Get to know universal principles that, to a large extent, can also be applied to other
+texts types in software projects, like release notes, bug reports,
+error messages, or e-mails. In a practical exercise, we will analyze
+existing texts and fix their weak points.
-Participants:
+In the final part of this workshop, we will discuss existing KDE documentation and you will be able to work on improving it.
-* Camilo Higuita(camiloh)
+'''Slides:'''
-* Caio Jordão Carvalho (cjlcarvalho)
+[https://userbase.kde.org/images.userbase/1/10/Tech_writing-akademy18.odp Link to slides]
-* Kevin Kofler
+'''Participants:'''
+# Camilo Higuita(camiloh)
+# Caio Jordão Carvalho (cjlcarvalho)
+# Kevin Kofler
+# Sandro Andrade
+# Michael Pyne
+# Bhushan Shah
+# Neofytos Kolokotronis
+# Abhijeet Sharma
+# Maria Jessica Wiesinger
+# Bhavisha Dhruve
+# Devaja Shah
+# Louise Stolborg
+# Sune Vuorela (svuorela)
+# Valorie Zimmerman (valorie)
+# Luigi Toscano (tosky)
+# Nicolás Alvarez
+# Jure Repinc
+# Claus Christensen