API-forfatter - API writer

En API-forfatter er en teknisk forfatter, der skriver dokumenter, der beskriver en applikationsprogrammeringsgrænseflade (API). Det primære publikum inkluderer programmerere, udviklere, systemarkitekter og systemdesignere.

Oversigt

Et API er et grundlæggende bibliotek, der består af grænseflader, funktioner, klasser , strukturer, optællinger osv. Til opbygning af en softwareapplikation. Det bruges af udviklingshold til at interagere med og udvide softwaren. En API til et givet programmeringssprog og system kan bestå af systemdefinerede og brugerdefinerede konstruktioner. Efterhånden som antallet og kompleksiteten af ​​disse konstruktioner øges, bliver det meget trættende for udviklere at huske alle funktionerne og de definerede parametre. Derfor spiller API-forfatterne en nøglerolle i opbygningen af softwareapplikationer .

På grund af den tekniske emne, skal API forfattere forstå ansøgning kildekode nok til at udtrække de oplysninger, som API dokumenter kræver. Nogle almindelige værktøjer, der bruges af API-forfattere, inkluderer computersoftware, der udtrækker softwaredokumentation, der er placeret af programmerere i kildekoden på en struktureret måde, hvilket bevarer forholdet mellem disse kommentarer og de programmeringskonstruktioner, de dokumenterer.

API-forfattere skal også forstå softwareplatformen / produktet og dokumentere de nye funktioner eller ændringer som en del af den nye softwareudgivelse. Skemaet med softwareudgivelser varierer fra organisation til organisation. Forfatterne er nødt til at forstå softwarens livscyklus godt og integrere sig selv i systemets udviklingslivscyklus (SDLC).

API-forfattere i USA følger generelt Chicago Manual of Style for grammatik og tegnsætning .

kvalifikationer

API-forfattere besidder typisk en blanding af programmering og sprogfærdigheder; mange API-forfattere har baggrunde inden for programmering eller teknisk skrivning .

Ekspert API / softwareudviklingssæt (SDK) forfattere kan let blive programmeringsforfattere .

API-skrivningsproces

Cirka 60% af den brugte tid i skriveprocessen består i at analysere og forstå kildekoden og planlægge dokumentet / dokumentene. De resterende 40% af tiden vil typisk blive brugt på at skrive og gennemgå dokumentet (erne). Det er ofte tilfældet, at de analytiske, planlægnings- og skrivetrin ikke forekommer strengt lineær.

Et godt fundament for en række programmeringsfærdigheder er godt suppleret med en evne til at kommunikere effektivt, især når forfatteren søger at udvikle et flydende forståelsesniveau med udviklere.

Denne proces er en af ​​de vigtigste udfordringer, som tekniske forfattere står overfor . Kriterierne for skrivning og evaluering varierer mellem organisationer. Nogle af de mest effektive API-dokumenter er skrevet af dem, der er tilstrækkeligt i stand til at forstå funktionen af ​​en bestemt applikation, så de kan relatere softwaren til brugerne eller de forskellige komponentkonstruktioner til programmets overordnede formål. API-forfattere kan også i det mindste delvist være ansvarlige for at udarbejde dokumentation for slutbrugerprodukter .

Produkt

API-forfattere producerer dokumenter, der inkluderer:

  • API-referencevejledninger
  • Programmeringsguider
  • Udviklerhåndbøger
  • Administrationsmanualer
  • Installationsvejledninger
  • Implementerings- og integrationsvejledninger

Se også

Referencer

eksterne links