API Developer Experience (DX) Resources
Developer Experience (DX) is an important consideration for anyone creating APIs, whether internal or public.
Introduction to Developer Experience
- The rise of developer experience
- Why every API needs a dashboard
- Developer Experience: 4 usability tricks
- Some best practices for a great Developer Experience
- Programmable Web DX is Key to a Sucessful API
- Building Developer Experience (DX) from the ground up
- Why Developer Experience matters more than ever
- Building effective API programs: Developer Experience (DX)
- Developer Experience matters
- Ten Reasons Developers Hate Your API
- What is API Developer Experience
- IBM: Why Developers Hate Your API
- Clearbit’s Playbook for Growth in the API Economy
Developer Documentation
Having great documentation is first step of having a great developer experience.
- API documentation and developer experience
- Design good static REST API documentation
- API documentation guidelines
- Google’s developer documentation style guide
- The guide from ReadTheDocs team
- Alternatives to Swagger for documenting REST APIs
- Swagger - The most popular documentation tool for RESTful APIs.
- A tutorial and guide to swagger.
- Best pratices for documentation REST APIs
Tools
Building Developer Community
- How to build an awesome developer community
- Building a strong dev community
- Building a developer ecosystem: what vendors do to attract you to their platforms
- Slack - Your workplace communication tool is already a great platform for building developer community.
- Many developers communities are built on Slack’s platform
- gitter - A competitor to slack that is even more focused on the developer community. Of course, it is a great tool for building a community.
- An interview with founders of Pupil Labs
- Wikis - Wiki can also be very effective tool for engage your developers.
Developer Support
If you have paid customers you’ll probably need to provide direct support contacts. If you are providing free APIs, you’ll probably leverage the community a lot.
- Traditional Customer Support Tools
- Issue Tracking Software Many issue tracking software can also be openned to external facing and let external developer file bugs and issues directly.
- Webpage Embedded Chatting Software These webpage embedded chatting widgets are often used for prospective customers, but they can be used for support as well.
- Other Channels
- Github - For open source software or SDKs, developers often post questions directly on Github. So it is becoming the natural place for developer support. You can also easily create a wiki as well.
- Stackoverflow - Even though stackoverflow is for general questions, you can create a tagged channel like this:
https://stackoverflow.com/questions/tagged/{your tagged key word}