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

This week, I'm helping a team of technical writers deliver a new sample app…

DocumentationCoding

This week, I'm helping a team of technical writers deliver a new sample app showing how to use our products with three popular frameworks. I'm slinging around:

  • Bash
  • Java
  • Python
  • TypeScript
  • Markdown
  • YAML

While working on READMEs, repo licenses, .gitignores, GitHub workflows, repo configuration, and a utility/process for copying our sample app from a source monorepo to framework-specific artifact repos to simplify developer usage.

My fellow technical writers have written the app; I'm just out here adding Swagger docs, unit tests, integration tests, doing PR reviews, and setting up infrastructure.

I see posts all the time where technical writers lament seeing so many job postings that require tech writers to have some level of development skill. But the reality is that when we do, we can contribute much deeper and richer learning experiences to help people succeed with our products.

And isn't that the goal?

All microblog posts · RSS