Technische documentatie en FAQ


Project


Developers, POs, Surfly werknemers

Audience


Empathisch, deskundig, direct

Voice


Copywriting, visual design

Technische copywriting is een aparte specialisatie binnen het vak copywriting. Het vereist uiteraard een technische achtergrond, maar de schrijfstijl is meestal heel anders dan bij copywriting voor websites of sociale media. Technisch schrijven is rechttoe rechtaan, extreem georganiseerd en gestructureerd. Lezers moeten de documentatie gemakkelijk kunnen vinden en snel kunnen doorlezen. Ze willen geen salespraatjes of door wollige informatie hoeven te scannen. Ze hebben een duidelijke behoefte en willen niets anders dan meteen het juiste antwoord of informatie vinden.

Dit ligt iets anders bij tutorials of het schrijven voor veelgestelde vragen (FAQ), daar is vooral zorgvuldigheid belangrijk. Hier moeten we de verschillende pijnpunten van de gebruiker identificeren en begrijpen wat de uitdagingen zijn waar ze tegenaan lopen. Het is belangrijk om rekening te houden met verschillende niveaus van expertise.

Project highlights

Surfly FAQ

API Documentation