Zapisovač API - API writer

Spisovatel API je technický spisovatel , který 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 základní knihovna skládající se z rozhraní, funkcí, tříd , struktur, výčtů atd. Pro vytváření softwarových aplikací. Používají jej vývojové týmy k interakci a rozšiřování softwaru. API pro daný programovací jazyk a systém se může skládat 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. Autoři API proto hrají klíčovou roli při vytváření softwarových aplikací.

Z důvodu technického předmětu musí autoři API dostatečně rozumět zdrojovému kódu aplikace, aby mohli extrahovat informace, které dokumenty API vyžadují. Některé běžné nástroje používané spisovateli API zahrnují počítačový software, který strukturovaným způsobem extrahuje softwarovou dokumentaci umístěnou programátory do zdrojového kódu a zachovává vztahy mezi těmito komentáři a programovacími konstrukcemi, které dokumentují.

Autoři API musí také rozumět softwarové platformě / 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 musí dobře rozumět životnímu cyklu softwaru a integrovat se do životního cyklu vývoje systémů (SDLC).

Autoři API ve Spojených státech obecně postupují podle Chicagského manuálu stylu pro gramatiku a interpunkci .

Kvalifikace

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

Zapisovatelé Expert API / Software Development Kit (SDK) se mohou snadno stát programátory .

Proces psaní API

Asi 60% času stráveného procesem psaní spočívá v analýze a porozumění zdrojovému kódu a plánování dokumentů. Zbývajících 40% času by obvykle bylo věnováno psaní a kontrole dokumentů. Často se stává, že fáze analytické, plánovací a psaní nedochází striktně lineárně.

Dobrý základ různých programovacích dovedností dobře doplňuje schopnost efektivně komunikovat, zvláště když se autor snaží rozvíjet plynulou úroveň porozumění s vývojáři.

Tento proces je jednou z nejdůležitějších výzev, kterým techničtí autoři čelí . 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. Autoři API mohou být alespoň částečně zodpovědní za vytváření dokumentace k produktu koncového uživatele .

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
  • Příručky pro správu
  • Instalační příručky
  • Průvodci implementací a integrací

Viz také

Reference

externí odkazy