Een nieuw soort documentatie


Categorie

Recent blog items

  • 14 July 2017

    CE-markering medische software

    Wanneer krijgt medische software een CE-markering? Medische hulpmiddelen zoals infuuspomp

    Lees meer>
  • 23 June 2017

    Brexit en dubbele documentatie

    Dubbele documentatie door Brexit? Het Verenigd Koninkrijk (VK) stapt definitief uit de EU

    Lees meer>
  • 30 March 2016

    Publicatie normontwerp gebruikershandleidingen NEN 5509

    Revisie norm gebruikershandleidingen De afgelopen jaren heb ik vanuit Manualise deelgenome

    Lees meer>
  • 30 March 2016

    Machinerichtlijn 2006/42/EC

    Welke eisen stelt de Machinerichtlijn aan de gebruiksaanwijzing? Elke machine die binnen

    Lees meer>
  • 21 March 2015

    Madcap Flare 11

    10 Reasons Why MadCap's Flare 11 Sets the Standard As a technical communication service b

    Lees meer>

Een nieuw soort documentatie

ifixit

Een online community website verandert de manier waarop wij naar onze apparaten kijken – en naar technische documentatie. Hoe iFixit gebruikershandleidingen maakt die de wereld verbeteren.

Dit artikel is origineel in het Engels geschreven door Kyle Wiens, mede-oprichter en CEO van iFixit.

Toen ik 18 was, gleed mijn laptop van de hoek van mijn bed. De iBook viel op de grond en brak – een ongelukje dat de rest van mijn leven heeft beïnvloed. Dat moment heeft indirect geleid tot de totstandkoming van twee bedrijven – iFixit en Dozuki – en leidde ertoe dat twee studenten een compleet nieuwe vorm van documentatie uitvonden.

Op het moment dat mijn computer kapot ging was ik een eerstejaars student Computerwetenschappen aan de Cal Poly Universiteit in Californië. Ik vond het altijd al leuk om te knutselen en besloot om de computer zelf te repareren in plaats van een nieuwe te kopen. Het was tenslotte een prima computertje voor mij, dat me altijd goed van dienst was; het verdiende niet zo een einde. Dus ik zocht op internet naar Apple’s officiële technische iBook handleiding. Deze handleiding was onvindbaar. Ik leerde in dat weekend dat Apple niet graag reparatie-informatie deelt met haar publiek.

Daar kon ik het niet bij laten, dus vroeg ik Luke Soules, mijn kamergenoot en eerstejaars masterstudent Industrial Engineering om me te helpen. We waren tenslotte allebei ingenieurs dus zouden we zelf uit moeten kunnen vinden hoe we een computer moeten repareren, maakten we onszelf wijs.

Dat bleek niet het geval. Na op gevoel wat geklooid en geprutst te hebben lukte het ons om de computer uit elkaar te krijgen en het kapotte onderdeel te vervangen, maar – zonder instructies – lukte het ons niet om de iBook weer goed in elkaar te zetten. Het duurde lang, maar na veel frustratie en gevloek kwam de computer weer tot leven. Helaas werkte hij daarna nooit meer zo goed als hij deed voor de reparatie.

Luke en ik leerde iets van deze ervaring: mensen hebben betrouwbare, gemakkelijk te begrijpen reparatie-informatie nodig. Apple maakte deze informatie niet openbaar, dus besloten we zelf reparatie-instructies te gaan schrijven voor Apple apparaten. We haalden een Apple computer uit elkaar, schreven een reparatiehandleiding en zetten deze online, gratis beschikbaar voor iedereen. Het eerste weekend hadden we al meer dan 10.000 hits. En zo werd iFixit geboren, een open source, door publiek bewerkbare database van reparatiehandleidingen.

Repareer het zelf – van espressomachines tot iPods

Tien jaar later is iFixit de enige organisatie op het web met een reparatiehandleiding voor elk Appleproduct dat op de markt is. De eerste handleidingen hebben een heel ecosysteem geschapen voor reparatie-informatie – niet alleen voor Appleproducten, en ook niet alleen voor computers, maar voor alles dat repareerbaar is. Op iFixit zijn nu meer dan 10.000 handleidingen beschikbaar, voor allerlei apparaten, van espressomachines tot iPods. Dat aantal groeit met de dag omdat de iFixit gebruikersgemeenschap continu handleidingen blijft toevoegen.

iFixit is gebaseerd op één simpele stelling: mensen moeten gemakkelijk kunnen leren om dingen te repareren. En de formule werkt. Miljoenen mensen – van New York tot Alaska, Tibet tot de Canarische eilanden – hebben onze handleidingen. Zij hebben geld bespaard, voorkomen dat het apparaat vroegtijdig op de schroothoop terecht kwam en helemaal zelf iets gerepareerd.

Als oprichters van het bedrijf, heeft iFixit ons geleerd hoe krachtig reparatie-, service- en onderhoudsinformatie kan zijn: Hoe het mensen kan leren om fantastische dingen te doen, hoe het mensen kan samenbrengen en hoe het institutionele problemen kan oplossen.

Een nieuwe soort documentatie

