In this solo episode, I share my latest content updates progress and reflect on my takeaways from Florian Lefebvre’s interview (S3:E36). I also share some thoughts on how documentation leads can reduce stress for contributors or reviewers.

—

I’ve been continuing to update docs as part of the article editor redesign, though somehow despite updating a lot, the total number hasn’t changed much. I've also helped with docs on a few new features, including small updates to our API endpoint documentation, writing some best practices for using URL redirect articles and categories, major changes to our URL checker, and writing some guidance on robots.txt customizations to prevent certain types of user agent traffic. I also reviewed docs someone else updated when we finally transitioned Advanced search to being a full find-and-replace feature. And, of course, I kept quite busy with Write the Docs Portland, serving as the Writing Day Coordinator!

I reflect on my interview with Florian Lefebvre, co-maintainer of Astro. I love Florian’s story arc of going from someone who self-described as “lazy” and “not enthusiastic” about docs to becoming someone for whom docs are an essential part of building a feature. And I love how Astro Docs uses "talking and doc-ing" meetings to work through core concepts rather than turn them into grammar nitpick fests, lowering the barrier for non-native English speakers and folks who aren’t professional writers to produce clear, accurate documentation.

I close by reflecting on the ways that the processes Sarah Rainsberger, docs lead at Astro Docs, has built processes that have reduced stress for her contributors, including the talking and doc-ing meetings but also the single page for experimental features, taking on the responsibility of content hierarchy, multiple pages, and cross-references for herself. I use a vaguely similar approach here at KnowledgeOwl but I haven’t tried the single page approach, and I may have to try this out with my team. In my own experience, decisions about naming pages and deciding where they live in the content hierarchy are some of the most stressful tasks for my team, and removing those as tasks has made them a lot more excited to contribute to documentation.

Join the discussion by replying on Bluesky

—

We love hearing your ideas for episode topics, guests, or general feedback: