For AI agents: a documentation index is available at /llms.txt — markdown versions of all pages are available by appending index.md to any URL path.

Microblog

In the last few weeks, I've been rolling out our new code example test…

DocumentationCoding

In the last few weeks, I've been rolling out our new code example test infrastructure for C#, Java, JavaScript, and Python. This week, I'm adding support for a shell tool. Next week, Go.

But all the tooling in the world does no good if people don't know how to use it.

I'm pairing this rollout with:

  • High-level process documentation on our company wiki
  • Implementation-specific READMEs with a consistent topic coverage for every programming language and product
  • Workshops for writers who will be contributing net new code examples using our test infrastructure in upcoming projects
  • Setting up a working group to onboard early adopters from every team across the docs org
  • Providing a NotebookLM loaded with all of this source content so people can easily get answers without having to pour over all of the specifics

I will make updates to tooling and process based on these first few real-world projects and the feedback of our early adopters. And then I will socialize the rollout more broadly and seek to drive wider adoption.

I am super excited to bring this tooling to the wider org, and want to provide the training and resources to make it easy to adopt. 🎉 🙏

Technical writers - how do you roll out new tools and processes? Did I miss anything?

All microblog posts · RSS