90
edits
Technical Writing in the Digital Age: Difference between revisions
Technical Writing in the Digital Age (view source)
Revision as of 18:34, 27 November 2023
, 6 months ago→Characteristics of Technical Communication: Removed extra spaces before some citations.
m (Moved Digital Technologies Tools section under Rhetorical Strategies in the Digital Age section) |
Debbiebwolfe (talk | contribs) m (→Characteristics of Technical Communication: Removed extra spaces before some citations.) |
||
| Line 9: | Line 9: | ||
=== Characteristics of Technical Communication === | === Characteristics of Technical Communication === | ||
Because technical communication is intended to guide an audience, it must be assembled in such a way that it is easily understood. Successful technical documentation is accurate, logically sound, and appropriate. {{sfn|Perelman|1998}} Communication can be said to be accurate in two different understandings: accurate in description and accurate in content. Accurate descriptions are easy to understand. Accurate content provides for the intended result. Communication that is delivered logically is well-organized and clear and can be approached in a manner that will be coherent for most users. Technical information that is appropriate contains elements and steps that are suitable for the intended purpose and audience. | Because technical communication is intended to guide an audience, it must be assembled in such a way that it is easily understood. Successful technical documentation is accurate, logically sound, and appropriate.{{sfn|Perelman|1998}} Communication can be said to be accurate in two different understandings: accurate in description and accurate in content. Accurate descriptions are easy to understand. Accurate content provides for the intended result. Communication that is delivered logically is well-organized and clear and can be approached in a manner that will be coherent for most users. Technical information that is appropriate contains elements and steps that are suitable for the intended purpose and audience. | ||
==Historical Context== | ==Historical Context== | ||
| Line 19: | Line 19: | ||
Advances in technology thrust the technical writing profession into a new era. The work of the technical writer may now also include not only text, but also images, drawings, and computer-based media. The current role of the technical writer is not only to write, but they may also be involved in research and information gathering, speaking with technical experts, and selecting document mediums and project tools.{{sfn|Macari|2023}} | Advances in technology thrust the technical writing profession into a new era. The work of the technical writer may now also include not only text, but also images, drawings, and computer-based media. The current role of the technical writer is not only to write, but they may also be involved in research and information gathering, speaking with technical experts, and selecting document mediums and project tools.{{sfn|Macari|2023}} | ||
The projects of today's technical writers can be as varied as writing instructions to assemble a living room chair to creating websites. {{sfn|Grimstead|1999}} The titles of today's technical writers may vary as well. They may be referred to by names as diverse as information architects to documentation specialists.{{sfn|Grimstead|1999}} | The projects of today's technical writers can be as varied as writing instructions to assemble a living room chair to creating websites.{{sfn|Grimstead|1999}} The titles of today's technical writers may vary as well. They may be referred to by names as diverse as information architects to documentation specialists.{{sfn|Grimstead|1999}} | ||
==Features of Technical Communication== | ==Features of Technical Communication== | ||
| Line 97: | Line 97: | ||
====Descriptions==== | ====Descriptions==== | ||
Descriptions are concise explanations of procedures and processes that assist readers in understanding how something works. Product descriptions and process descriptions are the two main types of technical descriptions. {{sfn|Lannon|Gurak|2020|pp=443-453}} | Descriptions are concise explanations of procedures and processes that assist readers in understanding how something works. Product descriptions and process descriptions are the two main types of technical descriptions.{{sfn|Lannon|Gurak|2020|pp=443-453}} | ||
*Product: provides detailed information about a specific item, including its features, specifications, and benefits. | *Product: provides detailed information about a specific item, including its features, specifications, and benefits. | ||
| Line 141: | Line 141: | ||
==== Resumes ==== | ==== Resumes ==== | ||
Resumes offer an overview of an individual’s educational credentials and professional experience and often are used to demonstrate an applicant’s qualifications to potential employers. {{sfn|Johnson-Sheehan|2018|p=100}} They may be organized in various ways, but two common approaches are chronologically and by skills. | Resumes offer an overview of an individual’s educational credentials and professional experience and often are used to demonstrate an applicant’s qualifications to potential employers.{{sfn|Johnson-Sheehan|2018|p=100}} They may be organized in various ways, but two common approaches are chronologically and by skills. | ||
Chronological resumes demonstrate the sequence of education and employment history and detail a person’s tasks, responsibilities, and achievements in each successive role. | Chronological resumes demonstrate the sequence of education and employment history and detail a person’s tasks, responsibilities, and achievements in each successive role. | ||
Skills resumes provide employment history, but the primary focus is to highlight how an individual applied distinct skills and experiences across various professional positions. {{sfn|Markel|Selber|2019|pp=411-412}} | Skills resumes provide employment history, but the primary focus is to highlight how an individual applied distinct skills and experiences across various professional positions.{{sfn|Markel|Selber|2019|pp=411-412}} | ||
==== User guides ==== | ==== User guides ==== | ||
| Line 183: | Line 183: | ||
====Scannability==== | ====Scannability==== | ||
A document's scannability is determined by the ease in which it can be scanned to determine meaning. Readers often scan pages for words and phrases that align with their task or interests, as well as for trigger words that are deeply ingrained.{{sfn|Krug|2014|p=23}} The most effective web content is concise and simple to scan, making it easy for users to find the important information. Breaking up text into interesting, easy-to-read sections helps users quickly find information. {{sfn|Barr|2010|p=103}} Ways to improve a document's scannability include visual elements, white space, concise language, and highlighting and emphasis. | A document's scannability is determined by the ease in which it can be scanned to determine meaning. Readers often scan pages for words and phrases that align with their task or interests, as well as for trigger words that are deeply ingrained.{{sfn|Krug|2014|p=23}} The most effective web content is concise and simple to scan, making it easy for users to find the important information. Breaking up text into interesting, easy-to-read sections helps users quickly find information.{{sfn|Barr|2010|p=103}} Ways to improve a document's scannability include visual elements, white space, concise language, and highlighting and emphasis. | ||
====Ease of Reproduction and Distribution==== | ====Ease of Reproduction and Distribution==== | ||