Zapisovač API - API writer

An Zapisovač API je technický spisovatel kdo píše dokumenty, které popisují aplikační programovací rozhraní (API). Primární publikum zahrnuje programátory, vývojáře, systémové architekty a systémové designéry.

Přehled

API je knihovna skládající se z rozhraní, funkcí, třídy, struktury, výčty atd. pro vytváření softwarových aplikací. Používají jej vývojáři k interakci se softwarem a jeho rozšiřování. API pro daný programovací jazyk nebo systém může sestávat ze systémově definovaných a uživatelem definovaných konstrukcí. Jak se zvyšuje počet a složitost těchto konstrukcí, je pro vývojáře velmi zdlouhavé pamatovat si všechny definované funkce a parametry. Proto autoři API hrají při budování klíčovou roli software aplikace.

Z důvodu technického předmětu musí autoři API rozumět aplikaci zdrojový kód dost na extrahování informací, které dokumenty API vyžadují. Autoři API často používají nástroje, které extrahují softwarová dokumentace umisťují programátoři do zdrojového kódu strukturovaným způsobem, přičemž zachovávají vztahy mezi komentáři a programovacími konstrukcemi, které dokumentují.

Autoři API musí také rozumět softwarovému produktu a dokumentovat nové funkce nebo změny jako součást nového vydání softwaru. Časový plán vydávání softwaru se liší od organizace k organizaci. Autoři API musí dobře rozumět životnímu cyklu softwaru a integrovat se do životní cyklus vývoje systémů (SDLC).

Autoři API v Spojené státy obecně následovat Chicago Style Style pro gramatika a interpunkce.[Citace je zapotřebí ]

Kvalifikace

Autoři API obvykle mají kombinaci programovacích a jazykových dovedností; mnoho autorů API má pozadí programování nebo technické psaní.

Expert API /sada pro vývoj softwaru (SDK) spisovatelé se mohou snadno stát programování spisovatelé.

Proces psaní API

Proces psaní API se obvykle dělí na analýzu a porozumění zdrojový kód, plánování, psaní a kontrola. Často se stává, že fáze analytické, plánovací a psaní nedochází striktně lineárně.

Kritéria pro psaní a hodnocení se u různých organizací liší. Některé z nejúčinnějších dokumentů API jsou vytvářeny osobami, které jsou dostatečně schopné porozumět fungování konkrétní aplikace, aby mohly vztahovat software k uživatelům nebo různé konstrukční prvky komponent k celkovému účelu programu. Za tvorbu mohou být zodpovědní také autoři API koncový uživatel produktová dokumentace.

Zatímco referenční dokumentace může být automaticky generována, aby byla zajištěna úplnost, dokumentace, která pomáhá vývojářům začít, by měla být napsána profesionálním autorem API a zkontrolována odborníky na předmět.[1] To pomáhá zajistit, aby vývojáři porozuměli klíčovým konceptům a mohli rychle začít.

Produkt

Autoři API vytvářejí dokumenty, které zahrnují:

  • Referenční příručky API
  • Průvodci programátory
  • Příručky pro vývojáře
  • Manuály pro správu
  • Instalační příručky
  • Průvodci implementací a integrací

Viz také

Reference

  1. ^ Jacobson, Daniel (2011). API: průvodce strategií. O'Reilly. str. 101. ISBN  9781449321642.

externí odkazy