Audit - What is a Code Example?
In which we decide what to count, and how.
14 Posts
Documentation
Audit - Overview
In which we try to make sense of our code examples, and track them.
Docs Consolidation Project - Month Two Check-In
In which I explore lessons learned in the second month of a project to consolidate 9 docs sets.
Docs Consolidation Project - One Month Check-In
In which I explore lessons learned in the first month of a project to consolidate 9 docs sets.
What to Test In Docs Code Examples
In which I explore WHAT to test in docs code examples.
How to Test Docs Code Examples
In which I explore HOW to test docs code examples.
Hackathon Part 3 - Charts, Charts, Charts!
In which I make a whole lotta Charts.
Hackathon Part 2 - Modeling Documentation Metadata
In which I decide how I want to structure my documentation metadata.
Hackathon Part 1 - Out of Google Sheets and Into Atlas
In which I free my data from Google Sheets.
Benefits of Docs Writing Code Examples
In which I discuss the benefits of having a documentation team writing the code examples.
Knowing When Docs Need Updates
In which I discuss the strategies for knowing when docs need updates.
Test Docs Code Examples
In which I explore why you really need to test docs code examples.
Docs Readability Scoring
In which I automate readability scoring for documentation.
Docs-as-code workflow: the missing link; a collaboration tool
In which I wax poetic about the value of previewing a docs-as-code site.