Insights

Technical writing insights

How I handle the decisions that come up when technical documentation needs to change.

Five practical articles on conversion, source conflicts, SME collaboration, structured authoring, and procedure verification.

What I verify after an SGML-to-XML conversion

My first check is whether the converted publication still tells the reader what to do, in the right order, for the right equipment.

Read the article

What I do when a manual and drawing disagree

I start by confirming which revision and equipment configuration each source describes. A difference may come from a genuine design change or from comparing two different versions.

Read the article

How I turn SME knowledge into a usable procedure

I prepare focused questions, observe the task in sequence, and return a draft that gives the expert something concrete to correct.

Read the article

How I make reusable content stay clear in context

Reusable content works only when each module remains accurate wherever it appears, so I define its purpose, boundaries, and applicability before reuse.

Read the article

How I verify a regulated procedure before release

Before release, I trace the procedure to approved sources, test it from the reader’s viewpoint, and verify that the final state is observable.

Read the article

The Writing Sample

Andrew Eroh · Technical publications