Mensen leren om kwetsbare elektronica te repareren is ongelooflijk moeilijk – zeker als zij daarmee nog geen enkele ervaring hebben. Toen we iFixit opstartten, vroegen Luke en ik ons af “Hoe kunnen we onze instructies zo eenvoudig maken dat echt iedereen ze kan volgen?” We keken rond voor inspiratie: we doorzochten instructiewebsites, oude IT reparatiehandleidingen en gigantische mappen vol met computerhandleidingen en montage-informatie. Wat we vonden stelde ons eerlijk gezegd nogal teleur.

De technologie staat nooit stil. Iedere dag duikt er wel ergens een visionair op met een ontwerp van het nieuwe levensveranderende gadget, een nieuw stuk software of een nieuwe productiemachine. Maar om een of andere reden is documentatie altijd hetzelfde gebleven: statisch, moeilijk te begrijpen, levenloze boeken met informatie. Zelfs de online instructiehandleidingen die we tegenkwamen waren totaal fantasieloos. Dat waren gewoon pdf’s, dezelfde boeken als geprint, maar dan in digitaal format. Dat was niet goed genoeg.

Als we echt wilden dat de iFixit gebruikers hun reparaties succesvol konden uitvoeren, besloten Luke en ik dat we terug moesten naar de tekentafel. We moesten een nieuwe vorm van documentatie uitvinden – een vorm die interactief is en echt voelt, alsof een expert over je schouder meekijkt en zegt welke schroevendraaier je moet gebruiken, waar dat kleine draadje hoort en bij welke stappen je extra voorzichtig moet zijn.

Over de jaren heen hebben we een duidelijke opinie gevormd over documentatie en over wat documentatie effectief maakt. Dit zijn de principes waarop iFixit is gebouwd:

  1. Goede instructies halen het beste uit de mens: Instructies zijn belangrijk. Een goede handleiding leert mensen om iets te doen wat ze anders niet zouden kunnen. Bovendien zorgt een goede instructie dat mensen veilig en vlot werken.
  2. Informatie moet met de tijd beter worden: Instructies raken te snel verouderd. Handleidingen moeten gemakkelijk geüpdate kunnen worden en eenvoudig aan te passen zijn. Op die manier worden handleidingen nooit oud, alleen beter.
  3. Mensen hebben behoefte aan zo mobiel mogelijke handleidingen: Instructies gaan waar mensen gaan – onder auto’s, in het veld, gedrongen in de kleinste hoekjes. Met mobiele instructies op telefoons en tablets hebben handleidingen een groter bereik.
  4. Media van hoge kwaliteit maken documentatie effectiever: Soms zijn woorden niet goed genoeg. Met video’s, diagrammen en (vooral) foto’s zijn instructies veel gemakkelijk te volgen.
  5. De beste handleidingen maken moeilijke dingen eenvoudig te leren: Goede instructies zijn zo transparant mogelijk. Ze moeten zo simpel zijn, zo instructief en zo gedetailleerd, dat absoluut iedereen ze kan volgen.
  6. Gemeenschappen groeien rondom de inhoud: Interactieve handleidingen moedigen mensen aan om hun kennis te delen en betere manieren te vinden om dingen te doen. Feedback en mogelijkheden voor vraag en antwoord zouden onderdeel moeten zijn van elke handleiding.

Leren in de praktijk

Het duurde niet lang voordat we in de gaten kregen dat wij het, op gebied van documenteerstijl, andere ideeën hadden dan anderen – en misschien was dat andere perspectief wel iets goeds. We gingen samenwerken met de Cal Poly universiteit om iFixit documenteertechnieken naar de collegezaal te brengen.

We wilden studenten laten zien hoeveel impact technische documentatie kan hebben. Als deel van het project krijgen de studenten, in groepen, een apparaat om aan te werken. Zij maken het apparaat open, vogelen uit hoe het werkt en schrijven vervolgens hun eigen reparatiehandleiding met stap-voor-stap instructies en duidelijke foto’s. Nadat de handleidingen door anderen zijn getest en door iFixit zijn goedgekeurd gaan ze live op de site zodat andere mensen ze kunnen gebruiken.

Door dit project krijgen de studenten een gevoel voor hoe ontzettend belangrijk reparatiehandleidingen zijn. In sommige gevallen is de handleiding van de studenten de enige handleiding beschikbaar voor dat apparaat. En mensen gebruiken deze. Sommige studentenhandleidingen zijn meer dan 10.000 keer bekeken. Als de studenten deze aantallen zien dringt het tot ze door dat hun werk een verschil maakt – en niet alleen voor de persoon die de reparatie heeft uitgevoerd. Goede instructies kunnen de hele wereld beter maken.

Voorkomen dat gadgets op de vuilstort verdwijnen

Elk jaar opnieuw wordt wereldwijd 20 tot 50 miljoen ton ‘e-waste’ gegenereerd. Volgens ‘The Economist’ groeit de hoeveelheid drie keer sneller dan die van andere soorten afval en komt dat door een afnemende levensduur van consumentenelektronica en een toenemende vraag ernaar in de alsmaar groter wordende middenklasse in ontwikkelingslanden. En het wordt nog erger. Het volume en gewicht van e-afval zal in de komende 15 jaar meer dan verdubbelen, schrijft Pike Research.

