Technical writing

In short

Technical writing is purpose-driven writing that conveys factual, specialised information to a defined reader so that the reader can do something — operate a machine, follow a procedure, take a decision, or comply with a rule. It is judged by accuracy, clarity, brevity and usability, not by style or imagination, and it always has a known audience and a documented purpose. For BA English students it is examined in Professional/Technical Writing and Communicative English papers (UGC CBCS and the AICTE-model "Technical Communication" course) through report, letter, memo, proposal, abstract and manual questions, and it is the single most employable component of the paper. Indian employers hire BA English graduates for it directly: TCS, Infosys, Wipro, Cognizant, HCL, Zoho, Freshworks, Adobe India, SAP Labs, Oracle India, Siemens and hundreds of SMEs recruit technical writers, documentation executives and content/documentation analysts, usually through a written test plus a sample-editing round.

Explained

What technical writing is, and what it is not

• Definition: writing that presents technical or specialised subject matter accurately, objectively and in the form most usable by a specific audience for a specific purpose.
• Seven C's it is graded against: clear, concise, correct, complete, concrete, courteous, coherent — add consistent for documentation work.
• Core attributes: audience-specific, purpose-driven, fact-based, objective (no persuasion for its own sake), structured with headings and visuals, standardised in format, revisable and reusable.
• Distinguishing marks against literary writing: denotative vocabulary (one word, one meaning), no figurative language, impersonal tone, visual-heavy, scannable rather than read linearly.
• Not the same as general writing: a technical document is a *product*, usually versioned, reviewed and approved, and legally relevant (a wrong warning in a manual is a liability).
• Ethics and law: no plagiarism (UGC Academic Integrity Regulations, 2018 apply to student work); no suppressing adverse data; a manual's safety warnings and product information attract the Consumer Protection Act, 2019 and the Legal Metrology (Packaged Commodities) Rules, 2011 for declarations; copyright of work written in employment vests with the employer under the Copyright Act, 1957 unless agreed otherwise.

Audience, purpose and the writing process

• Audience analysis decides everything: classify readers as lay/general (no background), technician/operator (needs steps), expert/peer (needs data and method), manager/executive (needs decision, cost, risk), mixed (write layered — summary for managers, appendix for experts).
• Purpose classification: to inform, to instruct, to record, to persuade/recommend, to comply.
• Process, five stages:
  1. Planning — define purpose, audience, scope, deliverable, deadline; collect the brief.
  2. Research — primary (interviews with SMEs, observation, trials, questionnaires) and secondary (specifications, standards, prior documents, journals); record sources.
  3. Organising — outline; choose a pattern: chronological, spatial, general-to-specific, cause-effect, problem-solution, order of importance (inverted pyramid), comparison.
  4. Drafting — write to the outline, one idea per paragraph, visuals placed where referred.
  5. Revising — three passes: technical accuracy (with the SME), language and style, then format/consistency; followed by proofreading of the final copy.
• Single sourcing and reuse: write a topic once, publish to PDF, HTML and help; this is why DITA/structured authoring and a style guide matter in industry.

Types of technical documents (the examinable list)

• Technical report — the central form; sub-types: informational (states facts: progress, trip, trouble, inspection), analytical/interpretive (analyses and concludes: feasibility, market, test), recommendation report, routine/periodic (daily, monthly) and special/one-off.
• Standard long-report structure (three parts):
  • *Front matter:* cover, title page, letter of transmittal/forwarding letter, acknowledgement, table of contents, list of tables and figures, list of abbreviations and symbols, abstract/executive summary.
  • *Body:* introduction (background, purpose, scope, limitations), methodology, results/data, discussion/analysis, conclusions, recommendations.
  • *Back matter:* references/bibliography, appendices, glossary, index.
• Short/memo report: heading (To, From, Date, Subject), context, findings, action — one to three pages, no front matter.
• Proposal: solicited (against an RFP/tender) or unsolicited; internal or external. Parts: background/problem, objectives, scope of work, methodology, deliverables, schedule, team/credentials, budget, terms, conclusion.
• Feasibility report: compares options against stated criteria — technical, economic, operational, legal, schedule feasibility — and recommends one.
• Instruction manuals and user guides: safety information first, specifications, installation, operation step-by-step, maintenance schedule, troubleshooting table, warranty and service contacts; numbered imperative steps, one action per step.
• SOP (standard operating procedure): title, SOP number and version, effective date, purpose, scope, responsibility, materials/equipment, step-by-step procedure, records, references, approval signatures, revision history.
• Business correspondence: enquiry, quotation, order, complaint/claim and adjustment, sales, collection, job application with résumé/CV, appointment and resignation letters; formats — full block (most used), modified block, semi-block.
• Office documents: memorandum, circular, office order, notice, agenda, minutes of meeting (recorded in reported speech, past tense, impersonal), e-mail.
• Short forms: abstract (descriptive vs informative), executive summary, précis, synopsis, technical description, technical definition (parenthetical, sentence/formal, expanded), process description, specification, data sheet, FAQ, release notes, API documentation.
• Visual aids: table (exact values), line graph (trend), bar chart (comparison), pie chart (share, ≤6 slices), flow chart, organisation chart, exploded/cutaway diagram, photograph, screenshot, Gantt chart (schedule); every visual needs a number, a caption (table caption above, figure caption below), units, source and an in-text reference.

