Technical Writing in the Digital Age - Revision history

Admin: Protected "Technical Writing in the Digital Age": Protected for evaluation. ([Edit=Allow only administrators] (expires 13:42, 9 December 2023 (UTC)) [Move=Allow only administrators] (expires 13:42, 9 December 2023 (UTC)))

2023-12-02T13:42:18Z

Protected "Technical Writing in the Digital Age": Protected for evaluation. ([Edit=Allow only administrators] (expires 13:42, 9 December 2023 (UTC)) [Move=Allow only administrators] (expires 13:42, 9 December 2023 (UTC)))

← Older revision	Revision as of 09:42, 2 December 2023
(No difference)

Kamyers: /* Pedagogical Approaches */ minor edits - added/deleted commas and reordered sentence for clarity

2023-12-02T04:50:37Z

Pedagogical Approaches: minor edits - added/deleted commas and reordered sentence for clarity

← Older revision		Revision as of 00:50, 2 December 2023
Line 333:		Line 333:
	=='''Pedagogical Approaches'''==		=='''Pedagogical Approaches'''==
	==='''Writing Styles'''===		==='''Writing Styles'''===
	Informal writing, such as some emailing, instant messaging, and texting, has crept into academic writing. In a study conducted by the Pew Internet & America Life Project, almost half of the respondents admitted to omitting proper punctuation and capitalization in their schoolwork. Others even used emoticons. Colleges and universities must now educate students on the different forms of written communication, and when best to employ them.{{sfn\|Carroll\|2010\|p=20}}		Informal writing, such as some emailing, instant messaging, and texting, has crept into academic writing. In a study conducted by the Pew Internet & America Life Project, almost half of the respondents admitted to omitting proper punctuation and capitalization in their schoolwork. Others even used emoticons. Colleges and universities must now educate students on the different forms of written communication and when best to employ them.{{sfn\|Carroll\|2010\|p=20}}

	==='''Multimedia Writing'''===		==='''Multimedia Writing'''===
	Best practices for tone, grammar, and style can vary depending on the form of media (auditory, visual, print, etc.), and many digital writings will combine two or more of these media formats. Students of technical writing may be taught specific techniques for different types of media ~~in order~~ to become proficient multimedia writers.{{sfn\|Garrand\|2006\|p=23}} ~~Gunther Kress and Theo van Leeuwen in~~ their book ''Reading Images: The Grammar of Visual Design'' introduce the concept of visual grammar, which relates to multimodality that helps with complex ideas in visual grammar. Kress and van Leeuwen suggest that visual elements should follow a set of grammatical rules to construct visual designs.{{sfn\|Kress\|van Leeuwen\|2020}}		Best practices for tone, grammar, and style can vary depending on the form of media (auditory, visual, print, etc.), and many digital writings will combine two or more of these media formats. Students of technical writing may be taught specific techniques for different types of media to become proficient multimedia writers.{{sfn\|Garrand\|2006\|p=23}} In their book ''Reading Images: The Grammar of Visual Design'', Gunther Kress and Theo van Leeuwen introduce the concept of visual grammar, which relates to multimodality that helps with complex ideas in visual grammar. Kress and van Leeuwen suggest that visual elements should follow a set of grammatical rules to construct visual designs.{{sfn\|Kress\|van Leeuwen\|2020}}

	==='''Breaking and Building''' ===		==='''Breaking and Building''' ===
	Breaking and building is a method of teaching effective writing that can be applied to technical and digital formats. It asks students to curate collections of digital media by comparing and contrasting ("building"), and ~~also~~ to critically analyze these collections and attempt to reason out the decisions behind them ("breaking").{{sfn\|Coco\|Torres\|2014\|p=175}} Each process has a set of targeted learning outcomes. Learning outcomes for "building" include making and reflecting on choices to find, group, present, and compile digital content. Learning outcomes for "breaking" include identifying and critiquing decisions in curating existing digital content, such as where the content originated, how it is grouped, and how it is presented.{{sfn\|Coco\|Torres\|2014\|pp=178-179}}		Breaking and building is a method of teaching effective writing that can be applied to technical and digital formats. It asks students to curate collections of digital media by comparing and contrasting ("building") and to critically analyze these collections and attempt to reason out the decisions behind them ("breaking").{{sfn\|Coco\|Torres\|2014\|p=175}} Each process has a set of targeted learning outcomes. Learning outcomes for "building" include making and reflecting on choices to find, group, present, and compile digital content. Learning outcomes for "breaking" include identifying and critiquing decisions in curating existing digital content, such as where the content originated, how it is grouped, and how it is presented.{{sfn\|Coco\|Torres\|2014\|pp=178-179}}

	=='''Challenges and Ethical Considerations'''==		=='''Challenges and Ethical Considerations'''==

