Introduction to Technical Writing/Rhetorical Situations

G - Genre

The category of writing that defines its style and structure.

User documentation

Explains a topic to a novice so that they understand.

Traditional technical writing

Geared towards an audience that has a little bit of an understanding already.

Technical marketing communications

Promotional writing that aims to persuade the audience.

Professional/business communication

Documents written in the workplace, either formal or informal.

Primary Audience

The one who requested or authorized the document and is likely to take action based on it.

Secondary Audience

Those affected by the document, interested in its decisions, and likely to read some parts.

Purpose in technical writing

The specific end or outcome obtained, such as to inform, persuade, or instruct.

Scope

What information is included or excluded, and its relevance to achieving the document's purpose.

Medium

The format through which information is conveyed, such as printed documents or digital formats.

Design

Creating a document that is easy to access, navigate, and remember.

H - Headings

Marks off different sections of the document.

A - Access

Visual cues that help a reader navigate and understand the writing.

T - Typography

Choosing fonts that match the content/character of the document.

S - Space

Refers to the spacing between sections in technical writing, typically between 1.15 and 1.5.

Heading vs. Header

Heading is within the text; Header contains page numbers and document's name.

Serifs

Little slashes at the bottom of letters in certain fonts.

Weight in typography

The overall thickness of a font.

Stroke variation

The level of difference between the width of strokes in letters.

Rhetorical situation

The context considering all elements before creating any document.

Technical documents

Types of documents that include user documentation, traditional technical writing, and professional communication.

Example of user documentation

A manual or booklet explaining how to use a product.

Example of traditional technical writing

A paper published in an engineering journal.

Example of technical marketing communication

A promotional ad that persuades consumers.

Example of professional business communication

A resume or proposal.

Knowledge level

Understanding of the topic by the audience.

Interests

What engages or captivates the audience's attention.

Role

The position of the audience in relation to the topic.

Cultural background/diversity

The variety of cultural influences affecting understanding.

Personality

Characteristics that shape how the audience may receive the document.