Difference between revisions of "Akademy/2018/DocumentationTraining"

< Akademy‎ | 2018
Jump to: navigation, search
(add slides)
 
(11 intermediate revisions by 10 users not shown)
Line 1: Line 1:
=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 - 12:30 (preliminary time), Room 121
+
'''Trainer:''' Stefan Knorr, documentation writer at SUSE ''(filling in for Tanja Roth, documentation writer at SUSE)''
 
 
Trainer: Tanja Roth, professional documentation writer working at SUSE
 
  
 
You need to write technical documentation now and then? But you are not
 
You need to write technical documentation now and then? But you are not
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.
  
Participants:
+
In the final part of this workshop, we will discuss existing KDE documentation and you will be able to work on improving it.
 +
 
 +
'''Slides:'''
 +
[https://userbase.kde.org/images.userbase/1/10/Tech_writing-akademy18.odp Link to slides]
 +
 
 +
'''Participants:'''
  
 
# Camilo Higuita(camiloh)
 
# Camilo Higuita(camiloh)
Line 26: Line 29:
 
# Neofytos Kolokotronis
 
# Neofytos Kolokotronis
 
# Abhijeet Sharma
 
# Abhijeet Sharma
# Kåre Särs
 
 
# Maria Jessica Wiesinger
 
# Maria Jessica Wiesinger
 
# Bhavisha Dhruve
 
# Bhavisha Dhruve
 +
# Devaja Shah
 +
# Louise Stolborg
 +
# Sune Vuorela (svuorela)
 +
# Valorie Zimmerman (valorie)
 +
# Luigi Toscano (tosky)
 +
# Nicolás Alvarez
 +
# Jure Repinc
 +
# Claus Christensen

Latest revision as of 07:46, 18 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.

Slides: Link to slides

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. Maria Jessica Wiesinger
  11. Bhavisha Dhruve
  12. Devaja Shah
  13. Louise Stolborg
  14. Sune Vuorela (svuorela)
  15. Valorie Zimmerman (valorie)
  16. Luigi Toscano (tosky)
  17. Nicolás Alvarez
  18. Jure Repinc
  19. Claus Christensen

This page was last edited on 18 August 2018, at 07:46. Content is available under Creative Commons License SA 4.0 unless otherwise noted.