Characteristics_of_technical_writing

TOPIC LOCATION CHART

Characteristics oftechnical writing24 NOVEMBER 2014

outline Review of key elements of technical writing (TW) Presence of key elements in various types of TW Characteristics of the elements in each type

KEY ELEMENTS AUDIENCE ACTION ACCESSIBILITY

DOCUMENTS  Manuals/styleguides  Memos/letters  Minutes of meeting  Project proposals

Manuals/styleguideAudience Action Accessibility- User of - proper use of - Definition service/equipment equipment/service - Description - Procedure- Implementer of - Proper - Guidelines program implementation of program

Definition ARE WE TALKING ABOUT THE SAME THINGS?

Description ARE YOU REALLY SURE THAT WE’RE TALKING ABOUT THE SAME THINGS?

Procedures HERE’S WHAT WE DO FIRST (2ND, 3RD, 4TH, ETC.)

GUIDELINES LET’S NOT DO THIS THIS IS HOW FAR WE SHOULD GO THESE MUST BE REMEMBERED

CHARACTERISTICSDEFINITION/DESCRIPTION PROCEDURES GUIDELINES- Simplicity - Structure (sequence) - Clarity- Clarity- Structure (connection)

Memos/lettersAudience Action Accessibility- Recipient - To respond - Purpose - Details - Action

CHARACTERISTICSPurpose Details Action- Simplicity - Structure - Clarity- Clarity - Completeness

CLARITY INPURPOSE  Why are you writing?

COMPLETENESSIN DETAILS  What are the things the recipient needs to know?

STRUCTURE INDETAILS How are the pieces of info organized?

CLARITY INACTION  What do you want me tote recipient do?

MINUTES OF MEETINGAudience Action Accessibility- Participants in the - To synchronize - Partsmeeting movements in implementation of - Timing decisions

CHARACTERSITICSPARTS TIMING - Structure- Immediacy

STRUCTURE INPARTS  Can we clearly identify the topic, discussions and decisions?

IMMDEDIACY INTIMING  Can the copy be released ASAP?

PROJECT PROPOSALAudience Action Accessibility- Approving body - To approve - Purpose - Details - Action

CHARACTERISTICSPurpose Details Action- Simplicity - Structure - Clarity- Clarity - Completeness