< Akademy‎ | 2018

Difference between revisions of "Akademy/2018/DocumentationTraining"

(change speaker)
m (remove bogus media include)
Line 1: Line 1:
[[Media:Example.ogg]]=Training "Documentation writing for non-writers"=
 
 
 
'''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:

  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.