Tech docs stuff
I started teaching the Google Technical Writing One to Miro engineers. This first round includes 6 in-class group classes.
Participants so far seem to enjoy the material and the pace 😀🎉✨
Today I start holding classes to teach technical writing to software engineers at Miro. This is a totally grassroots initiative that received much more and better support than I could hope for.
I'm using the fantastically well done Google technical writing One:
And of course I do all my course-related bookkeeping, retro included, on a Miro board.
So interesting when you learn new things from external developers documenting their journey to creating a Miro app:
And a bunch of extra points for using the docs!
Tech docs don't exist in isolation, they're the natural outcome of collaboration and team effort.
Writing data product pipelines with Airflow
I had no idea that provisioning a solid, reliable data stream to data consumers could present so many challenges.
And I learned about workflows as code 🤩
Quick and dirty demo:
GitHub Copilot seems to like Alien, too.
Markdown templates with questions and suggestions to help authors stay on a smooth, well-paved path can go a long way 🪄✨
- Lower friction to write docs
- Standard content and format
- A more predictable way to do docs
- More collaborators who contribute to the docs