Don't Panic — Technical Editing

Technical editing begins at the moment a page looks finished and somebody asks whether it is safe to trust. The familiar alternative is cosmetic cleanup: polish the sentences, correct the punctuation, admire the shine, and hope the reader does not meet the missing prerequisite hiding behind paragraph three. This course is about the less decorative job of finding that prerequisite before the reader does.

The useful mental model is risk-based verification. Start with the reader’s task. Then find the source of truth for the claims on the page. A command, product name, prerequisite, example, link, or expected result is not made correct by being well phrased. It becomes trustworthy when the evidence and the reader’s path agree. Grammar has been promoted from whole mission to one member of a small, hardworking committee.

The working loop is deliberately unglamorous: set the brief, read for the outcome, verify facts, edit structure, edit language, record decisions, and recheck. The surprise is that structure carries meaning. A heading can hide a missing decision. A numbered step can combine two actions. A link that says “click here” can make the right destination harder to find. The page is not a container for information; it is the route a reader uses to reach an outcome, which is an inconvenient property for anyone hoping to fix it by moving commas around.

Choose one dominant content form before editing. A tutorial guides experience. A how-to guide supports a real task. Reference supports exact lookup. Explanation builds context and relationships. Mixing all four without a reader goal creates a page that has many answers and little help. The editorial brief is the agreement that keeps this from happening: audience, purpose, scope, standard, and deadline.

When the task is ready, open the Intro for the workflow and limits, Slides for the map of the review loop, Cheatsheet for the checks, and Practice for a repeatable method. The exercise turns the method into an edit with visible evidence. The point is not a page that looks calmer. The point is a reader who can act without discovering, mid-task, that the document had been quietly guessing.