Kamyers: /* Remediation */ edited for conciseness

2023-12-02T04:41:17Z

Remediation: edited for conciseness

← Older revision		Revision as of 00:41, 2 December 2023
Line 322:		Line 322:

	====Remediation====		====Remediation====
	Remediation is the process through which new media forms borrow elements from older media forms and transform and re-contextualize them. As media evolves, so do the ways users can consume it. When first introduced, remediation was described as a type of reformation, such as taking a paper letter and turning it into an email.{{sfn\|Bolter\|Grusin\|1999\|p=59}} Today, remediation of a digital document often adds to the user experience by enhancing the document. ~~Remediation can look like~~ making a document more accessible by adding a text-to-speech feature for users with poor vision or adding a tutorial to an electronic manual.		Remediation is the process through which new media forms borrow elements from older media forms and transform and re-contextualize them. As media evolves, so do the ways users can consume it. When first introduced, remediation was described as a type of reformation, such as taking a paper letter and turning it into an email.{{sfn\|Bolter\|Grusin\|1999\|p=59}} Today, remediation of a digital document often adds to the user experience by enhancing the document. An example of remediation is making a document more accessible by adding a text-to-speech feature for users with poor vision or adding a tutorial to an electronic manual.

	This can be simplified into two key principals:		This can be simplified into two key principals:

Kamyers: /* Digital Writing Strategies */ edited for conciseness, grammar, punctuation; alt-text > alt text;

2023-12-02T04:39:18Z

Digital Writing Strategies: edited for conciseness, grammar, punctuation; alt-text > alt text;

Show changes

Natecole54: /* Tools for Digital Technology */ Revised paragraph for conciseness, readability, unable to find a reliable source for some of the content.

2023-12-02T03:34:07Z

Tools for Digital Technology: Revised paragraph for conciseness, readability, unable to find a reliable source for some of the content.

← Older revision		Revision as of 23:34, 1 December 2023
Line 219:		Line 219:

	==='''Tools for Digital Technology'''===		==='''Tools for Digital Technology'''===
	With the rise of digital technology, technical writing has had to adapt to the needs of a digital era. The predominant impact of such a revolution was that it made technical communication more accessible by increasing the breadth of its viewers. The World Wide Web is public and can be accessed by anyone with access to the Internet. Such a phenomenon can be exploited to increase the audience of a virtual document. {{Citation needed}}		With the rise of digital technology, technical writing has had to adapt to the needs of a digital era. Technical writers can use various tools to author and present their documents.

	Technical writers can use various tools to author and present their documents.

	====Content Management Systems (CMS)====		====Content Management Systems (CMS)====

Kamyers: /* Technical Communication Strategies */ Edits for conciseness, punctuation, and capital/lower case standards

2023-12-02T03:05:56Z

Technical Communication Strategies: Edits for conciseness, punctuation, and capital/lower case standards

← Older revision		Revision as of 23:05, 1 December 2023
Line 41:		Line 41:
	=='''Technical Communication Strategies'''==		=='''Technical Communication Strategies'''==
	==='''Characteristics of Technical Communication'''===		==='''Characteristics of Technical Communication'''===
	Technical communication is meant to guide an audience and must be 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 delivered logically is well-organized, clear, and will be coherent for most users. ~~Technical~~ information ~~that is appropriate~~ contains elements and steps ~~that are~~ suitable for the intended purpose and audience.{{sfn\|Perelman\|1998}}		Technical communication is meant to guide an audience and must be easily understood. Successful technical documentation is accurate, logically sound, and appropriate.{{sfn\|Perelman\|1998}} Communication can be accurate in description and content. Accurate descriptions are easy to understand. Accurate content provides for the intended result. Communication delivered logically is well-organized, clear, and will be coherent for most users. Appropriate technical information contains elements and steps suitable for the intended purpose and audience.{{sfn\|Perelman\|1998}}

	====Standards Compliant====		====Standards Compliant====
