Jump to content

Technical Writing in the Digital Age: Difference between revisions

Technical Writing in the Digital Age (view source)

Revision as of 15:59, 27 November 2023

No change in size ,  11 months ago
m
Moved Historical Context section under Overview Section
m (→‎Bibliography: Removed duplicate entry (Balzotti) & corrected formatting)
m (Moved Historical Context section under Overview Section)
Line 10: Line 10:
=== 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==
===Technical Writing Profession ===
Joseph P. Chapline is considered to be one of the first technical writers, having written in 1949 the first ever user manual for the Binary Automatic Computer (BINAC), an early personal computer.{{sfn|Malone|2008}} In the 1950s, technical writing as a distinct profession began to take shape when technical writers founded formal organizations, academic programs, and conferences dedicated to the art. One of these key writing associations was the Association of Technical Writers and Editors, also formed in the 1950s. Several of these groups eventually merged, forming the Society of Technical Communication in 1960.{{sfn|Malone|2011|pp=285-306}}
The need for paperwork ushered in by World War II served as the driving force for the technical writing profession in the United States.{{sfn|Rathbone|1958}} This was a time years before the computer and photocopier became common office equipment. During this period, the role of the technical writer revolved solely around words, and their primary work tools consisted of either a pencil or ink pen and paper. The technical writer would draft the document by hand, and a typist or clerical worker would then use a typewriter to transfer the writer's words into a finished document. 
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}}


== Technical Documents ==
== Technical Documents ==
Line 126: Line 136:
==== Text Editors====
==== Text Editors====
Text editors are fundamental technical and digital writing tools, offering a platform for creating and manipulating plain text files. They are indispensable for programming tasks, providing syntax highlighting and code folding features. Text editors are commonly used to write code, markup languages (HTML, XML, Markdown), and edit configuration files.{{sfn|Godson|p=37-41}} Notable examples include [https://apps.microsoft.com/detail/windows-notepad/9MSMLRH6LZF3?hl=en-US&gl=US Notepad] (Windows), [https://support.apple.com/guide/textedit/welcome/mac TextEdit] (macOS), and [https://notepad-plus-plus.org/ Notepad++]. Whether for programmers, writers, or system administrators, text editors play a crucial role in content creation and technical work.
Text editors are fundamental technical and digital writing tools, offering a platform for creating and manipulating plain text files. They are indispensable for programming tasks, providing syntax highlighting and code folding features. Text editors are commonly used to write code, markup languages (HTML, XML, Markdown), and edit configuration files.{{sfn|Godson|p=37-41}} Notable examples include [https://apps.microsoft.com/detail/windows-notepad/9MSMLRH6LZF3?hl=en-US&gl=US Notepad] (Windows), [https://support.apple.com/guide/textedit/welcome/mac TextEdit] (macOS), and [https://notepad-plus-plus.org/ Notepad++]. Whether for programmers, writers, or system administrators, text editors play a crucial role in content creation and technical work.
==Historical Context==
===Technical Writing Profession ===
Joseph P. Chapline is considered to be one of the first technical writers, having written in 1949 the first ever user manual for the Binary Automatic Computer (BINAC), an early personal computer.{{sfn|Malone|2008}} In the 1950s, technical writing as a distinct profession began to take shape when technical writers founded formal organizations, academic programs, and conferences dedicated to the art. One of these key writing associations was the Association of Technical Writers and Editors, also formed in the 1950s. Several of these groups eventually merged, forming the Society of Technical Communication in 1960.{{sfn|Malone|2011|pp=285-306}}
The need for paperwork ushered in by World War II served as the driving force for the technical writing profession in the United States.{{sfn|Rathbone|1958}} This was a time years before the computer and photocopier became common office equipment. During this period, the role of the technical writer revolved solely around words, and their primary work tools consisted of either a pencil or ink pen and paper. The technical writer would draft the document by hand, and a typist or clerical worker would then use a typewriter to transfer the writer's words into a finished document. 
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}}


==Personas in Digital Writing==
==Personas in Digital Writing==
Retrieved from "https://litwiki.org/wiki/Special:MobileDiff/19545"