8 Posts

Writing

Benefits of Docs Writing 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

Knowing When Docs Need Updates

In which I discuss the strategies for knowing when docs need updates.

Test Docs Code Examples

Test Docs Code Examples

In which I explore why you really need to test docs code examples.

Docs Readability Scoring

Docs Readability Scoring

In which I automate readability scoring for documentation.

Docs-as-code workflow: the missing link; a collaboration tool

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

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

Choosing the best writing tool

In which I lay out a generalist approach to choosing writing tools.

Real talk: freelance/contract writing

Real talk: freelance/contract writing

In which I talk about the pros and cons of being a freelance technical writer.