📑 Are you happy with your docs?
Hey, I'm Jamie, the founder of Docbot. Our goal is to create the worlds best engineering wiki ✨
To understand the needs of teams better we've put together a short survey. It should take less than 90 seconds to complete and is incredibly valuable.
In return I'd be more than happy to repay the favour and participate in other hacker's surveys.
💙
Filled out the survey.
I'm fairly proud of the documentation I've written for the Passwordless REST API docs.
Since the API enable other developers to add FaceID / Fingerprint Sign In to their existing apps, some of the terms and W3C standards are often new to the "everyday developer".
I've tried to meet the developer where they are, not only write down the technical pieces but also try to explain concepts and "confusing words from the w3c spec".
Some of the things that I think worked for me:
Example of drawing:
Thanks so much for your response 💙
Passwordless looks awesome and those docs are 🔥
I would love to know more about what your internal documentation looks like. If you'd be interested in a coffee chat then drop us a message over on LinkedIn.
Hey Jamie,
love that an indie is taking this challenge on!
I'm working on Testkit and one of the things that I have to do soon is write the docs.
Do you think this will also be the best wiki for SaaS products? 👀
If yes, I'd love to be an early adopter and provide feedback!
I'm basically planning to do stuff like explaining how to create an organization in the UI (maybe with some gifs?) etc.
Hey Yassine,
Testkit is looking awesome!
Initially Docbot is going to focus on internal docs/wiki. Aiming to unlock the 50% productivity boost that research has shown possible with easy-to-source content.
I'd love to know more about what your internal documentation looks like atm if possible. If you're interested then drop us a message over on LinkedIn.
P.s. Docbot testing is all E2E with Cypress so I'd be happy to repay the favour too!