Akademy/2018/DocumentationTraining: Difference between revisions
No edit summary |
Added mpyne |
||
| Line 22: | Line 22: | ||
* Dileep Sankhla | * Dileep Sankhla | ||
* Sandro Andrade | * Sandro Andrade | ||
* Michael Pyne | |||
Revision as of 00:44, 28 June 2018
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