Akademy/2018/DocumentationTraining: Difference between revisions
mNo edit summary |
mNo edit summary |
||
| (10 intermediate revisions by 9 users not shown) | |||
| Line 1: | Line 1: | ||
'''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 | You need to write technical documentation now and then? But you are not | ||
| Line 10: | Line 8: | ||
texts to make them easier to understand (and translate). | texts to make them easier to understand (and translate). | ||
Get to know universal principles that can also be applied to other | 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, | texts types in software projects, like release notes, bug reports, | ||
error messages, or e-mails. In a practical exercise, we will analyze | error messages, or e-mails. In a practical exercise, we will analyze | ||
existing texts and fix their weak points. | 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. | ||
'''Slides:''' | |||
[https://userbase.kde.org/images.userbase/1/10/Tech_writing-akademy18.odp Link to slides] | |||
'''Participants:''' | |||
# Camilo Higuita(camiloh) | # Camilo Higuita(camiloh) | ||
# Caio Jordão Carvalho (cjlcarvalho) | # Caio Jordão Carvalho (cjlcarvalho) | ||
# Kevin Kofler | # Kevin Kofler | ||
# Sandro Andrade | # Sandro Andrade | ||
# Michael Pyne | # Michael Pyne | ||
| Line 26: | Line 28: | ||
# Neofytos Kolokotronis | # Neofytos Kolokotronis | ||
# Abhijeet Sharma | # Abhijeet Sharma | ||
# Maria Jessica Wiesinger | # Maria Jessica Wiesinger | ||
# Bhavisha Dhruve | # Bhavisha Dhruve | ||
# Devaja Shah | # Devaja Shah | ||
# Louise Stolborg | |||
# Sune Vuorela (svuorela) | |||
# Valorie Zimmerman (valorie) | |||
# Luigi Toscano (tosky) | |||
# Nicolás Alvarez | |||
# Jure Repinc | |||
# Claus Christensen | |||
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