Online Seminar – Writing Technical Documentation

The clarity and user-friendliness of technical documentation can be optimized through the expert application of proven rules of writing. Clear texts are not only important for conveying information; they also serve as a marketing tool for companies. And they can save on translation costs: Whether the translation is done by machine or by a professional translator, the clearer your source text is, the better the translation will be.

Your benefit

  • You'll learn what it means to write in a way that is clear and tailored to your audience.
  • You'll learn how to write in a more concise, shorter, and more structured way.
  • You will learn and apply proven rules for writing.
  • Participation in this continuing education event can also be credited toward tekom recertification.

Target group

  • Technical editors and authors of technical manuals and descriptions.
  • Developers and designers who create technical documentation "on the side."
  • Career changers such as technical translators, technical journalists, or college graduates who have recently begun—or will soon begin—creating technical documentation.
  • Technical writers who want to refresh their knowledge.

Contents

  • Write in a user-friendly way
    • Don't just write about a product—write for the users!
    • Understanding is always an individual process: Take memory capacity into account, promote retention,
  • Writing clearly – the words
    • Avoid word forms that are difficult to understand: compound words, nominalizations, …
    • Use consistent terminology—use the same wording for the same concepts: loanwords, technical terms, etc.
  • Writing clearly – sentences
    • Avoid sentence structures that are difficult to understand: nominal style, excessive use of the passive voice, nested clauses, and parenthetical phrases
    • Writing Short Sentences: How Long Should Sentences Be?
    • Construct sentences in a logical and clear manner
    • Create clarity by using lists and tables instead of continuous text
  • Writing clearly – the texts
    • Establish a Contextual Connection
    • Word Order and Information Distribution
    • Clear Text Structure
    • Use design elements: table of contents, headings, visuals, …
    • Use instructional aids: glossary, preview, examples, …
    • Distinguishing between types of speech acts: naming, describing, giving instructions, …
  • Checking, measuring, and assessing comprehensibility
    • Use checklists for the rules of text formulation
    • The Hamburg Clarity Model
    • Readability formulas determine/measure the difficulty of a text
  • Formulate safety and warning notices
    • Content and Structure in Accordance with ANSI Z535.6

Methods and evidence

  • Participants receive detailed seminar documentation.
  • Participants will receive a certificate of participation.

  • Place: Online

  • Duration: 1 day (8:30 a.m. – 4:00 p.m.)

  • Cost: EUR 490 (plus VAT)

1Registration for the Online Seminar – Writing Technical Documentation
2

Cost: 490 EUR (plus VAT)
We will invoice you for our services after your order has been placed and before the webinar begins. All prices are net and exclude shipping costs. The applicable VAT rate will be added to all prices (currently 19).

For organizational reasons, we ask that you book seminars approximately one week in advance.

Dates
Here you can enter a different billing address or participant details, e.g. if you are booking for an employee. If you would like to register several participants or have any questions, please contact us and we will be happy to help you.
The bill, please