diff --git a/docs.json b/docs.json index 2f8762811..87f7dea33 100644 --- a/docs.json +++ b/docs.json @@ -22,7 +22,14 @@ "group": "Getting started", "pages": [ "index", - "quickstart", + { + "group": "Quickstart", + "icon": "rocket", + "pages": [ + "quickstart", + "quickstart/devrel" + ] + }, "installation", { "group": "Web editor", diff --git a/quickstart/devrel.mdx b/quickstart/devrel.mdx new file mode 100644 index 000000000..153efb798 --- /dev/null +++ b/quickstart/devrel.mdx @@ -0,0 +1,227 @@ +--- +title: "Developer relations" +description: "Best practices for developer relations teams using Mintlify" +icon: "users" +--- + +Developer relations (DevRel) teams play a crucial role in creating and maintaining documentation that serves both internal teams and external developers. This guide covers best practices for DevRel teams using Mintlify to create exceptional developer experiences. + +## Understanding your audience + +DevRel teams typically serve multiple audiences with different needs and technical backgrounds: + + + + Third-party developers integrating with your APIs, SDKs, or platform + + + Engineering, product, and support teams who need technical documentation + + + Open source contributors and community members who help improve your docs + + + Technical leaders evaluating your platform or making integration decisions + + + +## Content strategy for DevRel + +### Start with developer journeys + +Map out the complete developer experience from discovery to successful implementation: + +1. **Discovery**: How developers find your documentation +2. **Evaluation**: What information they need to assess your platform +3. **Getting started**: The fastest path to a working integration +4. **Implementation**: Detailed guides for real-world use cases +5. **Troubleshooting**: Common issues and solutions +6. **Advanced usage**: Power user features and optimization + +### Focus on outcomes + +Structure your documentation around what developers want to achieve, not just what your product does: + + +Instead of "API Reference > Users Endpoint", try "Managing user accounts > Create and update users" + + +## Organizing documentation for DevRel + +### Use progressive disclosure + +Start with high-level concepts and progressively reveal more detail: + +``` +Getting Started +├── Overview (what and why) +├── Quick start (fastest path to success) +├── Core concepts (essential understanding) +└── Next steps (where to go from here) + +Guides +├── Common use cases +├── Integration patterns +└── Best practices + +Reference +├── API documentation +├── SDK references +└── Configuration options +``` + +### Create clear navigation paths + +Use Mintlify's navigation features to create intuitive paths: + + +```json Navigation structure +{ + "navigation": { + "groups": [ + { + "group": "Getting started", + "pages": [ + "overview", + "quickstart", + "authentication" + ] + }, + { + "group": "Guides", + "pages": [ + "guides/webhooks", + "guides/rate-limiting", + "guides/error-handling" + ] + } + ] + } +} +``` + + +## Content creation best practices + +### Write for scanning + +Developers often scan documentation quickly. Use: + +- **Clear headings** that describe the content +- **Bullet points** for lists and steps +- **Code examples** that work out of the box +- **Callouts** for important information + +### Provide working examples + +Every code example should be: + + + + Include all necessary imports, configuration, and context + + + Use examples that reflect real-world usage patterns + + + Verify that all code examples work with current versions + + + +### Use consistent terminology + +Maintain a glossary of terms and use them consistently throughout your documentation: + +```mdx + + API key + +``` + +## Collaboration workflows + +### Work with engineering teams + +- **Embed with product teams** during feature development +- **Review API designs** before implementation +- **Create documentation templates** for consistent quality +- **Establish review processes** for technical accuracy + +### Gather community feedback + +Use Mintlify's features to collect and act on feedback: + +- Enable feedback widgets on pages +- Monitor analytics to identify problem areas +- Create feedback loops with your developer community +- Track documentation metrics alongside product metrics + +## Measuring success + +### Key metrics for DevRel documentation + + + + How quickly can developers achieve their first integration milestone? + + + Are common questions being answered by documentation? + + + Regular surveys and feedback collection + + + Page views, time on page, and user flows through documentation + + + +### Use Mintlify analytics + +Leverage built-in analytics to understand how developers use your documentation: + +1. **Popular content**: Which pages get the most traffic? +2. **Drop-off points**: Where do developers leave your documentation? +3. **Search queries**: What are developers looking for but not finding? +4. **User flows**: How do developers navigate through your content? + +## Advanced DevRel techniques + +### Create interactive experiences + +Use Mintlify's components to make documentation more engaging: + + + + Let developers test API calls directly in your documentation + + + Use code groups to show examples in multiple languages + + + Show complex concepts with visual explanations + + + +### Build community-driven documentation + +- **Enable contributions** through GitHub integration +- **Create templates** for community-contributed content +- **Establish guidelines** for community contributions +- **Recognize contributors** in your documentation + +## Next steps + + + + Track how developers use your documentation + + + Collect feedback from your developer community + + + Create interactive API documentation + + + Enhance your documentation with interactive elements + + \ No newline at end of file