Sto lavorando su un'applicazione per la quale una ricca API plugin è cruciale. Qual è il miglior processo per creare un'API intuitiva e facile da imparare?
What is the best process for creating an API that is intuitive and easy to learn?
Per prima cosa, crea un'API che funzioni.
Quindi, dopo averlo usato per un po ', ottieni un feedback sulle parti che non sono intuitive o facili da imparare.
Terzo, riscrivi l'API per essere più intuitiva e facile da imparare.
Quindi, dopo aver utilizzato l'API revisionata per un po ', ottieni più feedback sulle parti che non sono intuitive o facili da apprendere.
Quando raggiungi la riscrittura 3.0 dell'API per essere più intuitivo e facile da imparare, potresti effettivamente avere qualcosa che funzioni.
Questo è molto, molto difficile da fare "out of the box".
Ci vuole esperienza e, cosa più importante, ci vuole molto tempo tra produttori e consumatori delle API.
Finché non conosci i tuoi utenti, hai molto da imparare su di loro e su ciò che è "intuitivo" e "facile da apprendere".
La maggior parte delle API non si impegna davvero per questo. Si sforzano per "efficiente" o "semplice" o qualcosa che è molto più facile da raggiungere.
Ecco il punto.
"Intuitivo" e "facile da apprendere" sono attributi molto personali. Ciò che è intuitivo per una persona è stupido per un'altra. Ciò che è facile da imparare per una persona è sconcertante per un altro.
Non puoi ottenere "Intuitivo" e "facile da apprendere" senza conoscere veramente bene i tuoi utenti.
Non puoi conoscere i tuoi utenti davvero, molto bene fino a quando non interagisci con loro fornendo loro un'interfaccia, che usano, e poi ottieni un feedback dettagliato sulla loro esperienza.
L'apprendimento dei tuoi utenti richiede molto tempo tra te e loro.
Devi fare dei passi attivi per conoscere i tuoi utenti in modo da sapere cosa costituisce "intuitivo" e "facile da apprendere". Quando i tuoi utenti discutono tra loro, imparerai molto su cosa significhi " veramente " intuitivo. [Suggerimento: non significa niente.]
Un modo semplice per prendere provvedimenti attivi per conoscere gli utenti è quello di scorrere diverse versioni. Ci sono altri modi per conoscere i tuoi utenti.
Cerca le API Plugin esistenti. Dovrei raccomandare Eclipse (basato su Extension Points) e Netbeans (basato su Lookups). Bene, dipende anche da quanto desideri che i plugin estendano la tua applicazione. In Eclipse puoi cambiare praticamente ogni aspetto dell'applicazione. Stiamo utilizzando l'approccio Extension Points nella nostra applicazione GWT. Un altro buon modello architettonico per i plugin è la catena di responsabilità.
Leggi altre domande sui tag api-design api javascript plugins