Tech docs stuff

My awesome tech writer mate Mira got me to join as a partner in co-hosting crime: unconference on docs metrics at API The Docs Amsterdam 2023 #apithedocs #Amsterdam #atd2023

Good docs are always a team effort 🎉 ✨

A quick and dirty Miro slide to sum up the gist of the Google technical writing 1 course - round 1, 6 sessions - that I recently wrapped up. I taught some, I learned a lot!

I just completed the first round of Google Technical Writing One for software engineers ✍️ I taught 6 classes 🧑‍🏫 to about 50 engineers 👩‍💻🧑‍💻👨‍💻, each one of them with a brain the size of a planet...

Teaching technical writing ✍️ 📝 to people with a brain 🧠 the size of a planet 🪐 is scary, humbling, and fun ✨

2 years at Miro! Dang it went fast! Hot damn I've learned a ton and a half so far! A huge thank you to the wonderful folks I'm lucky to work with on an almost daily basis: you bring sunshine, knowl...

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...

So interesting when you learn new things from external developers documenting their journey to creating a Miro app: https://medium.com/@brianbaklaursen/enabling-digizuite-content-for-miro-ead83c466...

Tech docs don't exist in isolation, they're the natural outcome of collaboration and team effort.

Edited a new article for the Miro engineering blog: Writing data product pipelines with Airflow I had no idea that provisioning a solid, reliable data stream to data consumers could present so many...

Reference docs for each field, right where you need them. Quick and dirty demo: https://photos.app.goo.gl/BuDfK12W51xhVbje8

Thank goodness for code examples. They are the cracks where I can drop a bit of fun. GitHub Copilot seems to like Alien, too.

Template all the things! 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 a...

Sorting through messy mounds of mysterious materials, a.k.a information architecture, helps build resilience and the ability to see opportunities to move on: sometimes straight ahead, sometimes sid...

Constructive negative feedback helps identify and address issues. Positive feedback helps understand what works well, and how to keep improving one iteration at a time.

A few weeks ago Laura and Anett from Pronovix interviewed Anthony Roux, Mira Balani, and me for their APITheDocs podcast to talk dev docs 👩‍💻 🧑‍💻 Following part 1 ✨, part 2 💫 is out now 🎉 Here's th...

🎉 Thank you so much to API The Docs and Pronovix for featuring Anthony Roux, Mira Balani and myself on their ATD podcast! ✨ We enjoyed talking developer docs so much that we produced enough materia...

This afternoon our developer advocates held an online workshop to introduce developers to the Miro Developer Platform. They did a wonderful job: engaging, nice pace, smooth flow. And a participant ...

Working closely with our wonderful developer advocates to author docs that devs dig is such a pleasure!

🎸🎶 Casual team catch-up on Zoom with classical and (unplugged) electric guitar noodling 🎸🎶

Very grateful for the creativity, enthusiasm, dedication, and just plain hard work that Ianeta and Eddie put into ExplainDev. It has become one of the tools I use regularly to figure out "how the g...

🚀 The Miro Developer Platform 2.0 is available as a public GA release! 🚀 Like, with docs 'n' all! 📖💡 • Start with our sample app 🛠 • Explore even moar apps to get inspiration from 🧰 • Use Mirotone ...

I edited not one, but two new blog posts for the Miro engineering tech blog: • Culture as the foundation to double a team in size every year. About hiring mistakes and culture fit • Performance rev...

When we interview candidates who want to join us, we usually give them a technical assignment for them to submit. We also give them as much context as possible to avoid getting them blocked and fru...

Shameless brag highlight: I joined Miro about a year ago. I feel grateful for joining a rock-solid team, meeting new colleagues, making new friends, learning a ton.

I edited a new blog post for the Miro engineering tech blog: Miro Data Engineering team’s journey to monitoring From an abysmal abyss of alerts to structured, relevant, and above all actionable ale...

