API pisac
API pisac je pisac tehničke dokumentacije koja opisuje aplikacioni programski interfejs (API). Primarna publika ovih pisaca su programeri, developeri, arhitekte sistema i dizajneri sistema.
Pregled
urediAPI je osnovna biblioteka koja se sastoji od interfejsa, funkcija, klasa, struktura, enumeracija, itd. za izgradnju softverske aplikacije. Koriste ga razvojni timovi za interakciju i proširenje softvera. API za određeni programski jezik i sistem može se sastojati od konstrukcija definisanih sistemom ili koji su definisali korisnici. Kako se broj i složenost ovih konstrukcija povećava, postaje veoma mučno za developere da pamte sve funkcije i parametre koji su tamo definisani. Stoga, API pisci igraju ključnu ulogu u pravljenju softverskih aplikacija.
Zahvaljujući tehničkoj temi, API pisci moraju razumeti izvorni kod aplikacije dovoljno da izvlače informacije koje zahtevaju API dokumenti. Neki uobičajeni alati koje API pisci koriste uključuju računarski softver koji izdvaja dokumentaciju koju programeri stavljaju u izvornomkodu na strukturirani način, čuvajući veze tih komentara i programskih konstrukcija koje dokumentuju.
API pisci moraju takođe da razumeju softversku platformu/proizvod i da dokumentuju nove odlike ili promene kao deo nove objave softvera. Raspored objavljivanja softvera razlikuje se od organizacije do organizacije. Pisci moraju dobro da razumeju životni ciklus softvera i da se integrišu u životni ciklus razvoja softvera.
Kvalifikacije
urediAPI pisci obično poseduju kombinaciju programerskih i jezičkih veština; mnogi API pisci imaju temelj u programiranju ili tehničkom pisanju.
- Temelj u programiranju (poznavanje C, C++, Jave, PHP, asemblera ili nekog drugog programskog jezika)
- Poznavanje standarda formatiranja kao što su Doksidžen, Javadok ili DITA
- Poznavanje editora i alata, kao što je FrejmMejker
- Odlične veštine u komunikaciji i pisanju kako bi komunicirali sa developerima
API proces pisanja
urediOko 60% vremena provedenog u procesu pisanja sastoji se od analiziranja i razumevanja izvornog koda, kao i planiranja dokumenta. Ostalih 40% vremena se tipično provodi pišući i recenzirajući dokument. Često je slučaj da se analitičke, planirajuće i faze pisanja ne pojavljuju strogo linearno.
Dobar temelj različitih programskih veština dopunjen je sposobnošću efektivnog komuniciranja, posebno kada pisac nastoji da razvije tečan nivo razumevanja sa developerima.
Ovaj proces je jedan od najvažnijih izazova sa kojima se suočavaju tehnički pisci. Kriterijumi pisanja i evaluacije variraju između organizacija. Neki od najefikasnijih API dokumenata su napisani od strane onih koji su adekvatno sposobni da razumeju rad određene aplikacije, tako da mogu povezati softver sa korisnicima ili različitim konstrukcijama komponenti do ukupne svrhe programa. API pisci takođe mogu biti barem delimično odgovorni za stvaranje dokumentacije o proizvodima krajnjeg korisnika.
Proizvodi
urediAPI pisci prave dokumente koji uključuju:
- API referentne vodiče
- Programerske vodiče
- Developerske priručnike
- Administracione priručnike
- Instalacione vodiče
- Vodiče za implementaciju i integraciju