In the Web3 world, DevRels help developers understand and use new technologies. A great DevRel is both a skilled developer and a good communicator. They deeply understand the technology, but can also explain it in simple terms.

Getting Started

While DevRels do many things, their main goal is to help developers use the technology effectively. So they should always be focusing on what is really important. First of all, DevRels need to make sure developers have clear documentation, code examples, and ways to get help.

• Documentation - Clear instructions on how to use the technology.

• Code Examples - Sample code to learn from and build upon.

• Communication Channels - Places to ask questions and get help. Lets look closer into each task and create a step by step plan.

Let’s look closer to each one of them.

Documentation

When you are bootstrapping developer relations from scratch, you need to start thinking like a developer.

• Talk to Teams: Get feedback from engineers, marketing, and product teams to make sure the documentation helps developers and matches the project goals.

• Plan Sections: Make an outline with main sections for your docs like "Getting Started," "Guides," "API Reference," and "Troubleshooting." The "Getting Started" section should be the top priority.

• Keep it Simple: Use clear explanations and avoid confusing technical words when possible.

Add an AI-powered search tool like Algolia to help developers quickly find information in your documentation. Great docs to refer to when building your own are from Stripe, Nillion, Alchemy, Thirdweb, Berachain.

If you want to learn fundamentals and standards of writing technical documentation I would recommend Diataxis.

Code Examples

Code examples are independently working code snippets. You should add a code example for everything you say in your docs. Don’t exaggerate, but better more examples than less. More interactive your docs - better.

• Show Code: Provide working code examples for every feature or concept you explain. Interactive examples are even better.

• Use Pictures: Add diagrams, screenshots, and visuals to help explain complex ideas.

• Common Issues: Include a "Troubleshooting" or "FAQ" section to address common problems and questions developers might have.

Where to host you docs ? Choose a documentation platforms like GitBook or Docusaurus, which have features like search, version control, and GitHub integration.

Create a separate GitHub repository just for your documentation, so developers can contribute, report issues, and suggest improvements.

Communication Channels

Feedback from developers is extremely important. Think about it - how does a developer going to let you know that there is a bug ?

• Get Feedback: Include a feedback form or link for developers to report bugs, ask questions, or suggest improvements.

• Community Channels: Provide links to community channels like GitHub Discussions, Discord, or Slack, where developers can ask questions and connect.

• Keep Updating: Regularly review and update the documentation based on feedback, new features, and code changes.

Wrapping Up

So DevRels have three main responsibilities:

• Building Community: DevRels bring developers together. They organize events, host online sessions, gather feedback, and help developers work together.

• Creating Content: they make learning materials like blog posts, videos, and tutorials. These resources help developers learn and stay up-to-date.

• Improving the Product: DevRels work with product teams to make the technology better. They improve documentation, code examples, and developer tools.

If you want to learn about Developer Relations in more details I would recommend checking out a DevRel University.