Voor wie?

Technische documentatie is heel handig als je een project hebt waar veel mensen aan werken. Het is de bedoeling dat technische documentatie steeds verder word uitgebreid.

Doelgroepen

Technische documentatie is vooral handig voor:

  • Opdrachtgevers
    • managers
    • andere engineers
  • gebruikers
    • eindgebruiker
    • ander engineers (die een groter systeem bouwen)
  • keuringsinstallaties
    • een product moet veilig zijn voor bijvoorbeeld: cybersecurity, veilig gebruik, betrouwbaarheid.
  • Jezelf, 10 jaar later

Doelen

Wat verwachten de doelen van technische documentatie?

  • Eindgebruikers: het gebruiken van een product, producten onderhouden
  • Service engineers: het repareren van een product, hun werking testen
  • Keuringsinstanties: het testen van een product op een veilige werking, security, voldoet het aan standards
  • Opdrachtgevers: voldoet het aan de afgesproken eisen, wat zijn bekende bugs
  • Engineers: hoe werkt het, wat zijn de prestaties, hoe gebruik ik het in een groter systeem/aansturing…
  • Product managers: nieuwe features toevoegen, bugs (laten) fixen
  • Jezelf en collega’s: onderhoud plegen = wijzigingen aanbrengen, fouten oplossen