• Share
  • Email
  • Embed
  • Like
  • Save
  • Private Content
Applying Design Priciples to APIs - 1 of 4
 

Applying Design Priciples to APIs - 1 of 4

on

  • 4,924 views

In this four part series we’ll apply universal principles of design to APIs. When an API is created with quality, the application developers who use the API often elevate their craftsmanship when ...

In this four part series we’ll apply universal principles of design to APIs. When an API is created with quality, the application developers who use the API often elevate their craftsmanship when making apps. The goal of this series is to put the API team in a position to create a virtuous cycle of constantly-improving API & application development.

Statistics

Views

Total Views
4,924
Views on SlideShare
1,615
Embed Views
3,309

Actions

Likes
5
Downloads
59
Comments
0

7 Embeds 3,309

http://blog.apigee.com 3072
https://blog.apigee.com 167
http://blog.sonoasystems.com 62
http://translate.googleusercontent.com 3
http://webcache.googleusercontent.com 2
http://localhost 2
http://www.google.com 1
More...

Accessibility

Categories

Upload Details

Uploaded via as Adobe PDF

Usage Rights

CC Attribution License

Report content

Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel
  • Full Name Full Name Comment goes here.
    Are you sure you want to
    Your message goes here
    Processing…
Post Comment
Edit your comment

    Applying Design Priciples to APIs - 1 of 4 Applying Design Priciples to APIs - 1 of 4 Presentation Transcript

    • Applying Design Principlesto APIsIn Four PartsBrian Mulloy@landlessnessApigee@apigee
    • “Whatever is worth doing at all, is worthdoing well.” -Philip Dormer Stanhope Earl of Chesterfield 1746
    • amazon.com
    • Baker’s Dozen1. Development Cycle2. Errors3. Visibility4. Flexibility-Usability Tradeoff5. Hick’s Law6. 80/20 Rule7. Inverted Pyramid8. Advance Organizer9. Consistency10. Self Similarity11. Aesthetic-Usability Effect12. Cost-Benefit13. Immersion
    • Four PartsI. Empathize Development Cycle ● Errors ● VisibilityII. Don’t Overwhelm Flexibility-Usability Tradeoff ● Hick’s Law ● 80/20 Rule ● Inverted PyramidIII. Don’t Reinvent the Wheel Advance Organizer ● Consistency ● Self SimilarityIV. Be Beautiful Aesthetic-Usability Effect ● Cost-Benefit ● Immersion
    • Part I: Empathizei. Development Cycleii. Errorsiii. Visibility
    • “ Successful products typically follow four stages of creation: requirements, design, development, and testing. Development Cycle Universal Principles of Design
    • Questions to ask at each phase:1. What is the developer doing?2. How can we help?
    • Development Cycle: Requirements
    • Share our domain knowledge
    • Share our domain knowledge✓ Educate others about our domain✓ Certify our partner developers
    • Development Cycle: Design
    • Point the way
    • Point the way✓ Inspire with an app gallery✓ Guide the design of apps✓ List the objects in our system
    • Development Cycle: Development
    • Share our API knowledge
    • Share our API knowledge✓ Engage developers with an API console✓ Be accessible via forums, social media & email
    • Development Cycle: Testing
    • Ask for input, give data
    • Ask for input, give data✓ Receive bugs & feature requests directly from developers✓ Show each developer his API data
    • Development CycleUniversal Principles of Design✓ Educate others about our domain✓ Certify our partner developers✓ Inspire with an app gallery✓ Guide the design of apps✓ List the objects in our system✓ Engage developers with an API console✓ Be accessible via forums, social media & email✓ Receive bugs & feature requests directly from developers✓ Show each developer his API data
    • “ An action or omission of action yielding an unintended consequence. Errors Universal Principles of Design
    • Make it easy to learn from mistakes
    • Make it easy to learn from mistakes✓ Respond with HTTP status codes for apps✓ Respond with verbose messages for app developers✓ Create social error pages with details and hints
    • “ The usability of a system is improved when its status and methods of use are clearly visible. Visibility Universal Principles of Design
    • Be transparent and human
    • Be transparent and human✓ Broadcast system status and alerts✓ Apologize for mistakes and give details✓ Publish the API product roadmap
    • End of Part I: Empathizei. Development Cycleii. Errorsiii. Visibility
    • Part 1: Checklist✓ Educate others about our domain✓ Certify our partner developers✓ Inspire with an app gallery✓ Guide the design of apps✓ List the objects in our system✓ Engage developers with an API console✓ Be accessible via forums, social media & email✓ Receive bugs & feature requests directly from developers✓ Show each developer his API data✓ Respond with HTTP status codes for apps✓ Respond with verbose messages for app developers✓ Create social error pages with details and hints✓ Broadcast system status and alerts✓ Apologize for mistakes and give details✓ Publish the API product roadmap
    • Four PartsI. Empathize Development Cycle ● Errors ● VisibilityII. Don’t Overwhelm Flexibility-Usability Tradeoff ● Hick’s Law ● 80/20 Rule ● Inverted PyramidIII. Don’t Reinvent the Wheel Advance Organizer ● Consistency ● Self SimilarityIV. Be Beautiful Aesthetic-Usability Effect ● Cost-Benefit ● Immersion
    • THANK YOUQuestions and ideas to:Brian Mulloy@landlessnessbrian@apigee.com