Autore
Diana Lakatos
Diána Lakatos è Senior Technical Writer in Pronovix, un'azienda che crea developer portal in Drupal. È specializzata nella documentazione di API, nella scrittura topic-based e nelle soluzioni di aiuto contestuale. Le piace anche lavorare come Program Monitor per NHK World TV e Arirang TV.
Altro di questo autore
In questo follow-up del suo primo articolo sui fondamenti di una buona API, Diana Lakatos esplora attentamente degli utili extra che porteranno la documentazione della vostra API a un nuovo livello. I suoi consigli vi aiuteranno a rendere più usabile e leggibile la vostra API, permeandola con personalità ed esplorando oltre le basi.
Creare un'elegante API non è il fine ultimo: vi servono sviluppatori che la usino. La vostra documentazione deve metterli nelle condizioni di capire rapidamente cos'è la vostra API, cosa fa e come usarla oppure rischiate di perdere la loro attenzione. In questo pezzo, Diana Lakatos ci offre moltissimi suggerimenti eccellenti su come documentare una API in maniera appropriata.