Style, language and mechanics

• Plain English rules: prefer the short word, the known word, the active voice; average sentence 15–20 words; one idea per sentence; no nominalisation ("make an adjustment to" → "adjust").
• Voice: active for instructions and recommendations ("Press the reset button"); passive legitimately where the actor is unknown or irrelevant ("The samples were tested at 40 °C").
• Mood: imperative for steps; indicative for description; avoid "should" where "must" is meant — in standards drafting shall/must = mandatory, should = recommended, may = permitted, can = possible (ISO/IEC and BIS drafting convention).
• Common faults to remove: jargon without definition, undefined abbreviations on first use, redundancy ("absolutely essential", "basic fundamentals"), clichés, ambiguous pronouns, dangling modifiers, inconsistent tense, overlong noun strings ("pump outlet pressure monitoring device failure analysis").
• Mechanics: SI units with a space before the symbol (5 kg, 230 V, 40 °C; no plural "kgs"), 24-hour clock or clear a.m./p.m., Indian rupee as ₹ or INR, dates as 04 November 2026 or ISO 2026-11-04, numbers one to nine in words and 10 upward in figures (house style varies), lakh/crore acceptable in Indian-audience documents but convert for export documents.
• Documentation hygiene: a style guide (house, or Microsoft Writing Style Guide / Chicago / IEEE as base), a terminology list, numbered headings (1, 1.1, 1.1.1), version and revision history, controlled vocabulary for reused warnings (DANGER / WARNING / CAUTION / NOTE in descending severity).
• Citation styles examined: MLA 9 (English papers), APA 7, IEEE numeric, Chicago; keep one style throughout and cite every figure, standard and quotation.

Readability, usability and testing

• Readability indices estimate reading difficulty from sentence and word length — useful but blind to content, so never the only test.
• Usability checks: read-and-do test (a naive user performs the task from the draft), comprehension test, SME technical review, editorial review (substantive → copy edit → proofread), accessibility check (alt text, contrast, heading order).
• Document-design principles: chunking, white space, consistent typography (one serif/sans pair, 2–3 sizes), parallel headings, bullets for unordered items and numbers for sequence, tables for comparison, index and cross-references for retrieval.
• Advantages of good technical writing: fewer support calls and accidents, faster training, legal defensibility, reusable content, better product perception.
• Limitations: costly and time-consuming to maintain; goes stale the moment the product changes; over-standardisation can flatten useful nuance; readability formulas and templates can be gamed without real clarity.

Indian standards, codes and practice

• BIS (Bureau of Indian Standards, under the BIS Act, 2016) publishes Indian Standards; a standard is quoted as IS number : year of edition, for example IS 2:1960 (Rules for rounding off numerical values) and IS 962 for architectural and building drawing practice — always verify the current edition on the BIS portal, since many old IS numbers are withdrawn or superseded. Where unsure, name the subject ("the Indian Standard on technical drawing practice") rather than guess a number.
• Documentation of software is commonly written to ISO/IEC/IEEE 26514 and 26511-26515 (user documentation and documentation management); quality models from ISO/IEC 25010. Quality systems demand documents: ISO 9001 (the 2026 edition, published 16 September 2026, succeeding ISO 9001:2015) requires documented information with control of versions and records.
• Statutory writing in India: safety data sheets and workplace safety documents now sit under the Occupational Safety, Health and Working Conditions Code, 2020, which came into force on 21 November 2025 and replaced the Factories Act, 1948 and the BOCW Act; wage and service documents follow the Code on Wages, 2019 and the Industrial Relations Code, 2020 (also in force from 21 November 2025). Tax-related documentation follows the Income-tax Act, 2025, effective 1 April 2026, which renumbered the sections and forms of the 1961 Act — cite the provision by name unless the new number is certain. Invoices and quotations state GST at the current slabs of 5%, 18% and 40% (restructured with effect from 22 September 2025), plus nil-rated and the special rates for bullion.
• Other practice points: the Right to Information Act, 2005 makes much government documentation disclosable, so write assuming publication; the Official Languages Act, 1963 and Rule 3(3) require certain central-government documents to be issued bilingually in Hindi and English; DPDP Act, 2023 will govern how user data is described and handled in privacy notices — its notice and consent duties apply from 13 May 2027 (Rules notified 13 November 2025); until then privacy policies follow IT Act s.43A and the SPDI Rules, 2011.

