• Spring naar de hoofdnavigatie
  • Door naar de hoofd inhoud

Luc Bouquet

Technical Writing

  • Home
  • Diensten
    • Technisch schrijven
    • Lokalisatie
    • Kennisextractie
    • Documentatie ‘quick scan’
    • Een interne technisch schrijver opleiden
    • Opleiding ‘Actiegericht schrijven’
    • Creatief brainstormen
  • FAQ’s
    • Kan ik voorbeelden van uw werk zien?
    • Wat moet er wel/niet in een handleiding?
    • Hebt u zelf een technische achtergrond?
    • Welke broninformatie hebt u nodig?
    • Doet u al het werk zelf?
    • Welke tools gebruikt u?
    • In welke talen werkt u?
    • Is een ‘native speaker’ niet beter?
    • Hoe levert u een document aan?
    • Vaste prijs of regie?
    • Werkt u ook in onderaanneming?
    • Wat is uw tarief?
    • Hebt u een opvolger?
  • CV
  • Contact
  • NL
    • EN

How do you decide what should appear in the manual and what not?

There are international standards for that. I believe it is even more important to create a good topic list. First, I identify together with you what the future user needs to be able to do, based on the information in the manual. These are the action topics. Second, I check what the user should know in order to perform each action. These are the ‘knowledge topics’. All the topics together make the topic list. Each knowledge topic must be related to an action topic. By doing so, we are sure that we are not putting too little or too much information in our manual.

This applies equally well to other types of technical documentation, such as text for tenders, internal procedures, work instructions, training documentation…

Copyright © 2023 · Luc Bouquet