Les critères d’une utilisabilité efficace
d’API et comment améliorer cette
utilisabilité
1
Les critères d’une utilisabilité efficace d’API ?
2
• Critères liés à l’utilisation
• Critères liés à la documentation
• C...
3
• Critères liés à l’utilisation
• Efficacité d'utilisation
• Utilisation fréquente de l’API (de bonnes ressources)
Les c...
4
• Critères liés à la documentation
• A jour et accessible
• Complète
• Avec des exemples suffisants
Les critères d’une u...
5
• Critères liés au développement du code
• Au niveau des méthodes
• Au niveau des classes
• Au niveau des paquets
Les cr...
6
• Critères liés au développement du code (Au niveau des méthodes)
• Nombre de paramètres de méthodes
• Type de paramètre...
7
• Critères liés au développement du code (Au niveau des classes)
• Constructeur ( par défaut, avec paramètre(s) )
• Noms...
8
• Critères liés au développement du code (Au niveau des paquages)
• Gestion des erreurs
• Le patternFacotry Vs construct...
9
• Critères liés à l’effet d’apprentissage
• Incrémenter le processus d’apprentissage
• Evaluer l’effort de compréhension...
10
• Améliorations liées à l’utilisation
• Améliorations liées à la documentation
• Améliorations liées au développement d...
11
• Améliorations liées à l’utilisation
• Auto complétion
• Connaissance sur le domaine de l’API ( photographie )
• Choix...
12
• Améliorations liées à la documentation
• Facilité d’accès à la documentation
• Regroupement des exemples similaires (...
13
• Améliorations liées au développement du code
• Bonne répartition des paquages
• Bon choix de la visibilité des méthod...
14
• Améliorations liées à la conception de l’API
• Avoir un feedback tôt
• Avoir une bonne compréhension de chaque facteu...
Prochain SlideShare
Chargement dans…5
×

Les critères d’une utilisabilité efficace d’API et comment améliorer cette utilisabilité

136 vues

Publié le

Les critères d’une utilisabilité efficace d’API et comment améliorer cette utilisabilité

Publié dans : Données & analyses
  • Soyez le premier à commenter

  • Soyez le premier à aimer ceci

Les critères d’une utilisabilité efficace d’API et comment améliorer cette utilisabilité

  1. 1. Les critères d’une utilisabilité efficace d’API et comment améliorer cette utilisabilité 1
  2. 2. Les critères d’une utilisabilité efficace d’API ? 2 • Critères liés à l’utilisation • Critères liés à la documentation • Critères liés au développement du code • Critères liés à l’effet d’apprentissage
  3. 3. 3 • Critères liés à l’utilisation • Efficacité d'utilisation • Utilisation fréquente de l’API (de bonnes ressources) Les critères d’une utilisabilité efficace d’API ?
  4. 4. 4 • Critères liés à la documentation • A jour et accessible • Complète • Avec des exemples suffisants Les critères d’une utilisabilité efficace d’API ?
  5. 5. 5 • Critères liés au développement du code • Au niveau des méthodes • Au niveau des classes • Au niveau des paquets Les critères d’une utilisabilité efficace d’API ?
  6. 6. 6 • Critères liés au développement du code (Au niveau des méthodes) • Nombre de paramètres de méthodes • Type de paramètre de méthodes • Nom de la méthode (getData, getData2) • Type de retour Les critères d’une utilisabilité efficace d’API ?
  7. 7. 7 • Critères liés au développement du code (Au niveau des classes) • Constructeur ( par défaut, avec paramètre(s) ) • Noms des méthodes (getInputMessages, getAllInputMessages) • DataType Les critères d’une utilisabilité efficace d’API ?
  8. 8. 8 • Critères liés au développement du code (Au niveau des paquages) • Gestion des erreurs • Le patternFacotry Vs constructeur • Plusieurs manières de faire la même chose • Complexité et nombre de classes Les critères d’une utilisabilité efficace d’API ?
  9. 9. 9 • Critères liés à l’effet d’apprentissage • Incrémenter le processus d’apprentissage • Evaluer l’effort de compréhension Les critères d’une utilisabilité efficace d’API ?
  10. 10. 10 • Améliorations liées à l’utilisation • Améliorations liées à la documentation • Améliorations liées au développement du code • Améliorations liées à la conception de l’API Comment améliorer l’utilisabilité d’une API ?
  11. 11. 11 • Améliorations liées à l’utilisation • Auto complétion • Connaissance sur le domaine de l’API ( photographie ) • Choix de la classe d’appel des méthodes (Message.Send (serveur) ) Comment améliorer l’utilisabilité d’une API ?
  12. 12. 12 • Améliorations liées à la documentation • Facilité d’accès à la documentation • Regroupement des exemples similaires (Regrouper, supprimer les doublons) • Création automatique des exemples (Test Unitaire, détection de pattern) • Fournir des documentations selon les profils des développeurs (débutants, experts) • Code bien commenté ( Côté développeur ) Comment améliorer l’utilisabilité d’une API ?
  13. 13. 13 • Améliorations liées au développement du code • Bonne répartition des paquages • Bon choix de la visibilité des méthodes (public Vs private) • Minimiser les appels sur une ligne ( getData ().getX().getValue().ToString() ) • Facilité d’instantiation Comment améliorer l’utilisabilité d’une API ?
  14. 14. 14 • Améliorations liées à la conception de l’API • Avoir un feedback tôt • Avoir une bonne compréhension de chaque facteur de l’utilisabilité • Utilisation des dimensions cognitives Comment améliorer l’utilisabilité d’une API ?

×