Akademy/2018/DocumentationTraining: Difference between revisions
change speaker |
m remove bogus media include |
||
| 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 | '''Time and place:''' Friday, Aug 17th, 9:30 - 10:30 (talk), 10:30 - 12:30 (practical work on KDE documentation) (preliminary time), Room 121 | ||
| 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. | ||
In the final part of this workshop, we will discuss existing KDE documentation and you will be able to work on improving it. | |||
'''Participants:''' | '''Participants:''' | ||
Revision as of 11:19, 15 August 2018
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.
Participants:
- Camilo Higuita(camiloh)
- Caio Jordão Carvalho (cjlcarvalho)
- Kevin Kofler
- Dileep Sankhla
- Sandro Andrade
- Michael Pyne
- Bhushan Shah
- Neofytos Kolokotronis
- Abhijeet Sharma
- Kåre Särs
- Maria Jessica Wiesinger
- Bhavisha Dhruve
- Devaja Shah
- Louise Stolborg
- Sune Vuorela (svuorela)
- Valorie Zimmerman (valorie)