Nango (YC W23)’s Post

View organization page for Nango (YC W23), graphic

1,708 followers

Great docs are an essential part of the product for dev tools 📖 We recently rebuilt Nango’s docs from the ground up. Here are our learnings: 1. Treat the docs as a product 🎁 Just like other features, we continuously collect customer feedback and improve and refine the docs. It takes a lot of time, but we think our docs are a crucial feature of Nango! 2. The docs can power entire features 🔖 Our docs have a page for each API that Nango supports. On this page, we document API-specific quirks, gotchas, and helpful links to get started with the API on Nango. It’s a helpful feature of our product, implemented entirely on the docs! 3. Don’t reinvent the wheel on structure 🔀 It turns out there is a proven best practice for structuring developer docs. Like other UX patterns, using it will help every developer feel more quickly at home in your documentation. See the link in the first comment! 4. UX & UI matters ✨ Switching our docs to Mintlify has greatly improved the readability and navigation of our docs. It lets us focus on writing great content instead of fighting layout issues. The built-in API playground is the cherry on top. 5. AI chatbots are a great fit for docs 🤖 Our docs have a built-in AI chatbot (powered by Inkeep). It's a great addition to keyword-based search, as it lets new users ask structured questions about how to use Nango. I highly recommend it! What are your learning from writing docs for developers? I am looking forward to reading them in the comments! #saas #devtools #docs

  • No alternative text description for this image

To view or add a comment, sign in

Explore topics