Survey shows documentation is the No. 1 way that developers learn about your API

The 2024 StackOverflow annual survey results are in.

As in previous years, they’ve highlighted a crucial aspect of software development: the immense value developers place on good documentation.

Even with the growth of chatbots and AI being built into developer tools, it’s interesting to see that traditional learning resources are still hugely important.

Key findings

1. Documentation remains king: 84% of developers use technical documentation for learning. Of those, 90% rely on documentation found in API and SDK packages. This illustrates how important it is to have clear, comprehensive documentation.
2. The learning journey of developers: The survey showed software development is characterised by continuous learning. Both novice and experienced developers heavily rely on documentation.
3. AI in developer learning: 37% of respondents reported using AI for learning purposes. While significant, this is still far below the 84% who turn to documentation. Contrary to some predictions, AI hasn’t drastically altered developer roles or learning habits.
4. The human touch in documentation: Despite AI advancements, there’s a clear need for human-created documentation. Technical writers play a crucial role in crafting effective documentation. Even basic information about an API’s purpose and use cases can significantly impact adoption rates.

The importance of the “Developer Experience”

Creating a positive developer experience goes beyond just providing a powerful tool or API. It involves:

• Clear, concise, and accurate documentation
• Examples and use cases that demonstrate real-world applications
• Regular updates to keep documentation in sync with the latest features
• Addressing common pain points and questions before developers get stuck

Final thoughts

AI is clearly going to continue to evolve, but the StackOverflow survey reaffirms that well-crafted documentation remains a cornerstone of developer learning and productivity. We’ve seen from our clients that having good quality documentation is not just beneficial; it’s essential for widespread adoption and user satisfaction.