API schrijver - API writer

Een API schrijver is een technisch schrijver die documenten die een beschrijven schrijft application programming interface (API). De primaire doelgroep bestaat uit programmeurs, ontwikkelaars, systeem architecten en systeemontwerpers.

Overzicht

Een API is een basisbibliotheek bestaande uit interfaces, functies, klassen , structuren, opsommingen, etc. voor het bouwen van een softwaretoepassing. Het wordt gebruikt door ontwikkelteams om te communiceren met en uitbreiding van de software. Een API voor een bepaalde programmeertaal en het systeem kan bestaan uit het systeem gedefinieerde en door de gebruiker gedefinieerde constructen. Naarmate het aantal en de complexiteit van deze constructies toeneemt, wordt het heel vervelend voor ontwikkelaars om alle functies en de parameters bepaald herinneren. Vandaar dat de API schrijvers spelen een belangrijke rol in het bouwen van software applicaties.

Vanwege de technische materie, moet API schrijvers toepassing begrijpen broncode genoeg om de informatie die API documenten verlangen te halen. Enkele veel voorkomende instrumenten die worden gebruikt door API schrijvers zijn onder andere computer software die documentatie geplaatst door programmeurs in de broncode op een gestructureerde manier onttrekt, met behoud van de relaties tussen deze opmerkingen en de programmering constructies ze documenteren.

API schrijvers moet ook inzicht in de software platform / product en documenteren van de nieuwe functies of wijzigingen in het kader van de nieuwe software release. Het schema van software releases varieert van organisatie tot organisatie. De schrijvers moeten de levenscyclus van de software goed te begrijpen en te integreren zich in de Systems Development Life Cycle .

API schrijvers in de Verenigde Staten over het algemeen volgen de Chicago Manual of Style voor grammatica en interpunctie .

kwalificaties

API schrijvers nu een mix van de programmering en taalvaardigheden; veel API schrijvers hebben een achtergrond in de programmering of technisch schrijven .

Expert API / SDK schrijvers kan gemakkelijk programmeren schrijvers.

API schrijfproces

Ongeveer 60% van de tijd doorgebracht in het schrijfproces bestaat uit het analyseren en begrijpen van de broncode en de planning van het document (s). De resterende 40% van de tijd zouden in het algemeen worden besteed aan het schrijven en de herziening van het document (s). Het is vaak het geval dat de analyse, planning, en het schrijven stadia niet voorkomen in een strikt lineair.

Een goede basis voor een verscheidenheid aan programma's vaardigheden is goed aangevuld met een vermogen om effectief te communiceren, vooral wanneer de schrijver streeft naar een vlotte niveau van begrip met ontwikkelaars te ontwikkelen.

Dit proces is een van de belangrijkste uitdagingen voor technisch schrijvers . De criteria schrijven en evaluatie variëren tussen organisaties. Enkele van de meest effectieve API documenten zijn geschreven door mensen die onvoldoende in staat om het begrip van de werking van een bepaalde toepassing, zodat zij de software aan de gebruikers of de verschillende component constructen kunnen betrekking hebben op het algemene doel van het programma. API schrijvers kan ook ten minste gedeeltelijk verantwoordelijk voor het schrijven van zijn eindgebruikers product documentatie.

Artikel

API schrijvers documenten te produceren, waaronder:

  • API Reference Guides
  • Gidsen Programmeurs
  • Developer Manuals
  • Administration Manuals
  • Gidsen installatie
  • Implementatie en Integratie Guides

Boeken

Zie ook

Externe links

Technisch schrijven