Alchemy – Developer Documentation Overhaul for Web3 APIs
Challenge
Alchemy needed to elevate its developer documentation to match the growing complexity of its Web3 infrastructure and APIs, and transition from a former publishing tool to a developer portal. Their existing API references lacked consistency, tutorials were fragmented, and the documentation platform was limited in usability. Developers faced steep learning curves and increased support needs.
My Role
I served as a Technical Writer on the team, responsible for revamping the entire documentation ecosystem. My role included:
Rewriting and expanding API references to align with Web3 standards.
Web3 API Reference
Creating SDK guides, smart contract documentation, and blockchain integration tutorials for platforms like Solana, Optimism, and Polygon.
SDK Reference Guides
Leading the migration of 250+ pages from Gitbook to a different platform for improved accessibility.
Standardizing information architecture and integrating GitHub workflows for continuous documentation updates.
Alchemy Docs Information Architecture
Ideated and delivered use cases for builders.
Use Cases
Collaborating with product teams and developer advocates to ensure technical accuracy and user focus.
What were the results?
🚀 35% drop in developer support tickets related to API usage.
⚡ 40% faster onboarding times for developers using Alchemy’s APIs.
📚 Migrated and optimized 250+ documentation pages, improving UX and discoverability.
🔍 Created a unified structure and style guide that reduced confusion and improved content consistency.
📈 Boosted developer engagement as reflected in increased page views and time spent on documentation pages.
Revised API docs to meet Web3 standards, created guides for major blockchains, migrated content to Readme.com, and ensured quality through team reviews.