Akademy/2018/DocumentationTraining: Difference between revisions
Appearance
Line 1: | Line 1: | ||
=Training "Documentation writing for non-writers"= | [[Media:Example.ogg]]=Training "Documentation writing for non-writers"= | ||
Time and place: Friday, Aug 17th, 9:30 - 12:30 (preliminary time), Room 121 | Time and place: Friday, Aug 17th, 9:30 - 12:30 (preliminary time), Room 121 | ||
Line 29: | Line 29: | ||
# Maria Jessica Wiesinger | # Maria Jessica Wiesinger | ||
# Bhavisha Dhruve | # Bhavisha Dhruve | ||
# Devaja Shah | # Devaja Shah | ||
# Louise Stolborg | # Louise Stolborg | ||
# Sune Vuorela (svuorela) | # Sune Vuorela (svuorela) | ||
# Valorie Zimmerman (valorie) |
Revision as of 09:53, 15 August 2018
Media:Example.ogg=Training "Documentation writing for non-writers"=
Time and place: Friday, Aug 17th, 9:30 - 12:30 (preliminary time), Room 121
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).
Get to know universal principles that 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:
- 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)