Comment trouver la personne appropriée pour l'examen des fonctionnalités API?

Question

Nous développons un produit qui fournit une interface API, pour que d'autres développeurs peuvent utiliser certaines fonctionnalités du produit principal.

Ceci est déjà mis en œuvre et documenté.

Mais je ne suis pas sûr que ce soit très utile, et la documentation est très claire pour les développeurs.

Comment nous pouvons trouver des gens pour examiner cette fonctionnalité? Quel type de personne doit-il être?

Dans un certain sens, nous recherchons le propriétaire du produit pour la fonction / composant. Est-il possible?

Answer 1

Il serait le meilleur de trouver un programmeur qui a déjà conçu un certain cadre connu pour la langue en question.

vos utilisateurs pensent est irelevent Je pense, vous ne pouvez pas becuase juger au sujet du cadre en demandant programmeur arbitraire ses toughts à ce sujet. Sa réponse dépendra de son niveau de connaissances et des méthodologies personnelles alors que l'API est conçu pour la population plus large (je suppose que c'est votre cas). Pour terminer ce point, dans mes programmeurs fermes qui utilisent VB.NET pense que C # est le langage boiteux becuase des « problèmes » comme vous ne pouvez pas écrire Bouton = « Texte » en C # et laisser le compilateur trouver automatiquement la propriété par défaut pour vous. Vous ne voulez pas cette personne de juger votre cadre.

Même les concepteurs expérimentés dans des langues différentes peuvent être utiles parce que les API utilisées plus larges devraient être mises en œuvre avec l'aide de modèles de programmation bien connus personnes sont déjà familiers avec.

Answer 2

Demandez à quelqu'un qui n'a pas expérimenté avec votre produit pour faire un exemple de code ou une implémentation de référence d'un client pour votre API. Ensuite, ils vont obtenir un bon sens de l'endroit où la documentation est déficiente ou l'API doit être améliorée. Cela peut être un entrepreneur ou un nouveau développeur (bon moyen de les obtenir à la vitesse).

Answer 3

Tout d'abord, si vous développez une API pour une utilisation par d'autres, je vous recommande la lecture d'un livre comme: http://www.amazon.com/Framework-Design-Guidelines-Conventions-Development/dp/0321545613

Suite à ces règles évitera un grand nombre de problèmes d'utilisation avec votre interface avant tout examen est nécessaire.

En second lieu, exécutez une étude de la facilité d'utilisation avec quelques développeurs cibles, ceux qui sont susceptibles d'utiliser cette API, mais ont jamais vu auparavant. Mettez en face du système et de leur donner quelques tâches, puis regarder comment ils vont tenter de comprendre comment le faire. Leurs points de douleur vous dire où vous avez besoin d'apporter des améliorations.

Answer 4

Sondage vos utilisateurs finaux et découvrez ceux qui utilisent votre API pour interagir avec votre logiciel. Vous pouvez ensuite sonder les utilisateurs et d'obtenir leur avis sur les différentes fonctionnalités que vous offrez dans votre API ainsi que la facilité d'utilisation et la clarté de la documentation.

Answer 5

Chaque API a un certain public cible (à savoir les clients développant des intégrations à votre produit). De ce point de vue, il serait le meilleur pour obtenir les commentaires des membres de ce public. Vous pouvez établir à savoir un certain programme d'accès précoce, ou expédier des bêtas publiques.

Si vous avez pas un tel public (vous développez API pour un produit qui n'est pas encore public), je vous suggère de faire un roi des « tests d'utilisation » - à savoir ramasser un développeur de cibler environ compétence du public et de donner lui une mission impliquant l'utilisation de l'API. Ensuite, obtenir un retour de lui.

Answer 6

Si je dans vos chaussures, je commence à écrire des exemples d'applications et soit faire une présentation pour marcher les gens si les étapes ou un autre exercice similaire. Il est pas aussi bon que d'obtenir les commentaires des utilisateurs, mais il peut secouer certains problèmes.

Une autre (peut-être mauvaise) idée est de dépenser de l'argent sur les sites elance / gourou et venir avec un exemple d'application / fonctionnalité vous pensez est représentatif de la façon dont les utilisateurs vont utiliser l'API. Faire le projet pour cela et puis aussi obtenir des commentaires des développeurs dans le cadre du projet.

Vous aurez probablement besoin de gens qui peuvent communiquer dans votre langue maternelle ...

Par ailleurs, attendre jusqu'à ce qu'il soit tout documenté et mis en œuvre est sans doute pas le meilleur moment pour l'examiner ... il aurait été beaucoup mieux de faire l'examen avant la mise en œuvre.