Writing & Documents

Writing, document preparation, and editing workflows.

Showing 13–24 of 26 guides

Write acceptance criteria for a workplace handout by turning a broad brief into checkable completion conditions.

How to write acceptance criteria for a workplace handout

A handout brief can sound settled until someone has to decide whether the draft is finished. One reviewer sees a missing instruction; another dislikes the arrangement of the page. Only the first concern may be supported by the brief. To write acceptance criteria , put each agreed requirement beside an observation a reviewer can make about the handout. Keep unanswered questions visible instead of turning a preference into a rule. The result is a short sheet that explains a decision about this deliverable, not a general verdict on whether the writing feels good.

file naming conventions: keeping recurring reports identifiable across versions.

9 min read

Plan file naming conventions for recurring workplace reports

Someone looking for a monthly equipment-use report usually knows the month they need, even if they do not remember when the file was last edited. A workable name should let that person distinguish the report subject, the period it covers and, when necessary, one revision from another. Consider a fictional set of reports for this exercise. Their names can be designed and tested without changing any real files or pretending that a promising filename proves which copy is approved.

document index planning: organizing subject entries so readers can locate report details.

8 min read

Use document index planning to help readers find subjects

A reader of a completed workplace report may remember a discussion about volunteer training without remembering its section title. An alphabetical subject index can give that reader a term to look up and a location to visit. Start document index planning by asking what someone would want to find in the report, then choose entries for the passages that actually answer those questions. A passing mention of a word is usually a poor destination. The index should point to useful discussion, using locations taken from the particular copy the reader will receive. For document index planning , verify each step.

document glossary planning: selecting unfamiliar terms and definitions for a reader-friendly report.

9 min read

Use document glossary planning to clarify unfamiliar terms

A workplace report can use familiar words for unfamiliar things. In a fictional community exhibition report, “display group” might name a particular set of materials, while “review copy” might refer to a document with a specific purpose. A new reader cannot reliably recover those meanings from the words alone. Document glossary planning begins by asking which terms this report actually uses, what its owner means by them, and where a reader will need an explanation. Keep the completed report in view; the glossary should describe its vocabulary, not create new terminology for the project.

Document cross references guide to checking headings and linked references before sharing a report.

9 min read

Check document cross references before sharing a report

A final check of document cross references matters even when every section, figure, and appendix appears to be present. A sentence can send a reader to an existing destination that no longer answers the question the sentence raises. Before sharing a workplace report, read each internal pointer alongside the material it promises to show. Check both where it leads and whether that destination supports the claim.

document heading hierarchy: structuring sections so readers can navigate a long report.

9 min read

Plan document heading hierarchy for a long report

A long report can have all its paragraphs in the right order and still leave readers unsure where one subject ends and another begins. To plan its headings, ask what each section actually contains, then decide whether that subject stands beside the next one or belongs inside a broader subject. The level expresses that relationship. A large font, a page break, or the amount of space above a line cannot answer the editorial question for you. For document heading hierarchy , verify each step.

Check transcription accuracy by comparing a draft with its original text and catching omissions.

9 min read

How to check transcription accuracy against original text

A typed passage can look convincing even when a small omission changes the instruction it was meant to preserve. To check transcription accuracy , put the typed copy beside the particular written original it came from, compare short corresponding portions, and note each difference before making a correction. Keep the original visible throughout. A discrepancy is evidence that the two texts differ; it is not, by itself, permission to edit the original's wording.

paraphrasing practice: rewording a passage while preserving the source’s meaning.

8 min read

Use paraphrasing practice to preserve a source's meaning

A faithful paraphrase changes the wording while keeping the source's claims intact. For paraphrasing practice , leave the original passage visible, identify what it says and compare your rewrite against it in both directions. Every source detail should have a place in the new explanation, and every new statement should have support in the source. Pay particular attention to permissions, conditions and words that express uncertainty.

Reverse outlining to test whether each paragraph arrives when the reader has the information needed to follow it.

10 min read

Use reverse outlining to check a draft's paragraph order

A paragraph can read clearly on its own and still arrive at the wrong moment. An example may appear before the proposal it illustrates, or a recommendation may precede the evidence needed to judge it. With reverse outlining , you describe the paragraphs already on the page and examine their sequence. The notes reveal what the draft asks readers to understand before it has explained enough.

Poetry line breaks compared by holding words and punctuation fixed while testing how different arrangements affect reading.

8 min read

Explore poetry line breaks without changing the words

To compare poetry line breaks , keep the words, their order, and the punctuation fixed, then write alternative arrangements. Look at where each line ends in relation to the sentence. Decide whether those endings support the reading you intend, and explain your preference with a specific word or phrase. You do not need to find a universally correct arrangement. You need a reason for the boundaries you choose.

Pronoun references guide to making people and actions clear in a workplace paragraph.

9 min read

Clarify pronoun references in a short workplace paragraph

To clarify pronoun references , identify the person, object or event each pronoun is meant to name, then change only the wording that leaves competing readings open. Repeat a name where the actor changes, name an object when two objects compete, or replace a vague "this" with the action it describes. If the intended meaning is unknown, ask the author before choosing a replacement.

email subject lines: wording a workplace request so the action is clear in the inbox.

9 min read

Write email subject lines that clarify the requested action

To write clear email subject lines , start with the completed message and name what it asks the recipient to do. Include enough context to identify the matter, preserve whether something is proposed or decided, and mention timing only when the body supports it. A subject should prepare someone to read the message without promising a different task.