Challenge

‍

‍Aptos, a Web3 blockchain company, sought to improve developer support by revamping and reorganizing its documentation site. The company had in-depth reference material for tools like the Aptos CLI, a necessary tool for compiling, testing, and deploying code, however, pre-existing documentation provided frustrations for new developers due to confusing content and poor organization. Aptos chose DevDocs' API documentation service as their solution for redesigning the information architecture and revising its content to improve the developer experience.

‍

Solution

‍

DevDocs initiated the documentation revision by first interviewing SMEs to gain a deeper understanding of the tool, its application, and the common challenges faced by end users. The information architecture was planned and rebuilt with a keen focus on its different operators and the experience levels of community members, ensuring that each section ensures relevance and accessibility to users. Entry points to the more detailed sections were added to reduce confusion and provide a smoother transition for new developers. Robust linking to Aptos’ separate tutorial site was also incorporated to provide additional guidance to new users.

‍

Results

‍

The improved documentation was well-received by its audiences, resulting in 65% fewer service requests from confused developers. DevDocs positioned Aptos for long-term success, with a more user-friendly information architecture providing better guidance and allowing users to build repeatable processes via contributing guidelines. Aptos has retained DevDocs as a technology partner, providing technology consulting and content strategy as the company continues its upward growth trajectory.

‍