Sluiten

Writing documentation

Writing structured, comprehensible, efficient content... not always that simple

Your product is almost finished. Great, but there is no documentation. Is there a technical writer available? Who has time? Explain what is essential, automate where needed. Moreover, use a clear structure and language, a professional layout, and illustrations... Technical writing, how do you do that?

Contact us

Documentatie schrijven

Herken je deze problemen?

Pff, schrijven? Neen, dank u! | Ja maar, het ziet er niet professioneel uit! | Hoe moet ik daaraan beginnen?

Wie spreekt er hier Engels? Schrijf maar! | Kunnen we dat niet automatiseren?

Hoe wij kunnen helpen.

How we can help you

Zoek je een technisch schrijver?

Een technisch schrijver van Flow maakt jouw technische documentatie en helpt je met alles wat daarbij komt kijken. We hebben jarenlange ervaring op allerlei vakgebieden en met allerlei technologieën. Bovendien lijden we aan chronische nieuwsgierigheid.

Een technisch schrijver van Flow ziet ook het brede plaatje. Hoe kun je kennis en informatie het beste beheren en doorgeven? Hoe organiseer je dat, praktisch?

Natuurlijk hebben onze technical writers grondige kennis van minimalisme, gestructureerd schrijven, DITA. En we passen de stijlgidsen en best practices toe uit ons eigen vakgebied, technische communicatie. Natuurlijk zijn we ook vertrouwd met de specifieke tools en systemen.

API-docs?

Wij kijken met een techcomm-bril naar uw API-documentatie en maken die toegankelijk voor uw klanten en gemakkelijk te beheren voor u (docs-as-code).

Samen met uw developers optimaliseren we uw OpenAPI-specs. Eventueel ontbrekende info (getting started, how-to) vullen we aan en we letten ook op de consistentie van vorm en inhoud (benamingen bijvoorbeeld). Op die manier zorgen we voor betere reference docs in Markdown of DITA zodat je je API-portaal gemakkelijker up-to-date kunt houden.

Met goed gestructureerde API-documenten ben je bovendien klaar om informatie te hergebruiken.

Gestructureerd schrijven

Gestructureerd schrijven helpt auteurs efficiënt en doelgericht te schrijven. Gebruikers van gestructureerde documenten vinden sneller relevante en duidelijke informatie terug.

Gestructureerd schrijven is een manier van schrijven waarbij je:

  • “informatiebouwstenen” gebruikt uit een informatiemodel
  • standaarden, regels en richtlijnen volgt om je tekst te structureren

Je kunt deze methode op allerlei soorten teksten toepassen. Ze staat los van het softwareprogramma dat je gebruikt. Lees meer.

Soorten documenten

Je kunt bij ons terecht voor allerlei documenten. Een paar voorbeelden:

  • technisch: handleiding, werkinstructie, veiligheidsprocedure, onderhoudsinstructie, installatie- of configuratiemanual
  • web: webcontent, intranetpagina
  • zakelijk: presentatie, beleidsnota, business plan, productbeschrijving, offerte
  • opleiding: animatie, e-learning content, syllabus, trainingsgids
  • IT: use case, specificatie, wiki knowledge base, onlinehulp

DITA (Darwin Information Typing Architecture)

DITA is een internationale OASIS-standaard om teksten te structureren en te publiceren. Je schrijft kleine, gestructureerde stukjes (“topics”) met tekst, illustraties, tabellen en eventueel video, die je op een centrale plaats beheert en hergebruikt in verschillende publicaties en documenten (“single source”). Je bewaart alles in een universeel bestandsformaat (XML) dat je met een breed gamma aan “tools” kunt bewerken en publiceren. DITA-topics zijn gemakkelijk up-to-date te houden, beter vertaalbaar, en ideaal om te publiceren op smartphone en tablet. Om in DITA te schrijven kun je verschillende editors gebruiken, zoals oXygen XML Author, FontoXML, XMetaL Author en Adobe FrameMaker met DITA-FMx.

Documentmodellen

Weet je niet hoe je aan dat procesplan moet beginnen? Of doet iedereen dat op een andere manier, wat erg verwarrend is? Gebruik documentmodellen. Ze geven je een basisstructuur, waardoor je je tijdens het schrijven enkel moet concentreren op de inhoud, niet op de vorm of de structuur.
Onze documentmodellen zijn beschikbaar in verschillende talen en voor verschillende documenttypes.

Fris perspectief

Documentatie wordt geschreven door experts, maar meestal niet vóór experts. Bij Flow zijn wij vaak de eerste echte gebruikers van jouw product of dienst, en van je documentatie. Zo kunnen we de juiste vragen stellen:

  • Welke informatie heeft je klant nodig?
  • Welke vragen heeft je klant?

Flow bewandelt de dunne lijn tussen expert en klant.

Internationale standaarden

Voldoet jouw documentatie aan de huidige normen en wetten, zoals ISO IEC 82079-1:2012 en de Machinerichtlijn? Wil je je documentatie reorganiseren om een ISO-certificaat te behalen? We analyseren je documentatie en bekijken de vereisten. Zo helpen we bestaande documenten om te zetten en nieuwe documenten meteen op de goede manier aan te pakken.

INTERESTED?CONTACT US

Interessante documenten

Enkele klanten