Key points

• Technical writing — factual, audience-specific writing that enables a reader to act or decide.
• Audience analysis — the first step; lay, technician, expert, manager and mixed readers need different depth.
• Purpose statement — one sentence naming what the document must achieve; written before the outline.
• Seven C's — clear, concise, correct, complete, concrete, courteous, coherent (plus consistent).
• Report types — informational (facts) versus analytical (analysis, conclusions, recommendations).
• Three-part report — front matter, body, back matter; transmittal letter and abstract are front matter.
• Abstract vs executive summary — abstract (100-250 words) tells a researcher what the report covers; executive summary gives a manager the findings and recommendations.
• Descriptive vs informative abstract — descriptive says what the report is about; informative gives the actual results.
• Proposal — solicited or unsolicited; must carry scope, methodology, schedule, budget, credentials.
• Feasibility report — evaluates options against technical, economic, operational, legal and schedule criteria.
• SOP — numbered, versioned, approved procedure with responsibility and revision history.
• Manual sequence — safety, specifications, installation, operation, maintenance, troubleshooting, warranty.
• Imperative steps — one action per numbered step, active voice, second person implied.
• Shall/should/may — mandatory, recommended, permitted, in standards and specification language.
• Visuals — numbered and captioned (table caption above, figure below), with units, source and a text reference.
• Readability — Fog index ≈ target school grade; Flesch Reading Ease higher is easier; both ignore accuracy.
• Revision layers — technical review, substantive edit, copy edit, proofread, in that order.
• Indian compliance — BIS/IS standards by current edition, ISO 9001:2026 documented information (2015-edition certificates valid during the transition to September 2029), the four Labour Codes in force from 21 November 2025, GST slabs 5/18/40 since 22 September 2025.

Formulas and examples

Example 1 — Fog index of a draft paragraph. A draft has 300 words, 20 sentences and 36 complex words.

• Words per sentence = 300 ÷ 20 = 15.
• Complex-word percentage = 100 × 36 ÷ 300 = 12.
• Fog = 0.4 × (15 + 12) = 0.4 × 27 = 10.8 → about Class 11 reading level; acceptable for a consumer manual.
• Rewrite halves the complex words to 18 and splits sentences to 25: 300 ÷ 25 = 12; 100 × 18 ÷ 300 = 6; Fog = 0.4 × 18 = 7.2 — now suitable for a general operator audience.

Example 2 — Flesch Reading Ease of the same draft. 300 words, 20 sentences, 480 syllables.

• Words/sentence = 15; syllables/word = 480 ÷ 300 = 1.6.
• RE = 206.835 − 1.015 × 15 − 84.6 × 1.6 = 206.835 − 15.225 − 135.36 = 56.25 → "fairly difficult"; below the 60-70 plain-English band, so shorten words and sentences.
• Flesch-Kincaid grade = 0.39 × 15 + 11.8 × 1.6 − 15.59 = 5.85 + 18.88 − 15.59 = 9.14 → Class 9 level.

Example 3 — Rewriting a passive, jargon-heavy instruction.

• Draft (28 words, passive): "It should be ensured by the operator that the de-energisation of the control panel has been effectuated prior to the commencement of any maintenance activity on the unit."
• Edit: "Switch off and lock out the control panel before you service the unit." (13 words, active, imperative, one action.)
• Measured change: ASL 28 → 13; complex words 6 → 0; Fog for a one-sentence sample falls from 0.4 × (28 + 100 × 6/28) = 0.4 × (28 + 21.43) = 19.8 to 0.4 × (13 + 100 × 0/13) = 0.4 × 13 = 5.2.
• Add a severity label: WARNING — live 415 V inside the panel. Lock out and tag out before opening.

Example 4 — Quotation arithmetic in a proposal (GST). A documentation contract quotes 240 pages of user-manual authoring at ₹850 per page, plus ₹40,000 for illustration.

• Authoring = 240 × 850 = ₹2,04,000; total taxable value = 2,04,000 + 40,000 = ₹2,44,000.
• GST on documentation services at 18% = 0.18 × 2,44,000 = ₹43,920.
• Invoice total = 2,44,000 + 43,920 = ₹2,87,920. State the slab and the HSN/SAC code in the quotation, and note that rates are those in force from 22 September 2025.

Example 5 — Schedule table for the same project (a Gantt in table form).

Total = 47 working days ≈ 9.4 five-day weeks; at ₹2,44,000 the realised rate is about ₹5,191 per working day.

Comparison table — document forms

Comparison table — technical versus literary/general writing

Where it is used

