| name | it-voice |
| description | Guides writing and editing of technical documentation in an elevated, sedate, institutionally grounded register — measured, authoritative, and formal rather than casual or promotional. Applies when drafting or revising manuals, plans, runbooks, specifications, or policy documents, or when lifting an existing flat draft into this register. |
IT Voice: An Elevated, Sedate Register for Technical Documentation
Purpose / When to use
Apply this register to any document that must read as considered, formal, and trustworthy: plans, manuals, runbooks, specifications, and governance or policy documents. The voice is instructional yet impersonal, grounded yet unhurried. It never sells, never hectors, and never raises its voice for grave material. Draw on it whether writing from scratch or lifting a flat draft into register.
Register and diction
- Sustain one elevated formal register throughout. Use no contractions, ever: write cannot, do not, need not, it is. Hold this even inside step-by-step instructions.
- When two phrasings exist, choose the more formal or literary one, provided it is exact. Prefer Latinate, abstract vocabulary (commensurate, consequential, particulars, posture) where the plain word would lose precision. Compress a judgment into one precise adjective rather than a colloquial phrase.
- Match grammatical mood to the kind of statement rather than reaching for one blunt modal:
- State standing norms, and the behavior of systems, as plain facts in the present indicative — Device encryption is enabled, Logs are retained for ninety days, The service enforces the limit — so a requirement reads as settled practice.
- Give procedures and steps in the bare imperative, the workhorse mood for instruction — Create the account, Enable the requirement for every user, Keep the hierarchy shallow.
- Soften recommendations and judgment calls with evaluative framings — does well to, deserves attention, warrants emphasis.
- Reserve heavier modal force — is to, must — for firm obligations, and let the stated stake rather than the modal carry the weight.
- Instruct impersonally. Almost never address the reader as you: command through the imperative, make roles and systems the grammatical subjects (The service enforces, Administrators confirm), and use the generic one for a hypothetical actor. Reserve direct address for the rare passage that turns on the reader's own judgment — adapting the plan to particular circumstances, or consulting local counsel for a specific jurisdiction.
- Embrace technical terms; do not avoid them. Define each at first use with an inline gloss — an appositive, a colon-led expansion, or a parenthetical — so the term and its plain meaning arrive together. Flag coined labels with quotation marks and unpack them at once.
- Carry logic with elevated connectives (It follows that, Yet, At the same time, More important still, Rather than) instead of plain so, but, also.
Sentence architecture and rhythm
- Vary sentence length deliberately and widely. Build through occasional long sentences that stack subordinate and coordinate clauses, then discharge them with a short, plain declarative that lands a single fact. Never settle into uniform length; never chain short sentences into a staccato run.
- Join a set of related, grammatically parallel provisions with semicolons inside one sentence, closing the series with and before the last member — rather than fragmenting them into many short sentences.
- Use the colon as a hinge from general to specific: state the principle in the lead clause, then place the definition, detail, or instances after it.
- Give em dashes defined work: paired dashes to embed an appositive or aside; a single trailing dash to open a concrete illustration or a qualifying turn (—but, —which). Do not scatter them as an all-purpose connective in place of the semicolon or colon.
- Open a meaningful share of sentences with a fronted subordinate clause (Should, When, Where, Before) so the governing circumstance is set before the main clause resolves it.
- Give every paragraph a thesis-first topic sentence, then elaborate. Close paragraphs and sections on a shorter, weighted sentence that restates the principle or draws its consequence, often with a trailing so that clause naming the purpose.
- Build rhythm from balance: pose antithetical pairs (not X but Y, X rather than Y); reserve the three-part list for genuine cadential moments; and let ordinary enumerations run to four, five, or six parallel members rather than forcing them into triads.
Rhetorical stance and tone
- Describe the organization's own arrangements and settled norms plainly, in the present indicative, rather than promoting or justifying them — an arrangement stated as fact invites recognition rather than mere compliance. Keep the imperative for the procedures that carry it out.
- Convey importance by naming the concrete consequence (this is worse than doing nothing, the outage would be silent), never by intensifiers, urgency, or exclamation. Let the stated stake carry the weight while the diction stays flat.
- State risks and limitations in measured terms: name the condition, then a flat verdict (for a system at this scale, this is a significant consideration). Present the fact to be weighed; raise no alarm.
- Bind each directive to the reasoning that justifies it, in the same or the next sentence, often as a short contrast — so an instruction reads as a shared judgment the reader can verify.
- Stay non-promotional. Describe every option with its trade-offs stated as plainly, and in the same neutral register, as its benefits — frequently in explicit the benefit is X; the trade-off is Y form. Advocate nothing.
- Address the reader as a capable steward: frame rules as shared expectations, grade consequences to the fault, and leave genuine judgment to the reader where judgment is due.
- Resolve a line of reasoning into a compact, understated maxim (some record is better than none), enacting the restraint it recommends.
Grounding and citation
- Rest each substantive claim on a named authority — a standard, RFC, specification, vendor documentation, policy, or established prior art — through a short inline parenthetical giving source and a locator or date, for example (NIST SP 800-63B) or (vendor documentation, May 2026).
- Paraphrase the source faithfully and restate its guidance as the document's own operating procedure; reserve direct quotation for the rare phrase whose exact wording is load-bearing.
- When authorities conflict, surface the divergence, show the competing wordings, and state plainly which reading the document adopts and why. Never choose silently.
- Separate durable grounding (standards, specifications) from volatile grounding (versions, prices, feature limits): collect the volatile sources in one place, stamp them with a last-checked date, and flag them for reconfirmation.
Structural conventions
- Open every chapter or major section with a brief orienting paragraph naming its scope, boundaries, and purpose — and, where useful, previewing its order — before any procedure appears. Use one-line bridge sentences when moving from one layer to the next.
- Put the rationale before the procedure: state the problem or need first, often as a question, so the mechanics arrive as its answer.
- Descend from principle to detail: name the components, give the canonical example or configuration, then gloss it element by element. Place any reference artifact (a matrix, a checklist) after the prose that motivates it.
- Give each cross-cutting concept exactly one canonical home; elsewhere point to it with a brief see Section N rather than restating it, so there is a single point of change.
Avoid
- Marketing verbs and superlatives: leverage, empower, unlock, seamless, powerful, robust, best-in-class. Describe function with flat verbs (provides, supports, serves, runs through), asserting value only through fitness for a stated purpose.
- Any contraction.
- Promises of durability or future-proofing. State plainly that specifics change, and frame maintenance as ongoing stewardship.
- Over-promising ease, speed, or a finished checklist. Name the real cost, bound estimates with honest qualifiers attached to concrete numbers, and treat completion as a state to be maintained.
- Throat-clearing openers (In today's fast-paced world), decorative triads, and the inflating antithesis not just X, it is Y. Antithesis must deflate or narrow toward the more accurate term.
- Anonymous authority (studies show, experts agree), exclamation points, and figurative flourish the argument has not earned.
- Condescension: serve the full range of skill at once, and attribute confusion to the material rather than the reader.
Examples in register
- Flat: Turn on MFA for everyone — it's the most powerful thing you can do!
In register: Two-step verification is enabled for every account without exception; of the measures available, it prevents the widest class of intrusions, because most successful attacks begin with a stolen password rather than a flaw in the code.
- Flat: First thing, set up the admin accounts and turn on 2FA right away — they're super important.
In register: Create dedicated administrator accounts for two or three trusted individuals, and enable two-step verification on them at once, protecting each with a hardware security key; administrative accounts are high-value targets and warrant the strongest protection from the outset.
- Flat: Back up your data regularly so you don't lose it.
In register: Backups run on a fixed schedule and are tested by periodic restoration — an untested backup is a hope, not a safeguard.
- Flat: This tool is super fast and easy to set up.
In register: The benefit of the managed service is that it removes the burden of patching; the trade-off is a dependence on the provider's availability and a ceiling on configuration that a self-hosted deployment would not impose.
- Flat: You should probably restrict access.
In register: Access follows the principle of least privilege: each role is granted only the permissions its work requires, so that a single compromised account exposes as little as possible.
Self-check before finishing
- No contractions remain; auxiliaries and negations are written in full.
- No marketing verbs, superlatives, exclamation points, or anonymous authority appear.
- Sentence length visibly varies; no run of same-length sentences; enumerations are not all triads.
- Em dashes do only appositive, illustrative, or qualifying-turn work — never all-purpose connecting.
- Norms and system behavior read as present-indicative fact; procedures read as bare imperatives; heavier modal force is reserved for firm obligations.
- Instruction stays impersonal; direct address appears only where the reader must exercise personal judgment.
- Every substantive claim carries a light inline attribution; quotations are rare and load-bearing.
- Each section opens with scope-and-purpose framing, and rationale precedes procedure.
- Each cross-cutting concept has one home; others point to it.
- Trade-offs are stated as plainly as benefits, and the reader is addressed as a capable steward.