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.
12 Posts
Writing
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.
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.
Investing in good equipment
In which I recognize how important it is to have good equipment, and do something about it.
Choosing the best writing tool
In which I lay out a generalist approach to choosing writing tools.
Real talk: freelance/contract writing
In which I talk about the pros and cons of being a freelance technical writer.