I edited a new blog post for the Miro engineering tech blog: 5 strategies for data workflows scheduling at Miro As someone who can barely schedule his day on a daily basis, I learned a ton from Ron...

Constructive negative feedback helps you squash bugs. Positive feedback helps you stay on course. Teamwork done well does good things.

Writing good is hard stuff ™️ Peer reviews help your colleagues discover possibilities they might not be aware of. Write kind, factual, and actionable feedback for them. It helps define a roadmap t...

One day after public beta launch of the Miro Developer Platform and the docs, and we get positive feedback: this is what team effort can do :-) Big shout out to the professional, lovely, fantastic ...

The Miro Developer Platform 2.0 is now in public beta! And for the very first time since I rolled into tech writing a decade ago or so, public docs!

I edited a new blog post for the Miro engineering tech blog: Optimize SPA bundle size to speed up application loading It was a great read that gave me specific insight into Next.js, which is someth...

I got my open PRs reviewed and approved, and I published to our docs site 2 new how-to articles, and 1 get started in 1 minute article. Feedback from an engineer in the team I'm part of: "Thanks fo...

Just home from my evening shift as part of the fantastic Miro support team during the Junction Hackathon 2021. While our DevRels encouraged, engineers supported, and pretty much everyone in the sup...

I got nominated as a Collaboration Champion at Miro! Thank you to the wonderful folks who spread good vibes and whom I'm happy and honored to work with!

Following a selection of talks during the apidays London 2021 conference

I edited a new blog post for the Miro engineering tech blog: Fluent setter: breaking the convention For me it was a mini crash-course meets learn it the hard way happy fall down the rabbit hole of ...

I edited a new blog post for the Miro engineering tech blog: How Safari crashes the graphics driver It was a fun and very interesting chase down the rabbit hole of really tricky bugs :-)

Followed some talks at Jamstack Conf 2021 I want to make some time to catch up with the talks I could not attend live. Great insight into publishing with git and static site generators

Followed some talks at GitKon 2021 I want to make some time to catch up with the talks I could not attend live. For folks like me who are not git pros, GitKraken and GitKon are great tools and grea...

Web SDK tech docs: • Released Web SDK reference docs update to describe new functionality: tag support • Released product changelog to notify users that the Web SDK now supports tags

Attending Write the Docs Prague 2021 Recap 6: Docs leadership: How to become a stronger leader for your team

Attending Write the Docs Prague 2021 Recap 5: How I use applied linguistics to be a better technical writer

Attending Write the Docs Prague 2021 Recap 4: How I use applied linguistics to be a better technical writer

Attending Write the Docs Prague 2021 Recap 3: Cognitive Ergonomics in Technical Writing - Lessons from the Field

Attending Write the Docs Prague 2021 Recap 2: Hustling for Fun and Profit as a Technical Writer: A Freelancing Starter Kit

Attending Write the Docs Prague 2021 Recap 1: How to write a book for (and with) an open source community

Attending Write the Docs Prague 2021 Recap 7: Alchemy in Adversity (How to become better and more resilient tech writers in a turbulent work environment)

Attending Write the Docs Prague 2021 Recap 6: Customer Feedback is the Fuel in our Engine

Attending Write the Docs Prague 2021 Recap 5: When documenting is designing: How to assist API design as a technical writer

Attending Write the Docs Prague 2021 Recap 4: Hitchhiker's Guide to Documentation Tools and Processes

Attending Write the Docs Prague 2021 Recap 3: More than words: Reviewing and updating your information architecture

Attending Write the Docs Prague 2021 Recap 2: Adventures in setting up a knowledge system for a research group

Attending Write the Docs Prague 2021 Recap 1: So you need to give bad news to users…

• This week: talked about headless CMS with CloudCannon • Next week: attending Write the Docs Prague online (I really miss the IRL version of the conference!)

• Last week: talked about tech docs at CryptoHopper • This week: talked about tech docs with CloudCannon Talking docs is as much fun as talking about guitars and vacuum tubes!