145
edits
Technical Writing in the Digital Age: Difference between revisions
Technical Writing in the Digital Age (view source)
Revision as of 00:00, 20 November 2023
, 1 year agono edit summary
Natecole54 (talk | contribs) |
Natecole54 (talk | contribs) No edit summary |
||
| Line 84: | Line 84: | ||
==Digital Documentation == | ==Digital Documentation == | ||
Digital documentation is the conversion of physical documents into digital files, enabling easier access, retrieval, and sharing of information. It includes features like searchability, version control, and security measures to ensure data integrity and confidentiality.{{sfn|Lucas |2014 | Digital documentation is the conversion of physical documents into digital files, enabling easier access, retrieval, and sharing of information. It includes features like searchability, version control, and security measures to ensure data integrity and confidentiality.{{sfn|Lucas|2014}} | ||
===Characteristics of Digital Documents=== | ===Characteristics of Digital Documents=== | ||
| Line 95: | Line 95: | ||
====Accessibility ==== | ====Accessibility ==== | ||
Website content should be designed in accordance with Web Content Accessibility Guidelines (WCAG) to ensure that individuals with disabilities are able to access the same information as those without disabilities.{{sfn|WAI |2022 | Website content should be designed in accordance with Web Content Accessibility Guidelines (WCAG) to ensure that individuals with disabilities are able to access the same information as those without disabilities.{{sfn|WAI|2022}} It is a legal requirement to include accessibility features in website design.{{sfn|WCAG|2023}} There are four different types of impairment that can affect how a user interacts and perceives digital documents: vision, mobility, auditory, and cognitive.{{sfn|Robbins|2018|p=42}}Digital documents will need to be optimized so that information can be accessed by hardware and software tools used by people with disabilities.{{sfn|Barr|2010|pp=103-104}} | ||
====Readability==== | ====Readability==== | ||
Digital documents rely on the "Seven Cs" of precise writing to be effective and increase readability. Forms of technical writing must have readability. Readability is a term used to determine whether the content has clarity, conciseness and courtesy.{{sfn|Zeleznik | Digital documents rely on the "Seven Cs" of precise writing to be effective and increase readability. Forms of technical writing must have readability. Readability is a term used to determine whether the content has clarity, conciseness and courtesy.{{sfn|Zeleznik|Burnett|Benson|1999|p=207}} The other four Cs are coherent, concrete, correct and complete.{{sfn|Last|2019}} | ||
====Scannability==== | ====Scannability==== | ||
| Line 113: | Line 113: | ||
====Version Control==== | ====Version Control==== | ||
Version control is a characteristic of digital documents that allows for the tracking of edits and revisions to digital documents. In collaborative writing, version control helps maintain the document with accountability and transparency.{{sfn|Lucas|2023d | Version control is a characteristic of digital documents that allows for the tracking of edits and revisions to digital documents. In collaborative writing, version control helps maintain the document with accountability and transparency.{{sfn|Lucas|2023d}} | ||
==== Remote Collaboration ==== | ==== Remote Collaboration ==== | ||
| Line 170: | Line 170: | ||
==Ethical Considerations== | ==Ethical Considerations== | ||
In technical workplaces, resolving ethical dilemmas will be part of one's job. Resources, time, and reputations are at stake, so one will feel pressure to overpromise, underdeliver, bend the rules, cook the numbers, or exaggerate results. Technical fields are also highly competitive, so people sometimes stretch a little further than they should. Ethical dilemmas can force one into situations in which all choices seem unsatisfactory.{{sfn|Johnson-Sheehan|2018| | In technical workplaces, resolving ethical dilemmas will be part of one's job. Resources, time, and reputations are at stake, so one will feel pressure to overpromise, underdeliver, bend the rules, cook the numbers, or exaggerate results. Technical fields are also highly competitive, so people sometimes stretch a little further than they should. Ethical dilemmas can force one into situations in which all choices seem unsatisfactory.{{sfn|Johnson-Sheehan|2018|pp=71-84}} | ||
The Society for Technical Communication (STC) is the world's oldest professional association dedicated to advancing the field of technical communication.{{sfn|STC|2023}} The STC promotes adherence to a list of ethical principles. They are legality, honesty, confidentiality, quality, fairness, and professionalism.{{sfn|STC|2023}} | The Society for Technical Communication (STC) is the world's oldest professional association dedicated to advancing the field of technical communication.{{sfn|STC|2023}} The STC promotes adherence to a list of ethical principles. They are legality, honesty, confidentiality, quality, fairness, and professionalism.{{sfn|STC|2023}} | ||