E-waste heeft de neiging om zijn weg naar de andere kant van de oceaan te vinden, naar plaatsen waar veiligheid- en milieustandaarden niet zo strikt zijn, zoals Giuyu in zuidoost China en Agbogbloshie in Ghana. Het zorgt ervoor dat veel mensen daar een stabiel leven kunnen lijden, maar het is ontzettend gevaarlijk. De arbeiders, inclusief kinderen, doen hun werk zonder beschermende maskers en handschoenen. Wat ze niet kunnen repareren of hergebruiken wordt uit elkaar gehaald voor de grondstoffen. Soms is de eenvoudigste manier om kostbare metalen, zoals koper, uit elektronica te halen het in brand zetten van de elektronica of het oplossen ervan in zuurbaden. Daarbij komen giftige chemicaliën vrij in de lucht, in het water en in de grond – en die blijven daar om generaties lang mensen te vergiftigen.

Oude elektronica recyclen is beter dan weggooien, maar het is geen echte oplossing. Veel materialen kunnen we nog niet uit elektronica terugwinnen, waaronder een aantal zeldzame aardmetalen. Slechts 20 van de 50 elementen uit een mobiele telefoon, bijvoorbeeld, kunnen teruggewonnen worden. Bovendien kost het enorme hoeveelheden energie en bronnen om zelfs de eenvoudigste elektronische chip te maken. Het ‘IT and Environment Initative’ schrijft dat voor de productie van een 32 MB geheugenchip van 2 gram, 1.7 kg aan fossiele brandstoffen en chemicaliën nodig is. Door recycling en verbranding van elektronica gaat de energie die als het ware ingebouwd zit in het apparaat verloren; hergebruik en reparatie aan de andere kant zorgen dat het apparaat langer meegaat en (tegen een lagere prijs) een tweede, derde of vierde eigenaar kan krijgen.

Door het schrijven van een handleiding leren studenten hoe krachtig goede instructies kunnen zijn. Sinds 2009 is het project uitgerold over 13 universiteiten en duizenden studenten. Hun bijdrage maakt een verschil, tot lang nadat de studenten de cursus hebben afgerond – en dat is iets waar de studenten trots op kunnen zijn.

Instructies kunnen bedrijven opnieuw uitvinden

We hebben onze handleidingen ontworpen om anders te zijn, om beter te zijn. We horen iedere dag reparatieverhalen, van mannen, vrouwen en kinderen overal op de wereld die onze handleidingen hebben gebruikt om hun iPads, mobiele telefoons, mp3-spelers en vele andere apparaten te repareren.

Op een gegeven moment kwam het in ons op dat onze documentatietechnologie nuttig zou kunnen zijn voor meer dan het repareren van elektronica. Als onze handleidingen mensen zonder enige ervaring konden leren om relatief moeilijke reparaties uit te voeren, dachten wij, dan kunnen ze mensen ongeveer alles leren.

We stelden onze documenteersoftware, Dozuki, beschikbaar voor bedrijven die hun werkinstructies en service handleidingen drastisch wilden herzien. In plaats van instructies te verzamelen in gigantische, onhandelbare mappen die in de kast stof staan te vangen, vonden wij dat instructies op de plek moesten zijn waar deze nodig waren – op de werkvloer. Op de iPad en altijd binnen bereik konden effectieve instructies volgens ons werk standaardiseren, nieuwe werknemers sneller inleren en een veiligere, meer productieve werkstroom mogelijk maken.

En dat is ook gebleken. In het bijzonder producenten hebben Dozuki’s technologie om handleidingen te maken heel succesvol toegepast. We hebben samengewerkt met grote namen uit de industrie, zoals Tesla en Haas, om hun werkinstructies en servicedocumentatie nieuw leven in te blazen. Op de Cal Poly universiteit hebben onze instructies gezorgd voor 75% kortere trainingstijden voor machineonderhoud. Onze stap-voor-stap servicedocumenten hebben International Telematics geholpen om de hoeveelheid ondersteuningsverzoeken te verlagen met 60%, ondanks een groei van 300% in het aantal installaties per week.

Hervorming van documentatie

Ook al hebben mensen soms weinig positiefs te zeggen over technische documentatie en instructiehandleidingen, ze zijn ongelooflijk belangrijk. Het zijn leraren/begeleiders – ze kunnen geweldige dingen bereiken. De handleidingen van iFixit hebben miljoenen mensen de kracht gegeven om hun elektronica te repareren – waardoor talloze apparaten uit de verbrandingsoven en van de vuilstorten zijn gebleven. In het bedrijfsleven helpen de Dozuki instructies om enorme productiviteitswinsten te halen. Onze ervaring heeft ons geleerd dat, om echt effectief te zijn, documentatie drastisch hervormd moet worden. Instructies en handleidingen moeten zo ontworpen worden dat ze effectief zijn in de wereld van vandaag – niet in de wereld van 40 jaar geleden. Dat is de enige manier waarop documentatie ooit het respect en de aandacht zal krijgen die het verdient.