Line 68:		Line 68:

	==='''Examples of Technical Documents'''===		==='''Examples of Technical Documents'''===
	Technical writing encompasses various genres and styles, influenced by the information and discourse communities. Not all technical documents are produced by technical writers, as professionals ~~produce~~ various technical documents.{{sfn\|Lannon\|Gurak\|2020\|p=32}}		Technical writing encompasses various genres and styles influenced by the information and discourse communities. Not all technical documents are produced by technical writers, as many professionals create various technical documents.{{sfn\|Lannon\|Gurak\|2020\|p=32}}

	Common types of technical communication include:{{sfn\|Mussack\|2021}}		Common types of technical communication include:{{sfn\|Mussack\|2021}}
Line 101:		Line 101:

	====Press Releases====		====Press Releases====
	A press release can be an announcement or ~~recent~~ news ~~that is~~ distributed to media outlets ~~from a company,~~ with ~~intentions on spreading the~~ information to the ~~general~~ public. A press release can be called a press-statement, news release or media release.{{sfn\|Pradhan\|2021}}		A press release can be an organization's announcement or latest news distributed to media outlets with information for the public. A press release can be called a press statement, news release, or media release.{{sfn\|Pradhan\|2021}}

	====Proposals====		====Proposals====
Line 112:		Line 112:
	Informal or brief reports provide an objective overview of an organization's current state, past events, and future plans, ensuring that readers are well-informed about the organization's operations. Some examples include{{sfn\|Johnson-Sheehan\|2018\|pp=285-288}}:		Informal or brief reports provide an objective overview of an organization's current state, past events, and future plans, ensuring that readers are well-informed about the organization's operations. Some examples include{{sfn\|Johnson-Sheehan\|2018\|pp=285-288}}:

	*Progress ~~Reports~~ are used to inform management about the progress or status of a project.		*Progress reports are used to inform management about the progress or status of a project.
	* White papers and ~~Briefings~~ educate management or clients about important issues.		* White papers and briefings educate management or clients about important issues.
	*Incident ~~Reports~~ objectively focus on presenting facts relating to an accident or irregular occurrence.		*Incident reports objectively focus on presenting facts relating to an accident or irregular occurrence.
	*Laboratory ~~Reports~~ describe experiments, tests, or inspections.		*Laboratory reports describe experiments, tests, or inspections.

	=====Formal Reports=====		=====Formal Reports=====
Line 130:		Line 130:
	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====
	A user guide is an instructional manual created to help consumers use the product, service or system. A user guide typically includes step-by-step instructions.{{Sfn\|Wainaina\|2022}}		A user guide is an instructional manual created to help consumers use the product, service or system. A user guide typically includes step-by-step instructions.{{Sfn\|Wainaina\|2022}}

Jason.ledford: /* Ethical Considerations */

2023-12-02T02:51:27Z

Ethical Considerations