• IT and software product companies: TCS, Infosys, Wipro, Cognizant, HCLTech, Zoho, Freshworks, Adobe India, SAP Labs, Oracle India and Microsoft IDC hire technical writers for user guides, online help, API and release documentation, with tools such as MadCap Flare, Adobe FrameMaker, Oxygen XML, Confluence, Git and Markdown.
• Engineering, manufacturing and automotive: L&T, BHEL, Siemens India, Tata Motors, Mahindra and Bosch produce operation and maintenance manuals, spare-parts catalogues, tender and feasibility reports, and ISO 9001-controlled work instructions.
• Pharma, healthcare and clinical research: SOPs, batch records, regulatory dossiers and medical writing at Sun Pharma, Dr Reddy's, Biocon, Syngene and CROs — governed by CDSCO requirements and GMP documentation practice.
• Government, PSUs and consultancies: DRDO, ISRO, NTPC, Indian Railways and state departments require project reports, DPRs, tender documents, RTI-ready file notes and bilingual (Hindi-English) circulars.
• Banking, insurance and finance: product brochures, policy wordings, compliance manuals, annual-report sections and RBI/SEBI-mandated disclosures written in plain language.
• Job roles open to BA English graduates: technical writer, documentation executive, content/documentation analyst, instructional designer, UX writer, proposal/bid writer, editor in publishing and e-learning (EdTech firms like BYJU'S, Vedantu and NCERT-aligned publishers).

Interview questions

• Q: How is technical writing different from creative writing? A: Technical writing is objective, factual and audience-task-driven with one unambiguous meaning per word; creative writing aims at interpretation and emotional effect through figurative language.
• Q: What is the first step before drafting any technical document? A: Audience and purpose analysis — who will read it, what they already know, and what they must be able to do after reading; the outline and depth follow from that.
• Q: Difference between an abstract and an executive summary? A: An abstract (100-250 words) tells a researcher what the document covers so they can decide whether to read it; an executive summary gives a manager the findings, conclusions and recommendations so they can decide without reading the body.
• Q: Descriptive versus informative abstract? A: A descriptive abstract states the scope and nature of the work only; an informative abstract also states the results, conclusions and recommendations.
• Q: When is passive voice acceptable in technical writing? A: When the actor is unknown, irrelevant or obvious, or when the object is the subject of interest — typically in methodology and test reports ("the samples were heated to 40 °C").
• Q: Why do standards distinguish "shall" from "should"? A: "Shall"/"must" states a mandatory requirement, "should" a recommendation, "may" a permission and "can" a possibility; mixing them makes a specification unenforceable.
• Q: What goes into a troubleshooting section, and in what form? A: A three-column table of symptom, probable cause and corrective action, ordered from most likely cause, with a cross-reference to the detailed procedure and a safety warning where live parts are involved.
• Q: How would you document a feature you do not technically understand? A: Interview the subject-matter expert with prepared questions, read the specification and test the feature myself, draft, then put the draft through SME technical review before language editing.
• Q: What is single sourcing and why does industry use it? A: Writing content once in a structured, reusable form and publishing it to several outputs (PDF, HTML help, print), which cuts cost and keeps all channels consistent.
• Q: What does the Fog index tell you, and what does it miss? A: It estimates the years of education a reader needs from sentence length and complex-word share; it cannot judge accuracy, organisation, tone or whether the reader can actually complete the task.
• Q: How do you structure a 10-page instruction manual for a water purifier sold in India? A: Safety warnings, box contents and specifications, installation, operation, filter-change maintenance schedule, troubleshooting table, warranty and service contacts — short imperative steps with labelled diagrams, and the declarations required under the Legal Metrology packaged-commodities rules.
• Q: How do you handle a conflict between what the engineer says and what the product does? A: Test and document the observed behaviour, record the discrepancy in writing, escalate it as a defect or specification error, and hold the document until the authoritative answer is approved — never publish an untested claim.

Common mistakes

• Writing a literary, adjective-heavy answer in a technical-writing paper — examiners mark the format, objectivity and completeness of parts, not elegance.
• Omitting prescribed parts of a report (letter of transmittal, list of figures, limitations, recommendations) and losing format marks.
• Confusing abstract with executive summary, or informational with analytical reports.
• Writing instructions in descriptive sentences ("The button is then pressed") instead of numbered imperative steps with one action each.
• Inserting a table or chart without a number, caption, units, source or any reference to it in the text.
• Leaving abbreviations, jargon and acronyms undefined at first use, and inconsistent terminology for the same part across a document.
• Quoting an obsolete figure or standard — an old IS number, a pre-2025 labour Act or a withdrawn GST rate — instead of verifying the current edition and provision.

Related topics

Content writing · Copywriting · Editing and proofreading · Translation · Business correspondence and report writing · Presentation and interview skills