< Akademy‎ | 2018

Difference between revisions of "Akademy/2018/DocumentationTraining"

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
# Johannes Zarl-Zierl
 
 
# 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:

  1. Camilo Higuita(camiloh)
  2. Caio Jordão Carvalho (cjlcarvalho)
  3. Kevin Kofler
  4. Dileep Sankhla
  5. Sandro Andrade
  6. Michael Pyne
  7. Bhushan Shah
  8. Neofytos Kolokotronis
  9. Abhijeet Sharma
  10. Kåre Särs
  11. Maria Jessica Wiesinger
  12. Bhavisha Dhruve
  13. Devaja Shah
  14. Louise Stolborg
  15. Sune Vuorela (svuorela)
  16. Valorie Zimmerman (valorie)

Content is available under Creative Commons License SA 4.0 unless otherwise noted.