← Older revision		Revision as of 22:51, 1 December 2023
Line 360:		Line 360:

	==='''Ethical Considerations''' ===		==='''Ethical Considerations''' ===
			Technical communicators:

			* Observes laws, regulations, and fulfil contracts.
			* Further the public good.
			* Respect the confidentiality of clients.
			* Produce quality products.
			* Embrace fairness with respect to cultural diversity.
			* Pursue professional self-improvement and education. <ref>[https://www.stc.org/about-stc/ethical-principles/]</ref>

	The concept of ethics involves decision making based on value systems. Value systems are based on societal norms of acceptable behavior. Ethical dilemmas are decision opportunities in which value systems do not provide clear instruction for the appropriate course of action.{{sfn\|Johnson-Sheehan\|2018\|pp=71}}		The concept of ethics involves decision making based on value systems. Value systems are based on societal norms of acceptable behavior. Ethical dilemmas are decision opportunities in which value systems do not provide clear instruction for the appropriate course of action.{{sfn\|Johnson-Sheehan\|2018\|pp=71}}

Kamyers: /* History */ edited for conciseness - this was a time years > this was years; common > standard

2023-12-02T02:50:35Z

History: edited for conciseness - this was a time years > this was years; common > standard

← Older revision		Revision as of 22:50, 1 December 2023
Line 27:		Line 27:
	Joseph D. 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 for Technical Communication (STC) in 1960.{{sfn\|Malone\|2011\|pp=285-306}} The STC is the world's oldest professional association dedicated to advancing the field of technical communication. The STC promotes adherence to a list of ethical principles. They are legality, honesty, confidentiality, quality, fairness, and professionalism.{{sfn\|Society for Technical Communication\|2023}}		Joseph D. 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 for Technical Communication (STC) in 1960.{{sfn\|Malone\|2011\|pp=285-306}} The STC is the world's oldest professional association dedicated to advancing the field of technical communication. The STC promotes adherence to a list of ethical principles. They are legality, honesty, confidentiality, quality, fairness, and professionalism.{{sfn\|Society for Technical Communication\|2023}}

	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.{{sfn\|Rathbone\|1958\|p=6}}		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 years before the computer and photocopier became standard 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.{{sfn\|Rathbone\|1958\|p=6}}

	Advances in technology thrust the technical writing profession into a new era. The technical writer's work may now include not only text but also images, drawings, and computer-based media. The modern technical writer may also be involved in research and information-gathering, speaking with subject matter experts, and selecting document media and project tools.{{sfn\|Macari\|2023}}		Advances in technology thrust the technical writing profession into a new era. The technical writer's work may now include not only text but also images, drawings, and computer-based media. The modern technical writer may also be involved in research and information-gathering, speaking with subject matter experts, and selecting document media and project tools.{{sfn\|Macari\|2023}}

Kamyers: /* Overview */ fixed citation spacing; deleted comma - subject matter experts but can also

2023-12-02T02:47:47Z

Overview: fixed citation spacing; deleted comma - subject matter experts but can also

← Older revision		Revision as of 22:47, 1 December 2023
Line 11:		Line 11:

	==='''Importance of Research'''===		==='''Importance of Research'''===
	Research plays a vital role in technical writing. The main purposes of research are to inform action, gather evidence for theories, and contribute to developing knowledge in a field of study. {{sfn\|Zarah\|2023}} Research helps build knowledge and facilitate learning, helps society understand issues and increase public awareness, and aids in supporting truth.{{sfn\|Zarah\|2023}} Proper research provides a strong foundation for efficient technical writing.		Research plays a vital role in technical writing. The main purposes of research are to inform action, gather evidence for theories, and contribute to developing knowledge in a field of study.{{sfn\|Zarah\|2023}} Research helps build knowledge and facilitate learning, helps society understand issues and increase public awareness, and aids in supporting truth.{{sfn\|Zarah\|2023}} Proper research provides a strong foundation for efficient technical writing.

	Major decisions are often based upon results from research. Technical communicators often work with subject matter experts, but can also conduct in-depth independent research to produce a technical document. The stages of critical thinking in the research process are{{sfn\|Lannon\|Gurak\|2020\|p=145}}:		Major decisions are often based upon results from research. Technical communicators often work with subject matter experts but can also conduct in-depth independent research to produce a technical document. The stages of critical thinking in the research process are{{sfn\|Lannon\|Gurak\|2020\|p=145}}:
	*Asking the right questions. The right questions help define the research problem. The answers found in research are only as good as the questions asked.		*Asking the right questions. The right questions help define the research problem. The answers found in research are only as good as the questions asked.
	*Exploring a balance of views. This provides a broad range of ''evidence''. Ask: What do informed sources say about the topic? On which points do sources agree or disagree? Which sources carry more weight than others?		*Exploring a balance of views. This provides a broad range of ''evidence''. Ask: What do informed sources say about the topic? On which points do sources agree or disagree? Which sources carry more weight than others?

Kamyers: Added comma - forms, such as; multi-modality > multimodality

2023-12-02T02:45:30Z

Added comma - forms, such as; multi-modality > multimodality

← Older revision		Revision as of 22:45, 1 December 2023
Line 2:		Line 2:
	'''Technical Writing in the Digital Age''' represents the dynamic and evolving discipline of creating written, visual, and interactive materials that convey complex information, instructions, and technical concepts in the context of contemporary digital technologies.		'''Technical Writing in the Digital Age''' represents the dynamic and evolving discipline of creating written, visual, and interactive materials that convey complex information, instructions, and technical concepts in the context of contemporary digital technologies.

	Technical writing is a specialized skill that requires technical knowledge and well-developed communication skills. It involves explaining complex information in a clear, concise, and accessible manner. Through the evolution of technologies like the Internet and smartphones, technical writing has evolved from traditional printed formats to more digital-oriented media. Today, users expect content to be available on various platforms and devices, providing up-to-date information on demand. Technical writers have adapted to these changes by creating compelling, concise, SEO-friendly content in various forms such as infographics, e-books, podcasts, videos, blogs, GIFs, memes, and other interactive content.		Technical writing is a specialized skill that requires technical knowledge and well-developed communication skills. It involves explaining complex information in a clear, concise, and accessible manner. Through the evolution of technologies like the Internet and smartphones, technical writing has evolved from traditional printed formats to more digital-oriented media. Today, users expect content to be available on various platforms and devices, providing up-to-date information on demand. Technical writers have adapted to these changes by creating compelling, concise, SEO-friendly content in various forms, such as infographics, e-books, podcasts, videos, blogs, GIFs, memes, and other interactive content.

	Key factors include integrating multimedia elements, user-centered design principles, and ethical considerations like accessibility and inclusivity. This discipline also extends to collaborative writing processes and version control systems, acknowledging the necessity of teamwork in producing accurate and up-to-date technical documentation. ~~Multi-modality~~ and the interfacing of multiple media platforms and sources also play a role in digital technical writing.		Key factors include integrating multimedia elements, user-centered design principles, and ethical considerations like accessibility and inclusivity. This discipline also extends to collaborative writing processes and version control systems, acknowledging the necessity of teamwork in producing accurate and up-to-date technical documentation. Multimodality and the interfacing of multiple media platforms and sources also play a role in digital technical writing.

	=='''Overview'''==		=='''Overview'''==

← Older revision		Revision as of 22:50, 1 December 2023
Line 27:		Line 27:
	Joseph D. 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 for Technical Communication (STC) in 1960.{{sfn\|Malone\|2011\|pp=285-306}} The STC is the world's oldest professional association dedicated to advancing the field of technical communication. The STC promotes adherence to a list of ethical principles. They are legality, honesty, confidentiality, quality, fairness, and professionalism.{{sfn\|Society for Technical Communication\|2023}}		Joseph D. 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 for Technical Communication (STC) in 1960.{{sfn\|Malone\|2011\|pp=285-306}} The STC is the world's oldest professional association dedicated to advancing the field of technical communication. The STC promotes adherence to a list of ethical principles. They are legality, honesty, confidentiality, quality, fairness, and professionalism.{{sfn\|Society for Technical Communication\|2023}}

	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.{{sfn\|Rathbone\|1958\|p=6}}		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 years before the computer and photocopier became standard 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.{{sfn\|Rathbone\|1958\|p=6}}

	Advances in technology thrust the technical writing profession into a new era. The technical writer's work may now include not only text but also images, drawings, and computer-based media. The modern technical writer may also be involved in research and information-gathering, speaking with subject matter experts, and selecting document media and project tools.{{sfn\|Macari\|2023}}		Advances in technology thrust the technical writing profession into a new era. The technical writer's work may now include not only text but also images, drawings, and computer-based media. The modern technical writer may also be involved in research and information-gathering, speaking with subject matter experts, and selecting document media and project tools.{{sfn\|Macari\|2023}}