Hello everyone!
Welcome back to the third edition of Dosu's monthly newsletter.
Last month, we announced early access to our upcoming product where “you build, Dosu documents” — envisioning a world where every product has self-generating, always-up-to-date documentation.
This month we are excited to launch the first of many features that push us closer towards our vision.
📝 Dosu Does Docs
🧐 Why docs?
Engineers love to code (at least I do), yet when you look at research, most engineering time is not spent coding—it's spent answering questions, triaging issues, writing and maintaining documentation, and other tedious tasks.
For almost two years, Dosu has lightened the load for engineers by acting as a first line of defense for incoming questions and issues. Now, Dosu is taking documentation off engineers' plates too.
📇 Documentation Beta
In this release, we're launching a new way of generating documentation. We strongly believe that engineers know what they want to document, but the activation energy to actually write it is too high. We want to empowers developers by making it 100x easier to transform a recent feature or investigation into a shareable, long-living document.
Now in the Dosu app, you'll see a new documents tab—which allows you to generate high quality markdown documents in a matter of minutes. Just give Dosu instructions and a template—such as a how-to guide, installation guide, README, or some other template you dream up—and Dosu will do the hard work to fill in the blanks.
🫵 Questions for the Community
This feature is in beta and currently under active development. We are releasing this today because we believe UX is critical and we want your help in perfecting it. We hope this beta gives you something to play around with, and get the ideas flowing. In return we'd love feedback, suggestions and ideas! Specifically, we'd like to know…
- What would be your ideal documentation workflow?
- What documentation do you still want to create yourself? What documentation would you prefer be auto-generated?
- How would you like Dosu to interoperate with existing documentation in GitHub or other platforms?
If you have thoughts or want to chat, let us know by replying to this email, reaching out to us at hi@dosu.dev, or posting in our community Discord ��.
🪩 Social Dosu
In case you've missed our recent posts, here's the rundown to catch you up:
- A guide to Automating Issue Triage in GitHub for all the OSS maintainers out there
- Some musing on the impact of stale documentation
Please follow us on Twitter/LinkedIn and join our community Discord. And as always, please share any feedback or feature requests! We are here to help.
See you in May,
The Dosu Team