< Akademy‎ | 2018

Akademy/2018/DocumentationTraining

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. Sandro Andrade
  5. Michael Pyne
  6. Bhushan Shah
  7. Neofytos Kolokotronis
  8. Abhijeet Sharma
  9. Maria Jessica Wiesinger
  10. Bhavisha Dhruve
  11. Devaja Shah
  12. Louise Stolborg
  13. Sune Vuorela (svuorela)
  14. Valorie Zimmerman (valorie)
  15. Luigi Toscano (tosky)
  16. Nicolás Alvarez
  17. Jure Repinc
  18. Claus Christensen

This page was last edited on 1 April 2020, at 08:54. Content is available under Creative Commons License SA 4.0 unless otherwise noted.
-->