LitWiki - User contributions [en]

Talk:Technical Writing in the Digital Age

2023-11-29T13:20:05Z

APitts: /* Images */

==Layout and Lead==
Just to get this thing going, I have created the article, developed a rudimentary layout, and added a lead written by ChatGTP. '''All of this may be kept or changed'''. I would certainly revise or rewrite the lead. Questions, ideas, discussion, and comments about the project should be posted here. I'm looking forward to seeing what you all come up with this semester. —[[User:Admin|Admin]] ([[User talk:Admin|talk]]) 09:38, 3 October 2023 (EDT)
:If no one else is going to address the lead being written by ChatGPT, I'm going to go ahead and jump in and make revisions.--[[User:Valerie Emerick|Valerie Emerick]] ([[User talk:Valerie Emerick|talk]]) 07:15, 28 November 2023 (EST)

==Citation question==
I am citing a later edition of a source that is cited elsewhere on the page. (Markel, Mike, and Selber, Stuart. (2021). Technical Communication (13th ed). This version has a second author. Should these entries be combined somehow?
:{{Reply to|Beth Kennedy}} Yes. If you’re using the updated version, update the earlier source. Great question, but don’t forget to sign your talk posts. —[[User:Admin|Admin]] ([[User talk:Admin|talk]]) 14:35, 2 November 2023 (EDT)

::{{Reply to|Admin}}Thank you. I have linked the first citation in the article (paragraph 1) to my Markel use under "Rhetorical Strategies." {{Reply to|mroma98}} and {{Reply to|RDrummond}}, in looking at the article history, it seems one of you may have added the Markel references under Ethical Considerations. I did not update those references yet because the oldest copyright date on my source is 2012, and I was also unsure of the page numbers. If you review the citation I added, and it is appropriate to reference, the shortened reference is <ref name="Markel">. Thanks. --[[User:Beth Kennedy|Beth Kennedy]] ([[User talk:Beth Kennedy|talk]]) 18:23, 13 November 2023 (EST)
:::{{Reply to|Beth Kennedy}} Thank you, Beth. I contributed to the Ethical Considerations section. My Markel source was from 2009, but the same information appears in later editions, so the 2012 reference should work, too. --[[User:Mroma98|Mike Romano]] ([[User talk:Mroma98|talk]]) 16:26, 25 November 2023 (EST)

==Shortened Footnotes==
I added the template to the project. All you need to do is add the code for your reference under Bibliography and then the SFN code under citations. I made a quick, visual [https://docs.google.com/document/d/1QGEr_RhDMKZvPqvncmDR9eoHRmOLeFkXpzp9nzFb-Sg/edit?usp=sharing step-by-step] that show you how to pull the [https://grlucas.net/grl/April%2015,%202019 template] and paste the code.--[[User:Debbiebwolfe|Debbiebwolfe]] ([[User talk:Debbiebwolfe|talk]]) 14:11, 11 November 2023 (EST)
:Nice work! Thanks [[User:Cggreen|Cggreen]] ([[User talk:Cggreen|talk]]) 09:28, 13 November 2023 (EST)

I just wanted to let everyone know that I worked on cleaning up the citations and making them all look like shortened footnotes per Dr. Lucas's direction. If there was a citation that looked like it belonged in the bibliography, I added it there. Each one of the citations links to the bibliography.--[[User:Natecole54|Natecole54]] ([[User talk:Natecole54|talk]]) 00:27, 20 November 2023
:{{reply to|Natecole54}} Nice work! I was slowly working my way through the citations to convert them to SNF format, and I am glad to see that they are all done.--[[User:Debbiebwolfe|Debbiebwolfe]] ([[User talk:Debbiebwolfe|talk]]) 08:26, 20 November 2023 (EST)
::{{reply to|Natecole54}}{{reply to|Debbiewolfe}}Thanks to both of you for taking this on! --[[User:Beth Kennedy|Beth Kennedy]] ([[User talk:Beth Kennedy|talk]]) 11:02, 20 November 2023 (EST)
:{{reply to|Debbiewolfe}}{{reply to|Beth Kennedy}}You're welcome. I will monitor this section and make sure any new additions get formatted correctly.

== References question ==

Should References be the heading, followed by Bibliography as a subheading? Would this only apply if we are using Notes, Citations, and a Bibliography?--[[User:CEToledo|CEToledo]] ([[User talk:CEToledo|talk]]) 19:14, 4 November 2023 (EDT)
: {{Reply to|CEToledo}} You can do whatever seems logical for this. Check out [[w:The Man Who Studied Yoga|The Man Who Studied Yoga]] to see a way to approach a references section. —[[User:Admin|Admin]] ([[User talk:Admin|talk]]) 07:27, 6 November 2023 (EST)

--[[User:Debbiebwolfe|Debbiebwolfe]] ([[User talk:Debbiebwolfe|talk]]) 12:50, 6 November 2023 (EST)== Shortened footnote code ==
I am having trouble understanding where the placement of the works cited and the shortened footnote code should be. I sent an inquiry email to Dr. Lucas. [[User:Debbiebwolfe|Debbiebwolfe]] ([[User talk:Debbiebwolfe|talk]]) 14:41, 5 November 2023 (EST)
:{{Reply to|Debbiebwolfe}} I would put references at the bottom, in a bibliography section. Then you can use the shortened footnotes in the body. This is an easier approach for everyone editing, as they can easily consult the bibliography to see if a reference has been used and entered. —07:30, 6 November 2023 (EST)

::{{Reply to|Debbiebwolfe}} and {{Reply to|CEToledo}} It seems we have two forms of citation happening now: the original one and the revised format that Debbie created. (Thanks Debbie and thanks for the tutorial (above), very helpful!). I think the bibliography with citations using shortened footnotes is a good approach, and my vote would be to transition to this. But it would be good to have consensus. Is everyone ok with this approach? --[[User:Beth Kennedy|Beth Kennedy]] ([[User talk:Beth Kennedy|talk]]) 19:07, 13 November 2023 (EST)

::{{Reply to |Beth Kennedy}} I vote SFN form. --[[User:Debbiebwolfe|Debbiebwolfe]] ([[User talk:Debbiebwolfe|talk]]) 05:04, 14 November 2023 (EST)

::{{Reply to |Beth Kennedy}} My vote is for the bibliography with citations using shortened footnotes. I think that will present a clean and readable format, since we are referencing similar marterial. --[[User:Kamyers|Kamyers]] ([[User talk:Kamyers|talk]]) 15:06, 14 November 2023 (EST)

Do I need to have the citation section? I see that my shortened footnotes are displaying in the reference section.--[[User:Debbiebwolfe|Debbiebwolfe]] ([[User talk:Debbiebwolfe|talk]]) 15:48, 6 November 2023 (EST)

For the User Experience section, I reference citation 23. Do I need to add the citation to each entry there since they all come from the same source or will one citation work?--[[User:Elaine Streeter|Elaine Streeter]] ([[User talk:Elaine Streeter|talk]]) 19:06, 16 November 2023 (EST)

I'm struggling with my references and citations. It currently displays an error message. I updated the section "user guides" and tried to enter in my template and this is the error message I received. What am I doing wrong? --[[User:APitts]]
:::{{Reply to|APitts}}The shortened footnotes just don't need to be enclosed with the "ref" parameters. I removed them, and it's good to go. --[[User:Beth Kennedy|Beth Kennedy]] ([[User talk:Beth Kennedy|talk]]) 12:47, 22 November 2023 (EST)

Just wanted to let everyone know to check to see if the reference you're using is already listed in the bibliography section. If it is, then just add the shortened footnote in the content. If it's not, then add the reference in the bibliography as well as the sfn in the content. Adding duplicate references in the bibliography cause errors to happen in the citations.--[[User:Natecole54|Natecole54]] ([[User talk:Natecole54|talk]]) 15:18, 27 November 2023 (EST)

== Paragraph Blocks ==

I can't believe how well and quickly this is coming along. At any rate, on to my dispute...are we adhering to any particular standard in terms of the size of paragraph blocks? Too long and it reduces the likelihood of it being read, too brief (a single sentence) and the topic/subtopic of the contribution seems too unnecessary to even mention. -- [[User:CBrown]]

:I separated the Digital Document and User Experience sections. I think paragraph blocks should have around three to four sentences max. More than that, we can create a new subheading.--[[User:Debbiebwolfe|Debbiebwolfe]] ([[User talk:Debbiebwolfe|talk]]) 06:41, 8 November 2023 (EST)

::The Ethical Considerations section seems to run together. Can it be separated into smaller sections with the primary categories as headings: "Employer," "Public," and "Environment?" --[[User:APitts]]

:::@APitts I agree that it would work better to separate into smaller sections. It would make them appear neater and more organized. -- [[User: HRoney]]

::::Can we agree then that there are no more additions to the "Ethical Considerations" section? [[User:Cggreen|Cggreen]] ([[User talk:Cggreen|talk]]) 09:50, 13 November 2023 (EST)

:::::Edits have been made to separate the Ethical Considerations portion into categories. Can someone look over my work or make any edits as you see fit? -- [[User: APitts]]

:::::{{Reply to |APitts}} I looked over your work and it looks good to me! There were a couple of grammatical errors that I edited. -- [[User: HRoney]]

::::::{{Reply to |CBrown}} I agree that a single sentence is too brief for a topic/subtopic but I don't think that means all sections like that are "too unnecessary to even mention". I think that for single sentences we need to review that area to determine if we need to add further details. --[[User:TBara]]([[User talk:TBara|talk]]) 13:53, 14 November 2023 (EST)

:::::::{{Reply to |TBara}} I am fairly certain that is the way the word "seem" works. -- [[User:CBrown]]

Added indents to keep the section readable, per [https://en.wikipedia.org/wiki/Wikipedia:Indentation wikipedia indentation] philosophy. [[User:Cggreen|Cggreen]] ([[User talk:Cggreen|talk]]) 10:48, 14 November 2023 (EST)

== Topics vs. Subtopics ==

Why are future trends and challenges separate subtopics under the future trends and challenges topic? Should there not be an overview of future trends and challenges followed by subtopics of examples of future trends and challenges, e.g. artificial intelligence. -- [[User:CBrown]]

:I am in favor of this idea/change if others agree. --[[User:Elaine Streeter|Elaine Streeter]] ([[User talk:Elaine Streeter|talk]]) 14:37, 10 November 2023 (EST)

:{{Reply to|CBrown}} The problem here is that the heading Future Trends and Challenges has room for interpretation. I think the section should just be titled Future Trends. I also think an overview of future trends could be appropriate provided information from its subheadings is not unnecessarily repeated. The material under the Challenges subheading could be relocated to another heading but I would like to hear other opinions on this proposal. —[[User:AWilliamson|AWilliamson]] ([[User talk:AWilliamson|talk]]) 20:13, 10 November 2023 (EST)
::{{Reply to |AWilliamson}} While Challenges could be a standalone heading, are we talking current or future challenges? If current, then I believe it would be best as a standalone heading. If future, then it would fit in the current format. If both, then standalone. --[[User:Mroma98|Mike Romano]] ([[User talk:Mroma98|talk]]) 20:04, 11 November 2023 (EST)

:::{{Reply to |Mroma98}} I agree with all of your points. My interpretation of the information contained within the Challenges subheading is that it refers to current challenges. I would prefer to either get input from the individual who originally contributed the content or to obtain consensus from other editors before modifying. —[[User:AWilliamson|AWilliamson]] ([[User talk:AWilliamson|talk]]) 20:47, 11 November 2023 (EST)
::::{{Reply to |AWilliamson}} OK. We're on the same page. I agree with both of your preferences. --[[User:Mroma98|Mike Romano]] ([[User talk:Mroma98|talk]]) 21:04, 11 November 2023 (EST)
::::{{Reply to |AWilliamson}} I agree that "Future Trends" and "Challenges" could be separated into two different subtopics. After reviewing the edit history, I believe Dr. Lucas is the one who created this heading, and he has indicated that any of the initial outline can be changed or removed. To me, it seems like almost everything currently in this section falls under the "Challenges" category, so that could be its own section. Then the "Future Trends" can be further developed. --[[User:Emmakd|Emma D.]] ([[User talk:Emmakd|talk]]) 15:29, 12 November 2023 (EST)

Under Ethical Considerations, I removed the second person pronouns with a more neutral one. Though the paragraph fits with the topic, writing in the second person is not standard practice for Wikipedia/Litwiki. Litwiki is the intellectual property of Dr. Gerald R. Lucas, PhD, and the rules and format of Wikipedia apply to Litwiki. --[[User:Mroma98|Mike Romano]] ([[User talk:Mroma98|talk]]) 15:07, 11 November 2023 (EST)

== Include external links section? ==

There are a few external (non-wikipedia) links in the article. Should we remove/replace the external links or create an External Links section? According to [https://en.wikipedia.org/wiki/Wikipedia:External%20links Wikipedia:External links]: "With rare exceptions, external links should not be used in the body of an article. Instead, include appropriate external links in an "External links" section at the end of the article, and in the appropriate location within an infobox, if applicable." —[[User:AWilliamson|AWilliamson]] ([[User talk:AWilliamson|talk]]) 20:50, 10 November 2023 (EST)

:{{Reply to|AWilliamson}} I think we should as this follows the Wikipedia guidelines as well as Dr. Lucas' earlier advice. --[[User:Apjones428|Apjones428]] ([[User talk:Apjones428|talk]]) 12:47, 13 November 2023 (EST)

::{{Reply to|AWilliamson |Apjones428}} I agree that external links should be placed in an External links section. However, I question if the ones currently linked are needed external links. Most of the links are to Wikipedia pages. Instead, do these need to be potential LitWiki pages and the links formatted similarly to how one would link a page internally in Wikipedia, even if those pages do not exist? If so, I think the other three external links, PowerPoint, Google Slides, and Business Insider, should follow the same format. Or should any of the current external links inside the body of the article be links at all? My understanding of External links is that they should be reserved for further topic information. -- ([[User talk:Kamyers|talk]]) 16:03, 14 November 2023 (EST)

:::{{Reply to|Kamyers}} I don't believe the links are needed for the most part. The links do not lead to much more information. --([[User talk:Kynndra Watson|talk]]) Kynndra Watson 19:14, 14 November 2023 (EST)

:::{{Reply to|Kamyers}} My thinking was that we treat LitWiki as if it is Wikipedia. So the links to Wikipedia would be considered internal if this is the case. I think what information constitutes "further topic information" is up to us as the editors and we just need to come to a consensus on the matter and then edit accordingly. —[[User:AWilliamson|AWilliamson]] ([[User talk:AWilliamson|talk]]) 22:09, 14 November 2023 (EST)

==Heading Structure==
There are inconsistencies with the subheading structure on the page. I propose we establish the heading structure as follows: Heading 1 (for section titles), Subheading 1 (H2 for subsections within the main section), and Subheading 2 (H3 for items that need to be defined). No italics in subheadings.--[[User:Debbiebwolfe|Debbiebwolfe]] ([[User talk:Debbiebwolfe|talk]]) 14:11, 11 November 2023 (EST)
:Debbie, I agree. Your suggestion makes sense, as there should be consistency throughout. --[[User:Mroma98|Mike Romano]] ([[User talk:Mroma98|talk]]) 19:58, 11 November 2023 (EST)

: {{Reply to|Debbiebwolfe}} I support your proposal. — [[User:AWilliamson|AWilliamson]] ([[User talk:AWilliamson|talk]]) 20:56, 11 November 2023 (EST)

I edited the headings and subheadings. Thanks for your input everyone--[[User:Debbiebwolfe|Debbiebwolfe]] ([[User talk:Debbiebwolfe|talk]]) 18:52, 12 November 2023 (EST)

: {{Reply to|Debbiebwolfe}} Thanks for doing this. As I was looking at some of the headings, it seems the H2 headings blend in with the text due to size similarity of the paragraphs below. I think these headings would benefit from being bold to help them stand out more. --[[User:Natecole54|Natecole54]] ([[User talk:Natecole54|talk]]) 11:40, 14 November 2023 (EST)
I went ahead and changed these H2 headings to bold for viewability purposes. --[[User:Natecole54|Natecole54]] ([[User talk:Natecole54|talk]]) 12:49, 17 November 2023 (EST)
: {{Reply to|Natecole54}} Bolding headings does nothing and should be avoided. See [[w:MOS:BOLD|MOS:BOLD]]. Thanks. —[[User:Admin|Admin]] ([[User talk:Admin|talk]]) 17:19, 17 November 2023 (EST)

== Collaboration and Version Control ==

I think this section can be added to the digital documentation section.--[[User:Debbiebwolfe|Debbiebwolfe]] ([[User talk:Debbiebwolfe|talk]]) 18:51, 12 November 2023 (EST)
:I moved version control to the digital documentation section. It was already listed there as a characteristic. I left collaboration as its own section. I'm not positive it falls under the characteristics of a digital document. I think it may be fine to leave that one on its own, but also down to do whatever the group thinks is best for it. [[User:Bryanna.kerbuski|Bryanna.kerbuski]] ([[User talk:Bryanna.kerbuski|talk]]) 17:53, 13 November 2023 (EST)

I moved the collaboration under the section for digital documentation, and I renamed the subheading "Remote Collaboration" because that is a characteristic of digital documents, but now that I've done it, I wonder if I should have just left it alone. Perhaps, I just need to edit the content under the heading. [[User:Kleinberger|Kleinberger]] ([[User talk:Kleinberger|talk]]) 06:09, 14 November 2023 (EST)

== Features of Technical Communication Section ==
When compared to the other sections of the talk page, this section seems a bit choppy. I'm thinking we can get a better intro paragraph and maybe either add longer paragraphs for each item, or combine some of the subheadings together. Any thoughts on this? --[[User:Amanda.Austin1|Amanda Austin]] ([[User talk:Amanda.Austin1|talk]]) 21:19, 12 November 2023 (EST)

I do think that longer paragraphs will make the section more thorough. Maybe sections like "clear" and "concise" could be combined? [[User: HRoney]]

:{{Reply to|HRoney}} Thank you for your feedback, I've gone ahead and combined those two sections along with adding more context to the remainder of each subheadings in the section. To all, please feel free to review and let me know of any questions or revision changes you'd think would work. [[User:Amanda.Austin1|Amanda.Austin1]] ([[User talk:Amanda.Austin1|talk]]) 14:04, 13 November 2023 (EST)

==Additional Sections==
What additional sections would we like to add to this article? I will be adding in more on multi-modality as well as more information to the SEO section of the page. Other thoughts? --[[User:Apjones428|Apjones428]] ([[User talk:Apjones428|talk]]) 12:47, 13 November 2023 (EST)

:I think adding in more on both multi-modality and SEO would be helpful. SEO is one that I am struggling with understanding. I think that it'd be nice to have more information about it on our wiki.[[User:Bryanna.kerbuski|Bryanna.kerbuski]] ([[User talk:Bryanna.kerbuski|talk]]) 17:53, 13 November 2023 (EST)

:: I agree we should add more info detailing SEO, but should we also go into more detail about the user centered design principles? We have mentioned it in a few spots but nothing really going into detail about its importance, especially in relation to SEO. I can organize my research and knock it out.[[User:Kynndra.watson]] 18:59, 14 November 2023 (EST)

::: I added the SEO section because of its importance to the user experience. Optimizing keywords and long-tail keywords should be right in a digital writer's wheelhouse. Feel free to add to this section! [[User:Cggreen|Cggreen]] ([[User talk:Cggreen|talk]]) 10:17, 17 November 2023 (EST)

== Links to other Wikipedia articles ==

In the Wikipedia: Citing Sources guidelines, under the Wikidata section, it states, "Wikidata is largely user-generated, and articles should not directly cite Wikidata as a source '''(just as it would be inappropriate to cite other Wikipedias' articles as sources)'''. Bold font is mine. Five of the eight title, name, or word links go to another Wikipedia article. One of those articles states it doesn't exist. We should consider correcting these. [[User:RDrummond|Randy M. Drummond]] ([[User talk:RDrummond|talk]]) 13:00, 13 November 2023 (EST)

:{{Reply to|RDrummond}} I think you are referring to [https://en.wikipedia.org/wiki/Wikipedia:Citing%20sources Wikipedia:Citing sources] but possibly discussing [https://en.wikipedia.org/wiki/Wikipedia:Manual%20of%20Style/Linking Wikipedia:Manual of Style/Linking]. Can you offer any clarification? —[[User:AWilliamson|AWilliamson]] ([[User talk:AWilliamson|talk]]) 22:29, 14 November 2023 (EST)

@AWilliamson: I couldn’t find it specifically in the Style/Linking section, it even talks about linking to sister articles, but the Citing Sources has what I quoted. The article I used in Wiki Assignment 4, Wiki NPOV, the writer cited numerous statements and studies but linked them to Wiki pages about the government agency or corporation that said nothing about what he was putting in his article. That made me start to check links to other Wiki articles. [[User:RDrummond|Randy M. Drummond]] ([[User talk:RDrummond|talk]]) 09:07, 17 November 2023 (EST)

== Article Organization ==

I've been taking a look at the overall structure of the article, and I wonder if we might consider revising the organization. It just seems like there's a bit too much back and forth between Technical Writing topics and Digital Writing topics. Also, I wonder if the Historical Context should come before the Features section. Something about the overall structure just feels "off" to me. [[User:Kleinberger|Kleinberger]] ([[User talk:Kleinberger|talk]]) 06:23, 14 November 2023 (EST)

:{{reply to|Kleinberger}}I think the organization could be fine-tuned so it flows naturally. I agree the Historical Context should come before the features section. If we were to mimic the Technical Writing Wiki page, it has the overview and then history. Since there are technical writing topics and digital writing topics, we could add more context in the digital technologies and technical writing section that could merge these two concepts together to transition into topics on digital writing. The article should transition from what Technical Writing was to what it is now in the Digital Age. [[User:Jasteverson|Jasteverson]] ([[User talk:Jasteverson|talk]]) 18:40, 14 November 2023 (EST)

::{{Reply to|Kleinberger}}::{{Reply to|Jasteverson}} I added a section "Outline for Article Organization" at the end of the discussion page with some ideas on an updated outline if you'd like to review. Thank you! --[[User:Amanda.Austin1|Amanda.Austin1]] ([[User talk:Amanda.Austin1|talk]]) 22:17, 25 November 2023 (EST)

== Making it Flow ==

I agree with several of the other posts about overall organization and the flow of the article. I feel the article itself is good and has a lot of great content, I am just not sure about how it is currently laid out. For example, the intro is an "Overview of Technical Communication." In that section are types, aims and characteristics of technical communication. However, the next section is "Features of Technical Communication." All of these are related and should be included in one section if they all focus on various aspects of technical communication. There also seems to be a random order of the headings. The last heading on future trends is good, but right above that is pedagogical approaches. I think that should be earlier in the article. Also, there is a heading for examples of digital documents under a heading on digital documents which includes lots of subheadings. Again, I think content is great. I just think we could clean it up a bit.

Should We combine the personas section with the User Center Design/User Experience section?--[[User:Elaine Streeter|Elaine Streeter]] ([[User talk:Elaine Streeter|talk]]) 18:54, 24 November 2023 (EST)

::{{Reply to|Elaine Streeter}} I added a section "Outline for Article Organization" at the end of the discussion page with some ideas on an updated outline if you'd like to review. Thank you!--[[User:Amanda.Austin1|Amanda.Austin1]] ([[User talk:Amanda.Austin1|talk]]) 22:16, 25 November 2023 (EST)

==Expansion Needed==

While reviewing the article, there are specific sections without enough detail that need to be expanded. These three sections are Overview-Types of Technical Communication, Ethical Considerations-The Public, and Future Trends and Challenges-Future Trends. Also is it okay to have a single subsection under Appropriateness? Do we need or have planned to have additional subsections or should we eliminate the subheading "Audience-specific"?--[[User:TBara]]([[User talk:TBara|talk]]) 14:14, 14 November 2023 (EST)

== Technical Documents ==

I broke out the Technical Documents subsection and made it its own category. The Wikipedia article on [https://en.wikipedia.org/wiki/Technical_writing technical writing] lists out the types of technical documents. I think it's a great way to expand on the piece. Feel free to add definitions or more subcategories. --[[User:Debbiebwolfe|Debbiebwolfe]] ([[User talk:Debbiebwolfe|talk]]) 10:06, 20 November 2023 (EST)

:{{Reply to|Debbiebwolfe}}Thank you for adding this list. I'm working on the definitions too. I also added an entry for Documentation and moved "Instructions and Procedures" under it so all forms of documentation are under one entry. I think this makes sense, but see what you think. --[[User:Beth Kennedy|Beth Kennedy]] ([[User talk:Beth Kennedy|talk]]) 15:09, 20 November 2023 (EST)

:{{Reply to|Beth Kennedy}} I think it makes perfect sense! I just threw categories in to get it started and have already changed them around as I research. I am thinking of adding a separate "tools" section to mimic what is on the Wikipedia entry. Thoughts?

::{{Reply to|Debbiebwolfe}}I think adding "tools" is a good idea, but I wonder if it would be good to have them under the current "Digital Technologies and Technical Writing" section? The list would help to expand this section and would reinforce the digital connection. Just a thought.--[[User:Beth Kennedy|Beth Kennedy]] ([[User talk:Beth Kennedy|talk]]) 10:04, 21 November 2023 (EST)

::{{Reply to|Debbiebwolfe}}:{{Reply to|Beth Kennedy}} I added a section "Outline for Article Organization" at the end of the discussion page with some ideas on an updated outline if you'd like to review. Thank you! --[[User:Amanda.Austin1|Amanda.Austin1]] ([[User talk:Amanda.Austin1|talk]]) 22:14, 25 November 2023 (EST)

== Digital Technologies and Technical Writing ==

I reformatted this section to flesh it out. I renamed it "Digital Technologies Tools" to capture tools commonly used by technical writers as seen on Wikipedia's [https://en.wikipedia.org/wiki/Technical_writing Technical Writing] entry. I added a few categories to get it started. Feel free to edit and add more categories as needed.--[[User:Debbiebwolfe|Debbiebwolfe]] ([[User talk:Debbiebwolfe|talk]]) 08:05, 24 November 2023 (EST)

:{{Reply to|Debbiebwolfe}} I added in information to the Image Processing Software and Text Editor sections. I'm hoping that was the route you were wanting to go with in those sections. I also read over the rest of the Digital Technologies Tools sections and fixed some things, like capitalization and some rewriting for clarity and some more neutral tones. Please let me know if I need to make any changes to my additions, thank you! --[[User:Amanda.Austin1|Amanda.Austin1]] ([[User talk:Amanda.Austin1|talk]]) 21:31, 25 November 2023 (EST)

==User Experience==

Everything is looking great! Wanted to give everyone a heads up that I am currently working on expanding the user experience section and will be adding Information Architecture, Responsiveness, and Usability to it. I should be adding those up over the next few days. Let me know if you see anywhere else here that needs to be expounded on. Thanks! --[[User:Kamyers|Kamyers]] ([[User talk:Kamyers|talk]]) 09:43, 24 November 2023 (EST)

== Outline for Article Organization ==

Hi, everyone. I've been thinking of how the article is outlined, and this may be a good idea to start with.
There are also some notes I've made included in the outline:

1. Overview
2. Historical Context
3. Features of Technical Communication
4. Personas in Digital Writing
5. Rhetorical Strategies in the Digital Age
6. Digital Technologies Tools
7. Search Engine Optimization (SEO)
8. Technical Documents
(This section seems overwhelming. Could we combine sections to create longer paragraphs?)
9. Digital Documentation
(There is a long list of sections here that have short sentences. Could some of the sections be combined to create paragraphs? We could have the Technical Documents and Digital Documentation mirror each other in how they're formatted.)
10. Examples of Digital Documents
(Could this become a section in the Digital Documentation section above?)
11. User Experience
(I believe someone is editing this section?)
12. Ethical Considerations
13. Pedagogical Approaches
14. Future Trends and Challenges
15. References

Once we agree on the article's flow, we can edit each section with the same style ideals. Thoughts or recommendations?

:{{Reply to|Amanda.Austin1}} I am currently working on User Experience. {{Reply to|Elaine Streeter}} mentioned adding the personas into this section. I think it could be possibly added to User Research, but I might find a better place for it in UX. I'm not sure it needs it's own section, but I could be overruled. Let me know, and I'll get it added in. For the smaller short sentence sections in Digital Documentation, I agree that these could be combined. I also think Examples of Digital Documents could go into Digital Documents. --[[User:Kamyers|Kamyers]] ([[User talk:Kamyers|talk]]) 10:49, 26 November 2023 (EST)

:{{Reply to|Amanda.Austin1}} I support your organization proposal. RE: the long list of definitions and short sentences. I don't mind that format because it mirrors what's on Wikipedia, Dr. Lucas' text, and how the information is presented in the technical communication texts. It aids in keeping the info scannable. But I do agree to keep the Technical Documents and Digital Documentation sections similar in format.--[[User:Debbiebwolfe|Debbiebwolfe]] ([[User talk:Debbiebwolfe|talk]]) 10:36, 27 November 2023 (EST)
::{{Reply to|Amanda.Austin1}}I was about to reply to this when I saw you have already reorganized, which is great. I particularly think it was important to move "Historical Context" up.--[[User:Beth Kennedy|Beth Kennedy]] ([[User talk:Beth Kennedy|talk]]) 16:23, 27 November 2023 (EST)

:{{Reply to|Kamyers}} :{{Reply to|Debbiebwolfe}} Hi everyone, I went ahead and rearranged the outline for better flow. I also left the Digital Documentation section like you recommended Debbie. I think now that the layout is good, we can go in and copy edit the article for any errors or clarity. --[[User:Amanda.Austin1|Amanda.Austin1]] ([[User talk:Amanda.Austin1|talk]]) 16:12, 27 November 2023 (EST)

I have also been thinking about the article's organization. I think a lot of the sections can be combined so it's not so overwhelming. Below is my proposal, which would condense everything into 6 major sections instead of 13. I have not removed anything at all, merely restructured in a way that makes more sense (to me at least). I am happy to reformat this way and preserve everyone's text, but would love some feedback before making a major change. [[User:Emmakd|Emmakd]] Emma D. 17:41, 28 November 2023 (EST)
:{{Reply to|Emmakd}} I don't mind the structure being condensed into 6 sections instead of 13. Just be mindful of the citation template code in the body that supports the shortened footnote code. --[[User:Debbiebwolfe|Debbiebwolfe]] ([[User talk:Debbiebwolfe|talk]]) 05:48, 29 November 2023 (EST)

*Overview
**Goal of Technical Communication
**Characteristics of Technical Communication
*History
**Technical Writing Profession
**Future Trends
*Technical Communication Strategies
**Characteristics of Technical Communication
***Standards Compliant
***Detail Oriented
***Objective
***Clear and Concise
***Formatted and Organized
***Graphical
***Audience Specific
***Document Design
**Examples of Technical Documents
***Case Studies
***Data Sheets
***Descriptions
***Documentation
***Email
***Letters
***Memos
***Press Releases
***Proposals
***Reports
****Informal or Brief Reports
****Formal Reports
***Resumes
***User Guides
*Digital Writing Strategies
**Characteristics of Digital Documents
***Electronic Format
***Non-Tangible
***Accessibility
***Readability
***Scannability
***Ease of Reproduction and Distribution
***Hyperlinking
***Multimedia
***Version Control
***Remote Collaboration
***Security Measures
***Environmental Impact
***Dynamic Updates
***Global Accessibility
***Data Integration
***Data Analytics
**Examples of Digital Documents
***Infographics
***Presentations
***Blogs
**Personas in Digital Writing
**Rhetoric
**Search Engine Optimization (SEO)
***Keywords
***Alt Text
***Social Media Presence
***Goals of Searching: User Perspective
**Digital Tools
***Content Management Systems (CMS)
***Image Processing Software
***Word Processors
***Text Editors
**User Experience
***User-Centered Design
***Information Architecture
***Responsive Design
***Usability
*Pedagogical Approaches
**Writing Styles
**Multimedia Writing
**Breaking and Building
*Challenges and Ethical Considerations
**Challenges
**Artificial Intelligence
**Plagiarism
**Ethical Considerations
***The Employer
***The Public
***The Environment
***Disinformation
*References

== Late to the party ==

First of all - I want to apologize to the whole class for not jumping in sooner, but this has been a rough semester. Secondly, please let me know where I can help. I will be adding my section or building on one of the others this week, and I see a couple of sections that can be edited for conciseness and tightened up a bit. My life is still a bit of a trainwreck since my mother's death - but I'm happy to help where needed.--[[User:Valerie Emerick|Valerie Emerick]] ([[User talk:Valerie Emerick|talk]]) 21:23, 26 November 2023 (EST)

I am also late to party, Valerie. I am happy to help out wherever, but I was thinking about expanding the UDC section to include IA and maybe reach into remediation in the Digital Documents section. Also happy to proofread wherever. --[[User:Ebyington3|Ebyington3]] ([[User talk:Ebyington3|talk]]) 21:21, 28 November 2023 (EST)

== Citations in lead section ==

Please ignore. I know now. Thanks. @Natecole54 You removed a citation yesterday evening from the lead section stating citations should only be in the body of the article. I don't remember reading that. I was trying to add citations because the lead was generated with ChatGPT and has no citations. Where can I find that?

== Images ==

Hey everyone! I was looking over the page and realized that the article is very long with no pictures or examples. If it pleases the group, I can go through and add pictorial examples from our textbooks and readings to go along with what we are talking about in certain sections and then add the ref to it? [[User:Ebyington3|Ebyington3]] ([[User talk:Ebyington3|talk]]) 06:42, 29 November 2023 (EST)

:{{Reply to|Ebyington3}} That is a wonderful idea. --[[User:APitts]]

Talk:Technical Writing in the Digital Age

2023-11-29T13:19:40Z

APitts: /* Images */ Replying to inquiry about adding images

Technical Writing in the Digital Age

2023-11-28T21:49:48Z

APitts: /* Scannability */ citations needed

'''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 in a manner that is easily understood by its audience. Its purview encompasses the creation, dissemination, and management of technical documents and content within an expansive digital landscape. Connected networks of workstations, laptops, cell phones, tablets, and servers are the central nervous system in the technical workplace.

Major considerations revolve around adapting traditional principles of rhetoric to digital platforms, ensuring effective communication in an era of rapid technological advancements. 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. In essence, technical writing in the digital age encapsulates the art and science of conveying technical information in a manner that is comprehensible and accessible to diverse audiences in our digitally driven society.

==Overview==

=== Goal of Technical Communication ===
Technical communication is a discipline utilized by various fields like education, business, and science. In any domain, technical documentation shares a common objective: assisting the audience in achieving a task or goal.{{sfn|Markel|Selber|2019}} This common objective is achieved by the technical writer developing the ability to communicate complex and technical information more easily to the audience.{{sfn|United States Bureau of Labor Statistics|2023}}

=== 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.

==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 for 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.{{Citation needed}}

Advances in technology thrust the technical writing profession into a new era. The technical writer's work 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 subject matter 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}}

==Features of Technical Communication==
Technical communication involves conveying complex information to a specific audience. Key features include accuracy, attention to detail, visuals, and clear and concise organization to enhance user understanding.{{sfn|Smirti|2022}}

=== Accuracy ===

==== Standards Compliant ====
Many technical fields have industry-specific regulations and guidelines which are determined by governing bodies, and also impact their technical communication. Furthermore, many organizations may have a style guide that outlines preferred language usage, tone, and formatting.{{sfn|Smirti|2022}}

==== Detail-Oriented ====
Technical communication should be detail-oriented and free of errors and inconsistencies. Accurate information that is delivered with precision and specificity is essential to providing communication that is unambiguous and free of discrepancies.{{sfn|Smirti|2022}}

==== Objective ====
Objective communication is presented in an unbiased and impartial manner and is free of personal opinions. It relies upon facts and evidence and avoids an overly emotional tone. This approach is particularly important in fields where accuracy and impartiality are essential.{{sfn|Detwiler|2021}}

===== Clear and Concise =====
Technical communication should be logically organized, straightforward, and easily understood by the target audience. The language used should avoid needless jargon and be written in a manner that avoids redundant word usage and/or excessive explanations.{{sfn|Smirti|2022}}{{sfn|Proofed Editors|2020}}

=== Soundness ===

==== Formatted and Organized ====
Technical documents should be formatted in a way that is consistent with the norms and standards of applicable professional fields. Additionally, formatting should adhere to guidelines that enhance usability. Information should be logically organized for easy reading comprehension. This may involve using headings, subheadings, bullet points, and numbered lists. Formatting details should remain consistent throughout the document.{{sfn|Smirti|2022}}{{sfn|Proofed Editors|2020}}

==== Graphical ====
Technical communication utilizes visuals strategically to facilitate understanding of textual content. Visuals such as diagrams, charts, graphs, or images can enhance understanding of a technical document. When presented properly, visuals can explain difficult concepts and make material accessible to a more diverse audience.{{sfn|AI and the LinkedIn Community|2023}}

=== Appropriateness ===

==== Audience-specific ====
Where possible, technical communication should be customized to align with the knowledge and needs of its audience. Communication style and tone should be tailored to match the audience's level of expertise and should take into consideration such factors as the users' technical background, familiarity with the subject, and specific requirements.{{sfn|Viral Nation|2019}} The tone sets the overall mood for the piece.

====Document Design====
Documents' appropriateness requires that readers can quickly understand the message of the document. The document should be of appropriate style and length for the readers' needs.

==Personas in Digital Writing==
Personas in the context of digital writing, which is writing composed, created and read in digital environments, refer to semi-fictional characters that encapsulate the characteristics, behaviors, and needs of target audience segments. They align closely with the principles of user-centered design (UCD).{{sfn|Lucas|2023a}} There are myriad ways to integrate user-centered thinking into the creative process of UX design, and personas are one of the most effective ways to empathize with and analyze users.{{sfn|Goltz|2014}}

Personas may guide the creation of documentation and tutorials catering to different user needs. It is crucial to adjust the language and tone to match the persona preference. Different personas can influence and guide the design of the project.

Along with adjusting tone and language to suite the desired user, personas also have the responsibility to ensure the purposed digital document properly informs the reader with correct and accurate information the user seeks.

==Rhetorical Strategies in the Digital Age==
[https://en.wikipedia.org/wiki/Rhetoric Rhetoric] is a communication strategy whose primary goal is to persuade an audience. It is grounded in three foundational concepts first defined by the Greek philosopher Aristotle. These concepts are ''logos'', which engages with the reader’s sense of logic or reason; ''pathos'', which appeals to the reader’s emotions; and ''ethos'', which addresses the audience’s values and the writer’s credibility. Within this framework, writers utilize specific techniques or devices to influence and engage readers. Examples include appealing to an audience’s sense of logic by using factual examples to support a point or evoking emotion through descriptive visual language.{{sfn|Gagich|Zickel|n.d.|pp=34-37}}

In today’s digital age, writers can use digital technologies as rhetorical devices to influence the reader. Electronic images and informational graphics can be incorporated into digital and online documents to illustrate or reinforce points made in the text.{{sfn|Markel|Selber|2019}} [[#Hyperlinking|Hyperlinks]] can provide access to additional information that supports authors’ ideas and enhances their credibility.{{sfn|Lucas|2023g|}} Nevertheless, the writer's basic task of informing and persuading an audience is the same in digital communication as in other forms of writing.{{sfn|DeVoss|National Writing Project|Eidman-Aadahl|Hicks|2010|p=105}}

Digital writers must therefore consider specific elements that compose the rhetorical context in which texts are created and delivered. Such elements may include evaluating the demographics, habits, and needs of an intended audience; determining the overall objective of the communications; and deciding what technologies will be used to create the content. Together, this analysis allows writers to craft messages that both appeal to and inform the target audience. In the digital age, such rhetorical messages may be conveyed through websites, social media, and other digital platforms.{{sfn|Lawrence|2022|pp=6-14}}

==Digital Technologies Tools==
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}}

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

=== Content Management Systems (CMS) ===
A content management system (CMS) is a software application that allows users to create, manage, and modify digital content on a website. It provides a user-friendly interface and tools to easily organize, publish, and update content, including text, images, videos, and documents. Additionally, CMSs often offer features like user permissions, version control, and Search Engine Optimization (SEO) to enhance the overall website management experience.{{sfn|Carroll|2006|p=129}} Some popular examples of CMS include [https://wordpress.com/ WordPress], [https://www.wix.com/ Wix], and [https://www.blogger.com/about/?bpli=1 Blogger].

=== Image Processing Software ===
Image processing software plays a valuable role in technical and digital writing by facilitating the creation and enhancement of visuals. Documentation and tutorials help optimize images to convey processes or procedures effectively. Whether for screen captures illustrating software interfaces, data visualizations, or graphics for digital content, image processing tools contribute to creating clear and visually appealing materials.{{sfn|Robbins|2018|p=664}} These tools, such as [https://www.adobe.com/ Adobe] and [https://www.canva.com/ Canva], enhance the visual impact of technical and digital writing, ensuring that images are optimized, informative, and engaging for the audience.

=== Word Processors ===
Word processors are software applications designed for creating, editing, and formatting documents on a computer. They provide many features, such as spell-checking, grammar-checking, and inserting images and tables. These programs are typically used for writing essays, creating reports, or drafting professional documents.{{sfn|Carroll|2010|p=229}} Some popular software applications are [https://www.microsoft.com/en-us/microsoft-365/word Microsoft Word], [https://www.google.com/docs/about/ Google Docs][https://www.microsoft.com/en-us/microsoft-365/sharepoint/collaboration , SharePoint], and [https://www.apple.com/pages/ Apple Pages]. These programs allow documents to be readily disseminated. Comment capability enables audience members to interact about a document with one another and the author.

=== 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.

== 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}}

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

=== Case Studies ===
Case studies are a form of empirical or observational research that consists of in-depth examination of distinct individuals, groups, events, or scenarios. This research can be used to generate qualitative or quantitative data.{{sfn|Johnson-Sheehan|2018|pp=401-404}}

=== Data Sheets ===
A data sheet, also known as a technical datasheet, is a document used to describe and summarize the characteristics of a product, material, component, or technology.{{sfn|IDA|2020|p=}}

=== 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}}

*Product: provides detailed information about a specific item, including its features, specifications, and benefits.
*Process: provides step-by-step instructions on how to perform a particular task or achieve a specific outcome.

=== Documentation ===
Documentation comprises various texts that allow users to accomplish tasks or gain information. It generally falls into three categories, which can be defined as follows:
* Instructions: Text that describes how to complete a task, often offering numbered steps. Examples include how to download software or assemble a product.{{sfn|Balzotti|2022|p=167}}
* Specifications: Communications that deliver technical details on how a product is put together or a specific operation is executed. Also known as "specs," these texts may be written by engineers or technicians.{{sfn|Johnson-Sheehan|2018|p=205}}
* Procedures and Protocols: Guidelines to ensure consistency, quality, and safety in the workplace. For example, a hospital may provide staff with procedures on how to adapt operations during an emergency, such as a power outage.{{sfn|Johnson-Sheehan|2018|p=205}}

=== Email ===
Emails are the primary form of communication in the workplace, used for both internal and external communication. They facilitate information exchange, idea exchange, and activity coordination.{{sfn|Lannon|Gurak|2020|p=335}} Emails should be brief, concise, readable, and targeted to specific audiences with specific subject lines.{{sfn|Lannon|Gurak|2020|p=348}}

=== Letters ===
Letters are a traditional form of communication most often used by employees to communicate with individuals outside of a company or organization. They are typically written on company letterhead. Today, letters are sent either by U.S. mail or electronically.{{sfn|Johnson-Sheehan|2018|p=139}}

=== Memos ===
A memo (short for memorandum) is an official communication, usually a message from the company, a manager or director, or another person or group acting in an official capacity, used to communicate with others within the same organization.{{sfn|Lannon|Gurak|2020|p=353}}

=== 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}}

=== Proposals ===
A proposal is a document that identifies an existing problem or opportunity and outlines a comprehensive strategy for addressing it. Organizations create ''internal'' proposals to describe programs and projects that meet specific operational needs, such as a plan to replace an outdated software system. Companies develop ''external'' proposals for potential customers or clients. These documents detail new products, services, or initiatives that a company will implement to address a specific customer concern.{{sfn|Johnson-Sheehan|2018|p=245}}

=== Reports ===
A report is a concise, easily understandable document that presents technical information in a clear, organized format, allowing readers to access varying levels of information. Reports are categorized as informal, such as briefs, and formal, such as research, scientific, and completion reports.{{sfn|Johnson-Sheehan|2018|loc=chpt 10 & 11}}

==== Informal or Brief Reports ====
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.
* 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.
* Laboratory Reports describe experiments, tests, or inspections.

==== Formal Reports ====
A formal report is a factual and data-driven response to a research question.
* Research reports present the findings of a study.
* Scientific research reports outline the process, progress, and results of technical or scientific research or the current state of a research problem.
* Completion reports assess the outcomes of a project or initiative and provide feedback to management or the client.

=== 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.

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}}

=== 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}}

==Search Engine Optimization (SEO)==
SEO refers to the practice of optimizing online content to enhance its visibility and ranking on search engine results pages (SERPs), making it a crucial skill for digital writers.{{sfn|Lucas|2023b}} To optimize content for SEO means to have the goal of SEO in mind at the time of designing, creating, and writing a web page for publication. Using keywords and alt-text are two examples of optimizing content for SEO.{{sfn|Barr|2010|loc=chpt. 17}}

===Keywords===
Keywords are the words that search engines crawl a website for and index as the page's most important words. Based on other pages using the same keywords, the website is added into the search engine results pages from best matches to worst matches. The position of a website in search results is influenced by where it ranks on a scale determined by the keywords that a user searches for.{{sfn|Lucas|2023b}} To optimize a website's keywords, you should begin with researching keywords on your own website and ensure that you have an XML [https://en.wikipedia.org/wiki/Sitemaps sitemap] so search engines such as [https://en.wikipedia.org/wiki/Google Google] can crawl your web pages for updated information. In addition to using keywords, updating a page's metadata information can also help with showing up on SERPs. Using title and header tags as well as meta descriptions for content also helps optimize a website's ratings in SERPs.{{sfn|Lucas|2023b}}

===Alt-Text===
Alt-Text (alternative text), or [https://en.wikipedia.org/wiki/Alt_attribute Alt Attributes], is a practice that increases the usability and accessibility of a web page for users. Alt-Text is often used for visual elements that cannot be displayed in a different format but still provides description of the element for screen readers or users that may have a disability. Alt-Text also improves a website's SEO as a form of content optimization.{{sfn|Lucas|2023b}}

===Social Media Presence===
Sharing content from a website across different social media platforms is another way to create SEO optimization. This technique can help with being seen as legitimate and improves visibility of the website overall. Additionally, it can drive traffic and enables back-linking to occur when other websites have the ability to also link to the website.{{sfn|Lucas|2023b}}

=== Goals of Searching: The User's Perspective===
A user of search engines formulates queries by using keywords or posing questions. One of the most important elements of building an SEO strategy for a website is developing a thorough understanding of the psychology of your target audience and how they use words and concepts to obtain information about the services and/or products you provide. Once you understand how the average search engine user—and, more specifically, your target audience—utilizes query-based search engines, you can more effectively reach and keep those users.{{sfn|Enge|Spencer|Stricchiola|2022|p=9}}

==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}}

===Characteristics of Digital Documents===

====Electronic Format ====
Digital documents exist in electronic formats, which means they are stored and transmitted as binary data. This format allows for efficient storage, retrieval, and transmission of information via electronic devices.{{sfn|Lucas|2023c}} Digital documentation is the only method to meet a critical challenge of the relatively new concept of "knowledge management" that applies to all organizations. A digital knowledge management system is crucial to an organization so everyone can access information created by employees who are no longer with the organization or to allow cross-referencing with other seemingly unrelated departments.{{sfn|IBM}}

====Non-Tangible====
Unlike paper documents, digital documents lack physical presence. They are intangible and exist as electronic files, residing on devices or in the cloud.{{sfn|Lucas|2023c}}

====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}} It is a legal requirement to include accessibility features in website design.{{sfn|WCAG|2023}} It is also ethically imperative to make sure there is accessibility in digital writing. 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}} Accessibility broadens the reach of digital content and reaches a wider audience. This is important for technical writers, as their documentation and instructions are critical resources for users of varied abilities.{{Citation needed}}

====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|Burnett|Benson|1999|p=207}} The other four Cs are coherent, concrete, correct and complete.{{sfn|Last|2019}}

====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 implementing visual elements, white space, concise language, highlighting, and emphasis.{{Citation needed}}

====Ease of Reproduction and Distribution====
Digital documents are easily copied and distributed. They can be duplicated without any loss of quality, making it simple to share information widely and at minimal cost.{{sfn|Lucas|2023c}}

====Hyperlinking ====
Hyperlinking is a quick and efficient method for directing readers to relevant information in digital documents, facilitating seamless navigation between sections, references, and external resources.{{sfn|Carroll|2010|p=79}}

====Multimedia====
Digital documents can incorporate multimedia elements like images, audio, video, and interactive content, enhancing engagement through visual and auditory elements. Multiple media formats work best when sharing new, complicated ideas.{{sfn|Carroll|2010|p=36}} Increasing multimodality on a website improves engagement, usability, and accessibility. This can improve the impact of the website's standings in SERPs.{{sfn|Carroll|2010|p=280}}

====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}}

====Remote Collaboration====
One form of collaborative technical writing is a wiki, which is a "website developed collaboratively by a community of users, allowing any user to add and edit content."{{sfn|Lucas|2021}} One of the predominant elements of a wiki is that it is defined as being open source. As a result, anyone can modify it regardless of their geographic locations.

====Security Measures====
Digital documents can be protected with encryption, passwords, and access controls to safeguard sensitive information. These security measures enhance data protection and privacy.{{sfn|Lucas|2023c}}

====Environmental Impact====
Digital documents have a smaller environmental footprint compared to paper documents, as they reduce the need for paper production, printing, and transportation.{{sfn|Lucas|2023c}}

====Dynamic Updates====
Online digital documents can be updated dynamically, ensuring that users always have access to the most current information. This is particularly valuable in fast-changing fields.{{sfn|Lucas|2023c}}

====Global Accessibility====
Digital documents can be shared globally, transcending geographical boundaries and time zones. They support international collaboration and the dissemination of knowledge on a global scale.{{sfn|Lucas|2023c}}

====Data Integration====
In business and research settings, digital documents can integrate with databases and data analysis tools. This integration streamlines data collection, analysis, and reporting processes.{{sfn|Lucas|2023c}}

====Data Analytics ====
Digital documents can be subjected to data analytics techniques, allowing organizations to extract valuable insights from large volumes of textual data, which can inform decision-making and strategy.{{sfn|Lucas|2023c}}

==Examples of Digital Documents==
In technical and professional writing, digital documentation takes various forms. These methods streamline the sharing of technical information, enhance collaboration, and ensure easy accessibility within professional settings, contributing to efficient communication and knowledge dissemination.{{Citation needed}}

=== Infographics ===
Infographics, shared as digital documents, typically combine text, graphics, and illustrations to convey complex concepts or data in a concise and visually appealing format. Infographics are often used to simplify information, making it more accessible to a broader audience, and are found in presentations, reports, websites, and educational materials.{{sfn|Lannon|Gurak|2020|pp=292-293}}

=== Presentations ===
Presentations created with [https://en.wikipedia.org/wiki/Microsoft_PowerPoint PowerPoint] or [https://en.wikipedia.org/wiki/Google_Slides Google Slides] are vital for professional communication and knowledge sharing. They condense complex information into visually appealing slides for effective presentations by using photos, videos, graphics, charts, and graphs.{{sfn|Parkinson|2018|loc=chpt. 4}}

=== Blogs ===
A blog, short for "weblog," is an informational website organized into short articles called posts, typically chronologically ordered series of website updates, written and organized similar to a traditional diary.{{sfn|Bair|2014|p=7}} They are regularly updated, providing readers with insights on a specific topic or subject. Blogs serve various purposes, including sharing opinions, providing news, offering educational content, and documenting personal experiences.{{sfn|Rose|Garret|2012|p=2}}

==User Experience==
User experience (UX) is how a product works from the perspective of the user. Digital documents can be created with efficient user experiences by practicing several design methods, including user-centered design, information architecture, responsive design, and usability.{{Citation needed}}

===User-Centered Design===
The approach of user-centered design (UCD) in technical writing consists of the following methodology{{sfn|Lucas|2023e}}:

* User Research: the act of conducting thorough research through surveys, interviews, and usability testing to gain a better understanding of user needs and experiences when using a digital document
* Ideation and prototyping: the process of creating digital designs and prototypes to assist with exploring possible solutions to meet user needs
* Usability testing: the act of having users interact with digital document designs and recording and adjusting the design based on user feedback
* Implementation: the stage in which the design is implemented after making adjustments from prior testing
* Evaluation: the stage in which the digital document is assessed to ensure that it is meeting user needs
* Maintenance and updates: to maintain a digital document based on user feedback and changing needs

===Information Architecture===

To ensure a digital document has effective UX design and accessible information, technical writers need to construct a clear and organized information architecture (IA). IA is a design principle that organizes information so that it is easily found and understood by users, prioritizing their needs and reducing information overload. A design challenge is making IA understood across multiple digital experiences, changing the navigation structure to fit different medias while staying logical and consistent for the user.{{sfn|Rosenfeld|pp=1, 17-18}} IA that is not constructed well can confuse the user and could cause them to give up their search of information in frustration.{{sfn|Garrand|pp=12}}

The architecture components of IA can be divided into four different categories:{{sfn|Rosenfeld|pp=90}}

*Organization systems: how information is categorized and organized for user understanding

*Labeling systems: how information is represented

*Navigation systems: how users browse information and navigate between pages

*Searching systems: how users search for specific information

=== Responsive Design ===

Responsive design is a strategy that appropriately updates the layout and content of a website or document in relation to the screen size, device, and/or orientation, allowing the site or document to be easily viewed and navigated regardless of device used. With the increased use of mobile devices, web content should be constructed with proper responsive web design (RWD) to ensure effective UX and usability on those devices.{{sfn|Robbins| pp=485}}

There are several design strategies that can be implemented that will increase the success of RWD:{{sfn|Robbins| pp=487}}

*Fluid layout – Responsive sites can be constructed using a fluid layout (or flexible grid) system that will allow content to adjust and flow according to the available screen space.

*Flexible and responsive images – Images and other embedded media can be instructed so that they fit their containers instead of remaining at a fixed size. Images with varying resolutions can also be swapped according to screen size to avoid high-resolution images on smaller devices.

*CSS media queries – Media queries can be written into the CSS (Cascading Style Sheet), which would instruct the construction of the site according to screen width and orientation. Adding breakpoints for several screen sizes allows pages to be designed for specific devices.

*Content hierarchy – Carefully constructing content that is organized for the user and creating a hierarchy of content that prioritizes user needs is necessary to ensure effective user experience and navigation across multiple screen sizes.{{sfn|Robbins| pp=499}}

===Usability===

Technical writers must create documents and websites that meet the expectations of their readers and users, and in doing so, writers increase the usability of their site or document.{{sfn|Garrand|pp=26}} Usability can be applied with visual aids, clear and concise language, and structured design.

==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|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|Society for Technical Communication|2023a}} The STC promotes adherence to a list of ethical principles. They are legality, honesty, confidentiality, quality, fairness, and professionalism.{{sfn|Society for Technical Communication|2023b}}

Technical communicators also have to be careful to avoid plagiarism, or taking ideas, thoughts, or words from someone else and passing them off as one's own.{{sfn|Carroll|2010|p=280}}

Technical communicators have ethical standards to which they must abide. The standards are divided into three primary categories. They are the employer, the public, and the environment.{{sfn|Markel|2009}}

===The Employer===
Obligations to one's employer include competence and diligence, honesty and candor, confidentiality, and loyalty.{{sfn|Markel|2009}} The technical communicator must adhere to these obligations so that he/she does not harm the reputation or operation of the employer.

Technical communicators may occasionally work for an organization with strict privacy policies that prohibit them from using the documents they create outside of the organization. It is important for ethical communicators to follow the privacy policy for their organization because unauthorized release of information could lead to consequences up to and including termination.{{sfn|Balzotti|2022|p=83}}

=== The Public===
Organizations are obligated to treat customers fairly. Technical communicators must convey that the products or services an organization sells are safe and effective.{{sfn|Markel|2009}}

===The Environment===
Technical communicators have an obligation to the environment. This obligation includes alerting their supervisors, managers, and executive leadership to products or processes that are detrimental to the environment. Protecting the environment can be costly, however, and organizations may consider ignoring legal guidelines to save money.{{sfn|Markel|2009}} Yet, failure to adhere to U.S. Environmental Protection Agency regulations also has financial implications. For example, the penalty for mishandling hazardous waste is five years and/or up to $50,000 for each day of the violation.{{sfn|EPA|2023}}

=== Disinformation ===
One major ethical concern in all forms of writing, but especially in digital writing, is the creation and spread of disinformation. Disinformation, often referred to as "[[w:Fake news|fake news]]," is information that is purposefully spread as false or misleading and is a sub-type of misinformation.{{sfn|Lawrence|2022|loc=section 3.7}} Modern communication technologies allow for the spread of information to occur at a fast pace. Social media is one area where the spread of disinformation occurs regularly.

Some social media sites, such as Facebook, have begun to flag certain articles posted on the site as being questionable in their representation of facts or occurrences. Despite the widespread understanding and use of disinformation available today, digital writers need to be aware of their intent and the audience's needs and wants from their digital communication.{{sfn|Lucas|2023f}} Ethical considerations regarding citing sources, cross-referencing information, and using primary sources are good practices for maintaining ethical standing and credibility as a digital writer.

To help mitigate the problem of disinformation, technical writers should utilize gatekeepers. These individuals verify the accuracy of the information before it is distributed to primary readers. This helps protect the author from any ethical and/or legal issues.{{sfn|Balzotti|2022|p=83}}

==Pedagogical Approaches==
===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}}

===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}}

===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}}

==Future Trends and Challenges==
=== Future Trends===
Between 2022 and 2032, the [https://en.wikipedia.org/wiki/Bureau_of_Labor_Statistics, United States Bureau of Labor Statistics] is projecting a 7% job growth for technical writers.{{sfn|United States Bureau of Labor Statistics|2023}} To be relevant as a technical writer in the digital age, one must possess the skills of conducting in-depth research, critical thinking, being detail oriented, design, and technical expertise. To succeed at communicating the complex to specific audiences, the technical writer must understand much of the subject in its complexity. This is accomplished through possessing the skills of communication, collaboration, and teamwork.{{sfn|Fechter|2023}}

===Challenges===
Barriers to teaching technical communications include the speed at which digital tools evolve, the complexity of software,{{sfn|Hovde|Renguette|2017|pp=395-411}} and the dependency on input information accuracy. Outdated, incorrect, or inconsistent data delays the publication, requires more reparative efforts, and decreases productivity.{{sfn|Ajose-Coker|2022}} Also, technical writers often have to contend with complex, outdated or unsuitable tools. This can make their job more difficult and time-consuming, and can lead to frustration and errors.{{sfn|Ajose-Coker|2022}}

===Artificial Intelligence===
Artificial intelligence programs, utilizing natural language processing, are capable of producing technical writing and have advanced in recent years becoming more adept.{{sfn|Marr|2023}}

One such program is [https://en.wikipedia.org/wiki/ChatGPT ChatGPT], which uses machine learning to produce texts with human-like style and tone.{{sfn|University of Central Arkansas|2023}} Another leader in this area, Contentbot, uses a WordPress plugin which gives blog writers ideas to enhance their posts which are shared via email.{{sfn|Siddiqui|2022}}

===Plagiarism===
Because of the ability of chatbots to imitate human-like language, some education administrators have taken precautions to minimize the occurrence of students passing off artificially generated texts as their own. In some instances, educators have taken the view that material drawn from artificial intelligence software must be handled in the same way as sources from human authors.{{sfn|Klein|2023}} In such cases, students who incorporate artificially generated text into their work have been made to denote credit for the artificial intelligence program utilized.

===Credit ===
The advent of chatbots has complicated the issue of credit where creative work is concerned. Because chatbots can simulate human speech, their ability to create cinematic dialogues and other types of creative writing have threatened the credits and financial condition of professional writers. According to an article by Aaron Mok and Jacob Zinkula on ''[https://www.businessinsider.com/ Business Insider]'', writing jobs are among the top 10 roles that AI is most likely to replace.{{sfn|Mok|2023}}

==References==
===Citations===
{{Reflist}}

===Bibliography===
{{Refbegin|30em}} 
* {{cite web |url=https://www.linkedin.com/advice/0/how-can-you-create-effective-visual-aids-1c |title=How Can You Create Effective Visual Aids for Technical Writing? |last=AI and the LinkedIn Community |date=2023 |website=www.linkedin.com |publisher=LinkedIn |access-date=2023-11-05 }}
* {{cite web |url=https://componize.com/common-problems-in-technical-writing-and-how-to-resolve-them/ |title=Common Problems in Technical Writing and How to Solve Them |last=Ajose-Coker |first=Dipo |date=2022 |website=componize.com |publisher=Componize Software |access-date=2023-11-19 }}
* {{cite book |last=Bair|first=Amy Lupold |date=2014 |title=Blogging for Dummies|url=|location=Hoboken, NJ |publisher=Jon Wiley & Sons, Inc|pages=|isbn=|author-link= }}
* {{cite book |last=Balzotti |first=Jon |date=2022 |title=Technical Communication: A Design-Centric Approach |edition= 2nd |url= |location=New York |publisher=Routledge |isbn=9780367438302 }}
* {{cite book |last=Barr |first=Chris |date=2010 |title=The Yahoo! Style Guide |url= |location=New York |publisher=St. Martin's }}
* {{cite book |last=Carroll |first=Brian |date=2010 |title=Writing for Digital Media |url= |location=New York |publisher=Routledge }}
* {{cite book |last1=Coco |first1=Pete |last2=Torres |first2=M. Gabriella |date=2014 |editor-last1=Dougherty |editor-first1=Jack |editor-last2=O'Donnell |editor-first2=Tennyson |title=Web Writing: Why and How for Liberal Arts Teaching and Learning |publisher=University of Michigan Press |pages=175-188 |chapter=“Writing as Curation: Using a ‘Building’ and ‘Breaking’ Pedagogy to Teach Culture in the Digital Age" |chapter-url=https://epress.trincoll.edu/webwriting/chapter/cocotorres }}
* {{cite web |url=https://www.betonconsultingeng.com/objectivity-in-technical-writing/#:~:text=Pointers%20for%20objective%20technical%20writing%201%20If%20you,5%20Remember%20that%20correlation%20is%20not%20causality.%20 |title=Objectivity in Technical Writing |last=Detwiler |first=Rachel |date=2021 |website=www.betonconsultingeng.com |publisher=Beton Consulting Engineers L.L.C. |access-date=2023-11-05 }}
* {{cite book |last=DeVoss |first=Danielle |last2=National Writing Project |last3=Eidman-Aadahl |first3=Elyse |last4=Hicks |first4=Troy |date=2010 |title=Because Digital Writing Matters: Improving Student Writing in Online and Multimedia Environments |location=San Francisco |publisher=Jossey-Bass |pages=105 |isbn= |url=https://openlibrary.org/books/OL34593323M/Because_Digital_Writing_Matters }}
*{{cite book |last=Enge |first=Eric |last2=Spencer |first2=Stephan |last3=Stricchiola |first3=Jessie |date=2022 |title=The Art of SEO: Mastering Search Engine Optimization |url=https://archive.org/details/artofseomasterin0000enge |location=Sebastopol, CA |publisher=O'Reilly |pages=9 }}
* {{cite web |url=https://www.epa.gov/enforcement/criminal-provisions-resource-conservation-and-recovery-act-rcra |title=Criminal Provisions of the Resource Conservation and Recovery Act (RCRA) |date=2023 |publisher=United States Environmental Protection Agency }}
* {{cite web |url=https://technicalwriterhq.com/career/technical-writer/technical-writing-skills/ |title=Essential Technical Writing Skills |last=Fechter |first=Josh |date=2023 |website=technicalwriterhq.com |access-date=2023-11-21}}
* {{cite book |last=Gagich |first=Melanie |last2=Zickel |first2=Emilie |date=n.d. |title=Writing Arguments in Stem |chapter=Rhetorical Appeals: Logos, Pathos, and Ethos Defined |publisher=Digital Commons |url=https://digitalcommons.calpoly.edu/cgi/viewcontent.cgi?article=1000&context=oercoursematerials#page=44 |location= |pages=34-37 }}
* {{cite book |last=Garrand |first=Timothy |date=2006 |title=Writing for Multimedia and the Web: A Practical Guide to Content Development for Interactive Media |edition=3rd |location=Burlington, MA |publisher=Focal Press }}
* {{cite book |last=Garrett |first=Jesse James |title=The Elements of User Experience: User-Centered Design for the Web and Beyond |publisher=New Riders |edition=2nd |date=2011 |location=Berkeley, CA |page=17 }}
* {{cite book |last=Godson |first=Williams|title=Web Design with HTML and CSS |p=37-41}}
* {{cite web |url=https://smashingmagazine.com/2014/08/a-closer-look-at-personas-part-2/ |title=A Closer Look at Personas: A Guide to Developing The Right Ones (Part 2) |last=Goltz | first=Shlomo |date=2014 |website=smashingmagazine.com |publisher=Smashing Media AG |access-date=2023-11-13 }}
* {{cite magazine |last=Grimstead |first=Deborah M. |date=1999 |title=Technical Writers are in Demand: Do You Have The Right Stuff? |magazine=Black Collegian |pages=128 }}
* {{cite journal |last1=Hovde |first1=Marjorie |last2=Renguette |first2=Corinne |date=2017 |title=Technological Literacy: A Framework for Teaching Technical Communication Software Tools |journal=Technical Communication Quarterly |volume=26 |pages=395-411 |doi=10.1080/10572252.2017.1385998}}
* {{cite web |url=https://www.ibm.com/topics/knowledge-management |title=What is Knowledge Management? |first= |last=IBM |website=ibm.com |access-date=2023-11-24}}
* {{cite web |url=https://www.idassoc.com/product-information-definition/data-sheet |title=Product Information Encyclopedia |last=IDA |first= |date=2020 |website=Industrial Data Associates |publisher= |access-date=2023-11-20 |quote= }}
* {{cite book |last=Johnson-Sheehan |first=Richard |title=Technical Communication Today |url= |edition=6 |location=Boston, MA |publisher=Pearson |date=2018 |pages= }}
* {{cite news |last=Klein |first=Alyson |date=2023 |title=ChatGPT Cheating: What to Do When It Happens |url=https://www.edweek.org/technology/chatgpt-cheating-what-to-do-when-it-happens/ |work=Education Week |location=Bethesda, MD |access-date=2023-11-05 }}
* {{cite book |last=Krug |first=Steve |date=2014 |title=Don’t Make Me Think, Revisited|url= |location=Berkeley, CA |publisher=New Riders |pages= |isbn= |author-link= }}
* {{cite book |last=Lannon |first=John M. |last2=Gurak |first2=Laura J. |date=2020 |title=Technical Communication |edition=15 |url= |location= |publisher=Pearson Education |page= }}
* {{cite book |last=Last|first=Susan |date=2019 |title=Technical Writing Essentials|url=https://pressbooks.bccampus.ca/technicalwriting/chapter/communicatingprecision/|location= |publisher= Victoria, B.C. University of Victoria |pages= |isbn= |author-link= }}
* {{cite book |last=Lawrence |first=Dan |date=2022 |title=Digital Writing: A Guide to Writing for Social Media and the Web |location=Peterborough, Ontario, Canada |publisher=Broadview Press |page=85 }}
* {{cite web |url=https://grlucas.net/grl/Writing_on_a_Wiki |title=Writing on a Wiki |last=Lucas |first=Gerald| date=2021| website=grlucas.net| publisher=MediaWiki| access-date=2023-10-31 }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Personas |title= Using Personas in Digital Writing
|last=Lucas |first=Gerald |date=2023a| website=grlucas.net |publisher=MediaWiki |access-date=2023-11-07 }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/SEO |title=Search Engine Optimization: Strategies and Best Practices for Effective Online Visibility |last=Lucas |first=Gerald |date=2023b |website=grlucas.net |publisher=MediaWiki |access-date=2023-11-19 }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Documents|title=Exploring the Dichotomy: A Comparative Analysis of Digital and Paper Documents |last=Lucas |first=Gerald |date=2023c |website=grlucas.net |publisher=MediaWiki |access-date=2023-10-29 |quote= }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Design/Users |title=User-Centered Design in Digital Documents |last=Lucas |first=Gerald |date=2023d |website=grlucas.net |publisher=MediaWiki |access-date=2023-11-15 |quote= }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Style |title=Audience-Centric Style in Digital Writing |last=Lucas |first=Gerald |date=2023e |website=grlucas.net |publisher=MediaWiki |access-date=2023-10-22 |quote= }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Credibility |title=The Significance of Credibility in Digital Writing |last=Lucas |first=Gerald |date=2023f |website=grlucas.net |publisher=MediaWiki |access-date=2023-11-21 }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Tech_Writing |title=Combining Disciplinary Approach to Technical Writing with Digital Writing: Enhancing Communication in the Digital Age |last=Lucas |first=Gerald |date=2023g |website=grlucas.net |publisher=MediaWiki |access-date=2023-11-27 |quote= }}
* {{cite web |url=https://www.indeed.com/career-advice/careers/what-does-a-technical-writer-do |title=What Does a Technical Writer Do? (Plus How To Become One) |last=Macari |first=Sabina |date=2023 |website=indeed.com |publisher=Indeed |access-date=2023-11-05 }}
* {{cite magazine |last=Malone |first=Ed |date=2008 |title=Joseph D. Chapline: Technical Communication's Mozart |url=https://web.mst.edu/~malonee/chapline.pdf |magazine=IEEE Professional Communication Society Newsletter |access-date=2023-10-31 }}
* {{cite journal |last=Malone |first=Edward |date=November 2011 |title=The First Wave (1953-1961) of the Professionalization Movement in Technical Communication |url=https://www.stc.org/techcomm/wp-content/uploads/sites/3/2016/08/november-2011-58-4.pdf |journal=Technical Communication |volume=58 |issue=4 |pages=285-306 |doi= |access-date=2023-10-11 }}
* {{cite book |last=Markel |first=Michael |title=Technical Communication |date=2009 |edition=9th |location=Boston |publisher=Bedford/St. Martin's |pages=22-25 }}
* {{cite book |last=Markel |first=Mike |last2=Selber |first2=Stuart A. |date=2019 |title=Practical Strategies of Technical Communication |edition=3rd |url= |location=Boston |publisher=Bedford/St. Martin’s |page= }}
* {{cite web |url=https://www.forbes.com/sites/bernardmarr/2023/01/23/how-chatgpt-and-natural-language-technology-might-affect-your-job-if-you-are-a-computer-programmer/?sh=6d9acf79174b |title=How ChatGPT And Natural Language Technology Might Affect Your Job If You Are A Computer Programmer |last=Marr |first=Bernard |date=2023 |website=Forbes.com |publisher=Forbes Media |access-date=2023-10-31 |quote= }}
* {{cite web |url=https://www.businessinsider.com/chatgpt-jobs-at-risk-replacement-artificial-intelligence-ai-labor-trends-2023-02 |title=ChatGPT may be coming for our jobs. Here are the 10 roles AI is most likely to replace |last=Mok |first=Aaron |date=2023 |website=Insider |publisher=Business Insider |access-date= 2023-11-05 }}
* {{cite book |last=Mussack |first=Brigitte |date=2021 |title=Introduction to Technical and Professional Communication |url=https://pressbooks.umn.edu/techwriting/front-matter/introduction/ |location= |publisher=Creative Commons Attribution NonCommercial |pages=n.p. |author-link= }}
* {{cite book| last=Parkinson |first=Mike |title=A Trainer’s Guide to PowerPoint: Best Practices for Master Presenters| location=United States| publisher=Association for Talent Development| chapter=Chapter 4. PowerPoint Tips, Tricks, and Secrets| date=2018 }}
* {{cite book |last=Perelman |first=Leslie |date=1998 |title=The Mayfield Handbook of Technical and Scientific Writing |url=https://www.mit.edu/course/21/21.guide/ |location=Mountain View |publisher=Mayfield Publishing Company |pages=n.p. |isbn= |author-link= }}
* {{cite web |url=https://learn.g2.com/how-to-write-a-press-release |title=How to Write a Press Release That Catches People's Attention |date=2021 |last=Pradhan |first=Ninisha |website=learn.g2.com |publisher=G2.com |access-date=2023-11-21 }}
* {{cite web |url=https://proofed.com/writing-tips/a-beginners-guide-to-technical-writing/ |title=A Beginner’s Guide to Technical Writing |last=Proofed Editors |date=2020 |website=Proofed.com |publisher=Proofed |access-date=2023-11-05 }}
* {{cite journal |last=Rathbone |first=Robert |title=Growth of the technical writing profession |journal=STWE Review |volume=5 |issue=1 |date=1958 |pages=5-16 }}
*{{cite book |last=Robbins |first=Jennifer Niederst |date=2018 |title=Learning Web Design: A Beginner’s Guide to HTML, CSS, JavaScript, and Web Graphics (5th ed.) |url= |location=Sebastopol, CA |publisher= O’Reilly Media, Inc. }}
* {{cite book |last=Rose|first=Darren |last2=Garret |first2=Chris|date=2012 |title=ProBlogger: Secrets for Blogging Your Way to a Six-Figure Income|url=|location=Indianapolis, IN |publisher=Jon Wiley & Sons, Inc|pages=|isbn=|author-link= }}
* {{cite book |last1=Rosenfeld |first1=Louis |last2=Morville |first2=Peter |last3=Arango |first3=Jorge |date=2006 |title=Information Architecture for the Web and Beyond |edition=4th |location=Sebastopol, CA |publisher=O'Reilly Media, Inc.}}
* {{cite web |url=https://writingcooperative.com/intricacies-of-ai-tools-can-ai-tools-take-over-the-jobs-of-technical-writers-af36836f625c |last=Siddiqui |first=Zafar |title=Will Best Artificial Intelligence Take Over any Technical Content Writer? |date=2022 |website=writingcooperative.com |publisher=The Writing Cooperative |access-date=2023-11-19 }}
* {{cite web |url=https://www.managementnote.com/features-of-technical-communication/#google_vignette |title=Features of Technical Communication |last=Smirti |date=2022 |website=managementnote.com |publisher=Management Note |access-date= 2023-11-05 }}
* {{cite web |url=https://www.stc.org/about-stc/ |title=About STC |last=Society for Technical Communication |first= |date=2023a |website=stc.org |publisher= |access-date=2023-10-27 }}
* {{cite web |url=https://www.stc.org/about-stc/ethical-principles/ |title=Ethical Principles |last=Society for Technical Communication |first= |date=2023b |website=stc.org |publisher= |access-date=2023-10-27 }}
* {{cite web |url=https://www.bls.gov/ooh/media-and-communication/technical-writers.htm#tab-6 |title=Occupational Outlook Handbook |last=United States Bureau of Labor Statistics |first= |date=2023 |website=bls.gov |publisher=United States Department of Labor |access-date=2023-11-07 }}
* {{cite web |url=https://uca.edu/cetal/chat-gpt/ |title=Chat GPT: What is it? |last=University of Central Arkansas |first= |date= |website=uca.edu |publisher= University of Central Arkansas |access-date=2023-10-09 }}
* {{cite web |url=https://www.viralnation.com/blog/what-is-digital-content-creation-and-how-can-it-help-me-as-a-marketing-manager/#:~:text=A%20rule%20of%20thumb%20in%20digital%20content%20creation,turn%2C%20share%20it%20with%20others%20in%20their%20network. |title=What is Digital Content Creation? (and How Can It Help Me as a Marketing Manager) |last=Viral Nation |date=2019 |website=viralnation.com |publisher= Viral Nation |access-date=2023-11-05 }}
* {{cite web |url=https://www.w3.org/WAI/fundamentals/accessibility-intro/|title=Introduction to Web Accessibility |last=WAI |first=|date=2022 |website=W3.org|publisher= |access-date= 2023-10-26 |quote= }}
* {{cite web |url=https://scribehow.com/library/user-guide |title=What is a User Guide? Everything You Need to Know |last=Wainaina |first=Timan |date=2022 |website= |publisher= |access-date=22 November 2023 |quote= }}
* {{cite web |url=https://wcag.com/legal/|title=Accessibility and the Law |last=WCAG |first= |date=2023 |website=wcag.com|publisher=eSSENTIAL Accessibility |access-date= 2023-10-26 |quote= }}
* {{cite book |last=Zeleznik |first=J. M. |last2=Burnett |first2=R. E. |last3=Benson |first3=P. J. |date=1999 |title=Technical Writing: What It Is and How to Do It |url= |location= |publisher=National Book Network |pages=107 |isbn= |author-link= }}

{{Refend}}

[[Category:Fall 2023]]
[[Category:ENGL 5106]]

Technical Writing in the Digital Age

2023-11-28T20:19:14Z

APitts: /* Examples of Digital Documents */ citations needed

'''Technical Writing in the Digital Age''' represents the dynamic and evolving discipline of creating written materials that convey complex information, instructions, and technical concepts in the context of contemporary digital technologies. Its purview encompasses the creation, dissemination, and management of technical documents and content within an expansive digital landscape. Connected networks of workstations, laptops, cell phones, tablets, and servers are the central nervous system in the technical workplace.

Major considerations revolve around adapting traditional principles of rhetoric to digital platforms, ensuring effective communication in an era of rapid technological advancements. 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. In essence, technical writing in the digital age encapsulates the art and science of conveying technical information in a manner that is comprehensible and accessible to diverse audiences in our digitally driven society.

==Overview==

=== Aims of Technical Communication ===
Technical communication is a discipline utilized by various fields like education, business, and science. In any domain, technical documentation shares a common objective: assisting the audience in achieving a task or goal.{{sfn|Markel|Selber|2019}} This common objective is achieved by the technical writer developing the ability to communicate complex and technical information more easily to the audience.{{sfn|United States Bureau of Labor Statistics|2023}}

=== 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.

==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.{{Citation needed}}

Advances in technology thrust the technical writing profession into a new era. The technical writer's work 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}}

==Features of Technical Communication==
Technical communication involves conveying complex information to a specific audience. Key features include accuracy, attention to detail, visuals, and clear and concise organization to enhance user understanding.{{sfn|Smirti|2022}}

=== Accuracy ===

==== Standards Compliant ====
Many technical fields have industry-specific regulations and guidelines which are determined by governing bodies, and also impact their technical communication. Furthermore, many organizations may have a style guide that outlines preferred language usage, tone, and formatting.{{sfn|Smirti|2022}}

==== Detail-Oriented ====
Technical communication should be detail-oriented and free of errors and inconsistencies. Accurate information that is delivered with precision and specificity is essential to providing communication that is unambiguous and free of discrepancies.{{sfn|Smirti|2022}}

==== Objective ====
Objective communication is presented in an unbiased and impartial manner and is free of personal opinions. It relies upon facts and evidence and avoids an overly emotional tone. This approach is particularly important in fields where accuracy and impartiality are essential.{{sfn|Detwiler|2021}}

===== Clear and Concise =====
Technical communication should be logically organized, straightforward, and easily understood by the target audience. The language used should avoid needless jargon and be written in a manner that avoids redundant word usage and/or excessive explanations.{{sfn|Smirti|2022}}{{sfn|Proofed Editors|2020}}

=== Soundness ===

==== Formatted and Organized ====
Technical documents should be formatted in a way that is consistent with the norms and standards of applicable professional fields. Additionally, formatting should adhere to guidelines that enhance usability. Information should be logically organized for easy reading comprehension. This may involve using headings, subheadings, bullet points, and numbered lists. Formatting details should remain consistent throughout the document.{{sfn|Smirti|2022}}{{sfn|Proofed Editors|2020}}

==== Graphical ====
Technical communication utilizes visuals strategically to facilitate understanding of textual content. Visuals such as diagrams, charts, graphs, or images can enhance understanding of a technical document. When presented properly, visuals can explain difficult concepts and make material accessible to a more diverse audience.{{sfn|AI and the LinkedIn Community|2023}}

=== Appropriateness ===

==== Audience-specific ====
Where possible, technical communication should be customized to align with the knowledge and needs of its audience. Communication style and tone should be tailored to match the audience's level of expertise and should take into consideration such factors as the users' technical background, familiarity with the subject, and specific requirements.{{sfn|Viral Nation|2019}} The tone sets the overall mood for the piece.

====Document Design====
Documents' appropriateness requires that readers can quickly understand the message of the document. The document should be of appropriate style and length for the readers' needs.

==Personas in Digital Writing==
Personas in the context of digital writing, which is writing composed, created and read in digital environments, refer to semi-fictional characters that encapsulate the characteristics, behaviors, and needs of target audience segments. They align closely with the principles of user-centered design (UCD).{{sfn|Lucas|2023a}} There are myriad ways to integrate user-centered thinking into the creative process of UX design, and personas are one of the most effective ways to empathize with and analyze users.{{sfn|Goltz|2014}}

Personas may guide the creation of documentation and tutorials catering to different user needs. It is crucial to adjust the language and tone to match the persona preference. Different personas can influence and guide the design of the project.

==Rhetorical Strategies in the Digital Age==
[https://en.wikipedia.org/wiki/Rhetoric Rhetoric] is a communication strategy whose primary goal is to persuade an audience. It is grounded in three foundational concepts first defined by the Greek philosopher Aristotle. These concepts are ''logos'', which engages with the reader’s sense of logic or reason; ''pathos'', which appeals to the reader’s emotions; and ''ethos'', which addresses the audience’s values and the writer’s credibility. Within this framework, writers utilize specific techniques or devices to influence and engage readers. Examples include appealing to an audience’s sense of logic by using factual examples to support a point or evoking emotion through descriptive visual language.{{sfn|Gagich|Zickel|n.d.|pp=34-37}}

In today’s digital age, writers can use digital technologies as rhetorical devices to influence the reader. Electronic images and informational graphics can be incorporated into digital and online documents to illustrate or reinforce points made in the text.{{sfn|Markel|Selber|2019}} [[#Hyperlinking|Hyperlinks]] can provide access to additional information that supports authors’ ideas and enhances their credibility.{{sfn|Lucas|2023g|}} Nevertheless, the writer's basic task of informing and persuading an audience is the same in digital communication as in other forms of writing.{{sfn|DeVoss|National Writing Project|Eidman-Aadahl|Hicks|2010|p=105}}

Digital writers must therefore consider specific elements that compose the rhetorical context in which texts are created and delivered. Such elements may include evaluating the demographics, habits, and needs of an intended audience; determining the overall objective of the communications; and deciding what technologies will be used to create the content. Together, this analysis allows writers to craft messages that both appeal to and inform the target audience. In the digital age, such rhetorical messages may be conveyed through websites, social media, and other digital platforms.{{sfn|Lawrence|2022|pp=6-14}}

==Digital Technologies Tools==
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}}

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

=== Content Management Systems (CMS) ===
A content management system (CMS) is a software application that allows users to create, manage, and modify digital content on a website. It provides a user-friendly interface and tools to easily organize, publish, and update content, including text, images, videos, and documents. Additionally, CMSs often offer features like user permissions, version control, and Search Engine Optimization (SEO) to enhance the overall website management experience.{{sfn|Carroll|2006|p=129}} Some popular examples of CMS include [https://wordpress.com/ WordPress], [https://www.wix.com/ Wix], and [https://www.blogger.com/about/?bpli=1 Blogger].

=== Image Processing Software ===
Image processing software plays a valuable role in technical and digital writing by facilitating the creation and enhancement of visuals. Documentation and tutorials help optimize images to convey processes or procedures effectively. Whether for screen captures illustrating software interfaces, data visualizations, or graphics for digital content, image processing tools contribute to creating clear and visually appealing materials.{{sfn|Robbins|2018|p=664}} These tools, such as [https://www.adobe.com/ Adobe] and [https://www.canva.com/ Canva], enhance the visual impact of technical and digital writing, ensuring that images are optimized, informative, and engaging for the audience.

=== Word Processors ===
Word processors are software applications designed for creating, editing, and formatting documents on a computer. They provide many features, such as spell-checking, grammar-checking, and inserting images and tables. These programs are typically used for writing essays, creating reports, or drafting professional documents.{{sfn|Carroll|2010|p=229}} Some popular software applications are [https://www.microsoft.com/en-us/microsoft-365/word Microsoft Word], [https://www.google.com/docs/about/ Google Docs][https://www.microsoft.com/en-us/microsoft-365/sharepoint/collaboration , SharePoint], and [https://www.apple.com/pages/ Apple Pages]. These programs allow documents to be readily disseminated. Comment capability enables audience members to interact about a document with one another and the author.

=== 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.

== 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}}

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

=== Case Studies ===
Case studies are a form of empirical or observational research that consists of in-depth examination of distinct individuals, groups, events, or scenarios. This research can be used to generate qualitative or quantitative data.{{sfn|Johnson-Sheehan|2018|pp=401-404}}

=== Data Sheets ===
A data sheet, also known as a technical datasheet, is a document used to describe and summarize the characteristics of a product, material, component, or technology.{{sfn|IDA|2020|p=}}

=== 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}}

*Product: provides detailed information about a specific item, including its features, specifications, and benefits.
*Process: provides step-by-step instructions on how to perform a particular task or achieve a specific outcome.

=== Documentation ===
Documentation comprises various texts that allow users to accomplish tasks or gain information. It generally falls into three categories, which can be defined as follows:
* Instructions: Text that describes how to complete a task, often offering numbered steps. Examples include how to download software or assemble a product.{{sfn|Balzotti|2022|p=167}}
* Specifications: Communications that deliver technical details on how a product is put together or a specific operation is executed. Also known as "specs," these texts may be written by engineers or technicians.{{sfn|Johnson-Sheehan|2018|p=205}}
* Procedures and Protocols: Guidelines to ensure consistency, quality, and safety in the workplace. For example, a hospital may provide staff with procedures on how to adapt operations during an emergency, such as a power outage.{{sfn|Johnson-Sheehan|2018|p=205}}

=== Email ===
Emails are the primary form of communication in the workplace, used for both internal and external communication. They facilitate information exchange, idea exchange, and activity coordination.{{sfn|Lannon|Gurak|2020|p=335}} Emails should be brief, concise, readable, and targeted to specific audiences with specific subject lines.{{sfn|Lannon|Gurak|2020|p=348}}

=== Letters ===
Letters are a traditional form of communication most often used by employees to communicate with individuals outside of a company or organization. They are typically written on company letterhead. Today, letters are sent either by U.S. mail or electronically.{{sfn|Johnson-Sheehan|2018|p=139}}

=== Memos ===
A memo (short for memorandum) is an official communication, usually a message from the company, a manager or director, or another person or group acting in an official capacity, used to communicate with others within the same organization.{{sfn|Lannon|Gurak|2020|p=353}}

=== 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}}

=== Proposals ===
A proposal is a document that identifies an existing problem or opportunity and outlines a comprehensive strategy for addressing it. Organizations create ''internal'' proposals to describe programs and projects that meet specific operational needs, such as a plan to replace an outdated software system. Companies develop ''external'' proposals for potential customers or clients. These documents detail new products, services, or initiatives that a company will implement to address a specific customer concern.{{sfn|Johnson-Sheehan|2018|p=245}}

=== Reports ===
A report is a concise, easily understandable document that presents technical information in a clear, organized format, allowing readers to access varying levels of information. Reports are categorized as informal, such as briefs, and formal, such as research, scientific, and completion reports.{{sfn|Johnson-Sheehan|2018|loc=chpt 10 & 11}}

==== Informal or Brief Reports ====
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.
* 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.
* Laboratory Reports describe experiments, tests, or inspections.

==== Formal Reports ====
A formal report is a factual and data-driven response to a research question.
* Research reports present the findings of a study.
* Scientific research reports outline the process, progress, and results of technical or scientific research or the current state of a research problem.
* Completion reports assess the outcomes of a project or initiative and provide feedback to management or the client.

=== 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.

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}}

=== 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}}

==Search Engine Optimization (SEO)==
SEO refers to the practice of optimizing online content to enhance its visibility and ranking on search engine results pages (SERPs), making it a crucial skill for digital writers.{{sfn|Lucas|2023b}} To optimize content for SEO means to have the goal of SEO in mind at the time of designing, creating, and writing a web page for publication. Using keywords and alt-text are two examples of optimizing content for SEO.{{sfn|Barr|2010|loc=chpt. 17}}

===Keywords===
Keywords are the words that search engines crawl a website for and index as the page's most important words. Based on other pages using the same keywords, the website is added into the search engine results pages from best matches to worst matches. The position of a website in search results is influenced by where it ranks on a scale determined by the keywords that a user searches for.{{sfn|Lucas|2023b}} To optimize a website's keywords, you should begin with researching keywords on your own website and ensure that you have an XML [https://en.wikipedia.org/wiki/Sitemaps sitemap] so search engines such as [https://en.wikipedia.org/wiki/Google Google] can crawl your web pages for updated information. In addition to using keywords, updating a page's metadata information can also help with showing up on SERPs. Using title and header tags as well as meta descriptions for content also helps optimize a website's ratings in SERPs.{{sfn|Lucas|2023b}}

===Alt-Text===
Alt-Text (alternative text), or [https://en.wikipedia.org/wiki/Alt_attribute Alt Attributes], is a practice that increases the usability and accessibility of a web page for users. Alt-Text is often used for visual elements that cannot be displayed in a different format but still provides description of the element for screen readers or users that may have a disability. Alt-Text also improves a website's SEO as a form of content optimization.{{sfn|Lucas|2023b}}

===Social Media Presence===
Sharing content from a website across different social media platforms is another way to create SEO optimization. This technique can help with being seen as legitimate and improves visibility of the website overall. Additionally, it can drive traffic and enables back-linking to occur when other websites have the ability to also link to the website.{{sfn|Lucas|2023b}}

=== Goals of Searching: The User's Perspective===
A user of search engines formulates queries by using keywords or posing questions. One of the most important elements of building an SEO strategy for a website is developing a thorough understanding of the psychology of your target audience and how they use words and concepts to obtain information about the services and/or products you provide. Once you understand how the average search engine user—and, more specifically, your target audience—utilizes query-based search engines, you can more effectively reach and keep those users.{{sfn|Enge|Spencer|Stricchiola|2022|p=9}}

==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}}

===Characteristics of Digital Documents===

====Electronic Format ====
Digital documents exist in electronic formats, which means they are stored and transmitted as binary data. This format allows for efficient storage, retrieval, and transmission of information via electronic devices.{{sfn|Lucas|2023c}} Digital documentation is the only method to meet a critical challenge of the relatively new concept of "knowledge management" that applies to all organizations. A digital knowledge management system is crucial to an organization so everyone can access information created by employees who are no longer with the organization or to allow cross-referencing with other seemingly unrelated departments.{{sfn|IBM}}

====Non-Tangible====
Unlike paper documents, digital documents lack physical presence. They are intangible and exist as electronic files, residing on devices or in the cloud.{{sfn|Lucas|2023c}}

====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}} It is a legal requirement to include accessibility features in website design.{{sfn|WCAG|2023}} It is also ethically imperative to make sure there is accessibility in digital writing. 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}} Accessibility broadens the reach of digital content and reaches a wider audience. This is important for technical writers, as their documentation and instructions are critical resources for users of varied abilities.

====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|Burnett|Benson|1999|p=207}} The other four Cs are coherent, concrete, correct and complete.{{sfn|Last|2019}}

====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 implementing visual elements, white space, concise language, highlighting, and emphasis.

====Ease of Reproduction and Distribution====
Digital documents are easily copied and distributed. They can be duplicated without any loss of quality, making it simple to share information widely and at minimal cost.{{sfn|Lucas|2023c}}

====Hyperlinking ====
Hyperlinking is a quick and efficient method for directing readers to relevant information in digital documents, facilitating seamless navigation between sections, references, and external resources.{{sfn|Carroll|2010|p=79}}

====Multimedia====
Digital documents can incorporate multimedia elements like images, audio, video, and interactive content, enhancing engagement through visual and auditory elements. Multiple media formats work best when sharing new, complicated ideas.{{sfn|Carroll|2010|p=36}} Increasing multimodality on a website improves engagement, usability, and accessibility. This can improve the impact of the website's standings in SERPs.{{sfn|Carroll|2010|p=280}}

====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}}

====Remote Collaboration====
One form of collaborative technical writing is a wiki, which is a "website developed collaboratively by a community of users, allowing any user to add and edit content."{{sfn|Lucas|2021}} One of the predominant elements of a wiki is that it is defined as being open source. As a result, anyone can modify it regardless of their geographic locations.

====Security Measures====
Digital documents can be protected with encryption, passwords, and access controls to safeguard sensitive information. These security measures enhance data protection and privacy.{{sfn|Lucas|2023c}}

====Environmental Impact====
Digital documents have a smaller environmental footprint compared to paper documents, as they reduce the need for paper production, printing, and transportation.{{sfn|Lucas|2023c}}

====Dynamic Updates====
Online digital documents can be updated dynamically, ensuring that users always have access to the most current information. This is particularly valuable in fast-changing fields.{{sfn|Lucas|2023c}}

====Global Accessibility====
Digital documents can be shared globally, transcending geographical boundaries and time zones. They support international collaboration and the dissemination of knowledge on a global scale.{{sfn|Lucas|2023c}}

====Data Integration====
In business and research settings, digital documents can integrate with databases and data analysis tools. This integration streamlines data collection, analysis, and reporting processes.{{sfn|Lucas|2023c}}

====Data Analytics ====
Digital documents can be subjected to data analytics techniques, allowing organizations to extract valuable insights from large volumes of textual data, which can inform decision-making and strategy.{{sfn|Lucas|2023c}}

==Examples of Digital Documents==
In technical and professional writing, digital documentation takes various forms. These methods streamline the sharing of technical information, enhance collaboration, and ensure easy accessibility within professional settings, contributing to efficient communication and knowledge dissemination.{{Citation needed}}

=== Infographics ===
Infographics, shared as digital documents, typically combine text, graphics, and illustrations to convey complex concepts or data in a concise and visually appealing format. Infographics are often used to simplify information, making it more accessible to a broader audience, and are found in presentations, reports, websites, and educational materials.{{sfn|Lannon|Gurak|2020|pp=292-293}}

=== Presentations ===
Presentations created with [https://en.wikipedia.org/wiki/Microsoft_PowerPoint PowerPoint] or [https://en.wikipedia.org/wiki/Google_Slides Google Slides] are vital for professional communication and knowledge sharing. They condense complex information into visually appealing slides for effective presentations by using photos, videos, graphics, charts, and graphs.{{sfn|Parkinson|2018|loc=chpt. 4}}

=== Blogs ===
A blog, short for "weblog," is an informational website organized into short articles called posts, typically chronologically ordered series of website updates, written and organized similar to a traditional diary.{{sfn|Bair|2014|p=7}} They are regularly updated, providing readers with insights on a specific topic or subject. Blogs serve various purposes, including sharing opinions, providing news, offering educational content, and documenting personal experiences.{{sfn|Rose|Garret|2012|p=2}}

==User Experience==
User experience (UX) is how a product works from the perspective of the user. Digital documents can be created with efficient user experiences by practicing several design methods, including user-centered design, information architecture, responsive design, and usability.{{Citation needed}}

===User-Centered Design===
The approach of user-centered design (UCD) in technical writing consists of the following methodology{{sfn|Lucas|2023e}}:

* User Research: the act of conducting thorough research through surveys, interviews, and usability testing to gain a better understanding of user needs and experiences when using a digital document
* Ideation and prototyping: the process of creating digital designs and prototypes to assist with exploring possible solutions to meet user needs
* Usability testing: the act of having users interact with digital document designs and recording and adjusting the design based on user feedback
* Implementation: the stage in which the design is implemented after making adjustments from prior testing
* Evaluation: the stage in which the digital document is assessed to ensure that it is meeting user needs
* Maintenance and updates: to maintain a digital document based on user feedback and changing needs

===Information Architecture===

To ensure a digital document has effective UX design and accessible information, technical writers need to construct a clear and organized information architecture (IA). IA is a design principle that organizes information so that it is easily found and understood by users, prioritizing their needs and reducing information overload. A design challenge is making IA understood across multiple digital experiences, changing the navigation structure to fit different medias while staying logical and consistent for the user.{{sfn|Rosenfeld|pp=1, 17-18}} IA that is not constructed well can confuse the user and could cause them to give up their search of information in frustration.{{sfn|Garrand|pp=12}}

The architecture components of IA can be divided into four different categories:{{sfn|Rosenfeld|pp=90}}

*Organization systems: how information is categorized and organized for user understanding

*Labeling systems: how information is represented

*Navigation systems: how users browse information and navigate between pages

*Searching systems: how users search for specific information

=== Responsive Design ===

Responsive design is a strategy that appropriately updates the layout and content of a website or document in relation to the screen size, device, and/or orientation, allowing the site or document to be easily viewed and navigated regardless of device used. With the increased use of mobile devices, web content should be constructed with proper responsive web design (RWD) to ensure effective UX and usability on those devices.{{sfn|Robbins| pp=485}}

There are several design strategies that can be implemented that will increase the success of RWD:{{sfn|Robbins| pp=487}}

*Fluid layout – Responsive sites can be constructed using a fluid layout (or flexible grid) system that will allow content to adjust and flow according to the available screen space.

*Flexible and responsive images – Images and other embedded media can be instructed so that they fit their containers instead of remaining at a fixed size. Images with varying resolutions can also be swapped according to screen size to avoid high-resolution images on smaller devices.

*CSS media queries – Media queries can be written into the CSS (Cascading Style Sheet), which would instruct the construction of the site according to screen width and orientation. Adding breakpoints for several screen sizes allows pages to be designed for specific devices.

*Content hierarchy – Carefully constructing content that is organized for the user and creating a hierarchy of content that prioritizes user needs is necessary to ensure effective user experience and navigation across multiple screen sizes.{{sfn|Robbins| pp=499}}

===Usability===

Technical writers must create documents and websites that meet the expectations of their readers and users, and in doing so, writers increase the usability of their site or document.{{sfn|Garrand|pp=26}} Usability can be applied with visual aids, clear and concise language, and structured design.

==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|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|Society for Technical Communication|2023a}} The STC promotes adherence to a list of ethical principles. They are legality, honesty, confidentiality, quality, fairness, and professionalism.{{sfn|Society for Technical Communication|2023b}}

Technical communicators also have to be careful to avoid plagiarism, or taking ideas, thoughts, or words from someone else and passing them off as one's own.{{sfn|Carroll|2010|p=280}}

Technical communicators have ethical standards to which they must abide. The standards are divided into three primary categories. They are the employer, the public, and the environment.{{sfn|Markel|2009}}

===The Employer===
Obligations to one's employer include competence and diligence, honesty and candor, confidentiality, and loyalty.{{sfn|Markel|2009}} The technical communicator must adhere to these obligations so that he/she does not harm the reputation or operation of the employer.

Technical communicators may occasionally work for an organization with strict privacy policies that prohibit them from using the documents they create outside of the organization. It is important for ethical communicators to follow the privacy policy for their organization because unauthorized release of information could lead to consequences up to and including termination.{{sfn|Balzotti|2022|p=83}}

=== The Public===
Organizations are obligated to treat customers fairly. Technical communicators must convey that the products or services an organization sells are safe and effective.{{sfn|Markel|2009}}

===The Environment===
Technical communicators have an obligation to the environment. This obligation includes alerting their supervisors, managers, and executive leadership to products or processes that are detrimental to the environment. Protecting the environment can be costly, however, and organizations may consider ignoring legal guidelines to save money.{{sfn|Markel|2009}} Yet, failure to adhere to U.S. Environmental Protection Agency regulations also has financial implications. For example, the penalty for mishandling hazardous waste is five years and/or up to $50,000 for each day of the violation.{{sfn|EPA|2023}}

=== Disinformation ===
One major ethical concern in all forms of writing, but especially in digital writing, is the creation and spread of disinformation. Disinformation, often referred to as "[[w:Fake news|fake news]]," is information that is purposefully spread as false or misleading and is a sub-type of misinformation.{{sfn|Lawrence|2022|loc=section 3.7}} Modern communication technologies allow for the spread of information to occur at a fast pace. Social media is one area where the spread of disinformation occurs regularly.

Some social media sites, such as Facebook, have begun to flag certain articles posted on the site as being questionable in their representation of facts or occurrences. Despite the widespread understanding and use of disinformation available today, digital writers need to be aware of their intent and the audience's needs and wants from their digital communication.{{sfn|Lucas|2023f}} Ethical considerations regarding citing sources, cross-referencing information, and using primary sources are good practices for maintaining ethical standing and credibility as a digital writer.

To help mitigate the problem of disinformation, technical writers should utilize gatekeepers. These individuals verify the accuracy of the information before it is distributed to primary readers. This helps protect the author from any ethical and/or legal issues.{{sfn|Balzotti|2022|p=83}}

==Pedagogical Approaches==
===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}}

===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}}

===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}}

==Future Trends and Challenges==
=== Future Trends===
Between 2022 and 2032, the [https://en.wikipedia.org/wiki/Bureau_of_Labor_Statistics, United States Bureau of Labor Statistics] is projecting a 7% job growth for technical writers.{{sfn|United States Bureau of Labor Statistics|2023}} To be relevant as a technical writer in the digital age, one must possess the skills of conducting in-depth research, critical thinking, being detail oriented, design, and technical expertise. To succeed at communicating the complex to specific audiences, the technical writer must understand much of the subject in its complexity. This is accomplished through possessing the skills of communication, collaboration, and teamwork.{{sfn|Fechter|2023}}

===Challenges===
Barriers to teaching technical communications include the speed at which digital tools evolve, the complexity of software,{{sfn|Hovde|Renguette|2017|pp=395-411}} and the dependency on input information accuracy. Outdated, incorrect, or inconsistent data delays the publication, requires more reparative efforts, and decreases productivity.{{sfn|Ajose-Coker|2022}} Also, technical writers often have to contend with complex, outdated or unsuitable tools. This can make their job more difficult and time-consuming, and can lead to frustration and errors.{{sfn|Ajose-Coker|2022}}

===Artificial Intelligence===
Artificial intelligence programs, utilizing natural language processing, are capable of producing technical writing and have advanced in recent years becoming more adept.{{sfn|Marr|2023}}

One such program is [https://en.wikipedia.org/wiki/ChatGPT ChatGPT], which uses machine learning to produce texts with human-like style and tone.{{sfn|University of Central Arkansas|2023}} Another leader in this area, Contentbot, uses a WordPress plugin which gives blog writers ideas to enhance their posts which are shared via email.{{sfn|Siddiqui|2022}}

===Plagiarism===
Because of the ability of chatbots to imitate human-like language, some education administrators have taken precautions to minimize the occurrence of students passing off artificially generated texts as their own. In some instances, educators have taken the view that material drawn from artificial intelligence software must be handled in the same way as sources from human authors.{{sfn|Klein|2023}} In such cases, students who incorporate artificially generated text into their work have been made to denote credit for the artificial intelligence program utilized.

===Credit ===
The advent of chatbots has complicated the issue of credit where creative work is concerned. Because chatbots can simulate human speech, their ability to create cinematic dialogues and other types of creative writing have threatened the credits and financial condition of professional writers. According to an article by Aaron Mok and Jacob Zinkula on ''[https://www.businessinsider.com/ Business Insider]'', writing jobs are among the top 10 roles that AI is most likely to replace.{{sfn|Mok|2023}}

==References==
===Citations===
{{Reflist}}

===Bibliography===
{{Refbegin|30em}} 
* {{cite web |url=https://www.linkedin.com/advice/0/how-can-you-create-effective-visual-aids-1c |title=How Can You Create Effective Visual Aids for Technical Writing? |last=AI and the LinkedIn Community |date=2023 |website=www.linkedin.com |publisher=LinkedIn |access-date=2023-11-05 }}
* {{cite web |url=https://componize.com/common-problems-in-technical-writing-and-how-to-resolve-them/ |title=Common Problems in Technical Writing and How to Solve Them |last=Ajose-Coker |first=Dipo |date=2022 |website=componize.com |publisher=Componize Software |access-date=2023-11-19 }}
* {{cite book |last=Bair|first=Amy Lupold |date=2014 |title=Blogging for Dummies|url=|location=Hoboken, NJ |publisher=Jon Wiley & Sons, Inc|pages=|isbn=|author-link= }}
* {{cite book |last=Balzotti |first=Jon |date=2022 |title=Technical Communication: A Design-Centric Approach |edition= 2nd |url= |location=New York |publisher=Routledge |isbn=9780367438302 }}
* {{cite book |last=Barr |first=Chris |date=2010 |title=The Yahoo! Style Guide |url= |location=New York |publisher=St. Martin's }}
* {{cite book |last=Carroll |first=Brian |date=2010 |title=Writing for Digital Media |url= |location=New York |publisher=Routledge }}
* {{cite book |last1=Coco |first1=Pete |last2=Torres |first2=M. Gabriella |date=2014 |editor-last1=Dougherty |editor-first1=Jack |editor-last2=O'Donnell |editor-first2=Tennyson |title=Web Writing: Why and How for Liberal Arts Teaching and Learning |publisher=University of Michigan Press |pages=175-188 |chapter=“Writing as Curation: Using a ‘Building’ and ‘Breaking’ Pedagogy to Teach Culture in the Digital Age" |chapter-url=https://epress.trincoll.edu/webwriting/chapter/cocotorres }}
* {{cite web |url=https://www.betonconsultingeng.com/objectivity-in-technical-writing/#:~:text=Pointers%20for%20objective%20technical%20writing%201%20If%20you,5%20Remember%20that%20correlation%20is%20not%20causality.%20 |title=Objectivity in Technical Writing |last=Detwiler |first=Rachel |date=2021 |website=www.betonconsultingeng.com |publisher=Beton Consulting Engineers L.L.C. |access-date=2023-11-05 }}
* {{cite book |last=DeVoss |first=Danielle |last2=National Writing Project |last3=Eidman-Aadahl |first3=Elyse |last4=Hicks |first4=Troy |date=2010 |title=Because Digital Writing Matters: Improving Student Writing in Online and Multimedia Environments |location=San Francisco |publisher=Jossey-Bass |pages=105 |isbn= |url=https://openlibrary.org/books/OL34593323M/Because_Digital_Writing_Matters }}
*{{cite book |last=Enge |first=Eric |last2=Spencer |first2=Stephan |last3=Stricchiola |first3=Jessie |date=2022 |title=The Art of SEO: Mastering Search Engine Optimization |url=https://archive.org/details/artofseomasterin0000enge |location=Sebastopol, CA |publisher=O'Reilly |pages=9 }}
* {{cite web |url=https://www.epa.gov/enforcement/criminal-provisions-resource-conservation-and-recovery-act-rcra |title=Criminal Provisions of the Resource Conservation and Recovery Act (RCRA) |date=2023 |publisher=United States Environmental Protection Agency }}
* {{cite web |url=https://technicalwriterhq.com/career/technical-writer/technical-writing-skills/ |title=Essential Technical Writing Skills |last=Fechter |first=Josh |date=2023 |website=technicalwriterhq.com |access-date=2023-11-21}}
* {{cite book |last=Gagich |first=Melanie |last2=Zickel |first2=Emilie |date=n.d. |title=Writing Arguments in Stem |chapter=Rhetorical Appeals: Logos, Pathos, and Ethos Defined |publisher=Digital Commons |url=https://digitalcommons.calpoly.edu/cgi/viewcontent.cgi?article=1000&context=oercoursematerials#page=44 |location= |pages=34-37 }}
* {{cite book |last=Garrand |first=Timothy |date=2006 |title=Writing for Multimedia and the Web: A Practical Guide to Content Development for Interactive Media |edition=3rd |location=Burlington, MA |publisher=Focal Press }}
* {{cite book |last=Garrett |first=Jesse James |title=The Elements of User Experience: User-Centered Design for the Web and Beyond |publisher=New Riders |edition=2nd |date=2011 |location=Berkeley, CA |page=17 }}
* {{cite book |last=Godson |first=Williams|title=Web Design with HTML and CSS |p=37-41}}
* {{cite web |url=https://smashingmagazine.com/2014/08/a-closer-look-at-personas-part-2/ |title=A Closer Look at Personas: A Guide to Developing The Right Ones (Part 2) |last=Goltz | first=Shlomo |date=2014 |website=smashingmagazine.com |publisher=Smashing Media AG |access-date=2023-11-13 }}
* {{cite magazine |last=Grimstead |first=Deborah M. |date=1999 |title=Technical Writers are in Demand: Do You Have The Right Stuff? |magazine=Black Collegian |pages=128 }}
* {{cite journal |last1=Hovde |first1=Marjorie |last2=Renguette |first2=Corinne |date=2017 |title=Technological Literacy: A Framework for Teaching Technical Communication Software Tools |journal=Technical Communication Quarterly |volume=26 |pages=395-411 |doi=10.1080/10572252.2017.1385998}}
* {{cite web |url=https://www.ibm.com/topics/knowledge-management |title=What is Knowledge Management? |first= |last=IBM |website=ibm.com |access-date=2023-11-24}}
* {{cite web |url=https://www.idassoc.com/product-information-definition/data-sheet |title=Product Information Encyclopedia |last=IDA |first= |date=2020 |website=Industrial Data Associates |publisher= |access-date=2023-11-20 |quote= }}
* {{cite book |last=Johnson-Sheehan |first=Richard |title=Technical Communication Today |url= |edition=6 |location=Boston, MA |publisher=Pearson |date=2018 |pages= }}
* {{cite news |last=Klein |first=Alyson |date=2023 |title=ChatGPT Cheating: What to Do When It Happens |url=https://www.edweek.org/technology/chatgpt-cheating-what-to-do-when-it-happens/ |work=Education Week |location=Bethesda, MD |access-date=2023-11-05 }}
* {{cite book |last=Krug |first=Steve |date=2014 |title=Don’t Make Me Think, Revisited|url= |location=Berkeley, CA |publisher=New Riders |pages= |isbn= |author-link= }}
* {{cite book |last=Lannon |first=John M. |last2=Gurak |first2=Laura J. |date=2020 |title=Technical Communication |edition=15 |url= |location= |publisher=Pearson Education |page= }}
* {{cite book |last=Last|first=Susan |date=2019 |title=Technical Writing Essentials|url=https://pressbooks.bccampus.ca/technicalwriting/chapter/communicatingprecision/|location= |publisher= Victoria, B.C. University of Victoria |pages= |isbn= |author-link= }}
* {{cite book |last=Lawrence |first=Dan |date=2022 |title=Digital Writing: A Guide to Writing for Social Media and the Web |location=Peterborough, Ontario, Canada |publisher=Broadview Press |page=85 }}
* {{cite web |url=https://grlucas.net/grl/Writing_on_a_Wiki |title=Writing on a Wiki |last=Lucas |first=Gerald| date=2021| website=grlucas.net| publisher=MediaWiki| access-date=2023-10-31 }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Personas |title= Using Personas in Digital Writing
|last=Lucas |first=Gerald |date=2023a| website=grlucas.net |publisher=MediaWiki |access-date=2023-11-07 }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/SEO |title=Search Engine Optimization: Strategies and Best Practices for Effective Online Visibility |last=Lucas |first=Gerald |date=2023b |website=grlucas.net |publisher=MediaWiki |access-date=2023-11-19 }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Documents|title=Exploring the Dichotomy: A Comparative Analysis of Digital and Paper Documents |last=Lucas |first=Gerald |date=2023c |website=grlucas.net |publisher=MediaWiki |access-date=2023-10-29 |quote= }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Design/Users |title=User-Centered Design in Digital Documents |last=Lucas |first=Gerald |date=2023d |website=grlucas.net |publisher=MediaWiki |access-date=2023-11-15 |quote= }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Style |title=Audience-Centric Style in Digital Writing |last=Lucas |first=Gerald |date=2023e |website=grlucas.net |publisher=MediaWiki |access-date=2023-10-22 |quote= }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Credibility |title=The Significance of Credibility in Digital Writing |last=Lucas |first=Gerald |date=2023f |website=grlucas.net |publisher=MediaWiki |access-date=2023-11-21 }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Tech_Writing |title=Combining Disciplinary Approach to Technical Writing with Digital Writing: Enhancing Communication in the Digital Age |last=Lucas |first=Gerald |date=2023g |website=grlucas.net |publisher=MediaWiki |access-date=2023-11-27 |quote= }}
* {{cite web |url=https://www.indeed.com/career-advice/careers/what-does-a-technical-writer-do |title=What Does a Technical Writer Do? (Plus How To Become One) |last=Macari |first=Sabina |date=2023 |website=indeed.com |publisher=Indeed |access-date=2023-11-05 }}
* {{cite magazine |last=Malone |first=Ed |date=2008 |title=Joseph D. Chapline: Technical Communication's Mozart |url=https://web.mst.edu/~malonee/chapline.pdf |magazine=IEEE Professional Communication Society Newsletter |access-date=2023-10-31 }}
* {{cite journal |last=Malone |first=Edward |date=November 2011 |title=The First Wave (1953-1961) of the Professionalization Movement in Technical Communication |url=https://www.stc.org/techcomm/wp-content/uploads/sites/3/2016/08/november-2011-58-4.pdf |journal=Technical Communication |volume=58 |issue=4 |pages=285-306 |doi= |access-date=2023-10-11 }}
* {{cite book |last=Markel |first=Michael |title=Technical Communication |date=2009 |edition=9th |location=Boston |publisher=Bedford/St. Martin's |pages=22-25 }}
* {{cite book |last=Markel |first=Mike |last2=Selber |first2=Stuart A. |date=2019 |title=Practical Strategies of Technical Communication |edition=3rd |url= |location=Boston |publisher=Bedford/St. Martin’s |page= }}
* {{cite web |url=https://www.forbes.com/sites/bernardmarr/2023/01/23/how-chatgpt-and-natural-language-technology-might-affect-your-job-if-you-are-a-computer-programmer/?sh=6d9acf79174b |title=How ChatGPT And Natural Language Technology Might Affect Your Job If You Are A Computer Programmer |last=Marr |first=Bernard |date=2023 |website=Forbes.com |publisher=Forbes Media |access-date=2023-10-31 |quote= }}
* {{cite web |url=https://www.businessinsider.com/chatgpt-jobs-at-risk-replacement-artificial-intelligence-ai-labor-trends-2023-02 |title=ChatGPT may be coming for our jobs. Here are the 10 roles AI is most likely to replace |last=Mok |first=Aaron |date=2023 |website=Insider |publisher=Business Insider |access-date= 2023-11-05 }}
* {{cite book |last=Mussack |first=Brigitte |date=2021 |title=Introduction to Technical and Professional Communication |url=https://pressbooks.umn.edu/techwriting/front-matter/introduction/ |location= |publisher=Creative Commons Attribution NonCommercial |pages=n.p. |author-link= }}
* {{cite book| last=Parkinson |first=Mike |title=A Trainer’s Guide to PowerPoint: Best Practices for Master Presenters| location=United States| publisher=Association for Talent Development| chapter=Chapter 4. PowerPoint Tips, Tricks, and Secrets| date=2018 }}
* {{cite book |last=Perelman |first=Leslie |date=1998 |title=The Mayfield Handbook of Technical and Scientific Writing |url=https://www.mit.edu/course/21/21.guide/ |location=Mountain View |publisher=Mayfield Publishing Company |pages=n.p. |isbn= |author-link= }}
* {{cite web |url=https://learn.g2.com/how-to-write-a-press-release |title=How to Write a Press Release That Catches People's Attention |date=2021 |last=Pradhan |first=Ninisha |website=learn.g2.com |publisher=G2.com |access-date=2023-11-21 }}
* {{cite web |url=https://proofed.com/writing-tips/a-beginners-guide-to-technical-writing/ |title=A Beginner’s Guide to Technical Writing |last=Proofed Editors |date=2020 |website=Proofed.com |publisher=Proofed |access-date=2023-11-05 }}
* {{cite journal |last=Rathbone |first=Robert |title=Growth of the technical writing profession |journal=STWE Review |volume=5 |issue=1 |date=1958 |pages=5-16 }}
*{{cite book |last=Robbins |first=Jennifer Niederst |date=2018 |title=Learning Web Design: A Beginner’s Guide to HTML, CSS, JavaScript, and Web Graphics (5th ed.) |url= |location=Sebastopol, CA |publisher= O’Reilly Media, Inc. }}
* {{cite book |last=Rose|first=Darren |last2=Garret |first2=Chris|date=2012 |title=ProBlogger: Secrets for Blogging Your Way to a Six-Figure Income|url=|location=Indianapolis, IN |publisher=Jon Wiley & Sons, Inc|pages=|isbn=|author-link= }}
* {{cite book |last1=Rosenfeld |first1=Louis |last2=Morville |first2=Peter |last3=Arango |first3=Jorge |date=2006 |title=Information Architecture for the Web and Beyond |edition=4th |location=Sebastopol, CA |publisher=O'Reilly Media, Inc.}}
* {{cite web |url=https://writingcooperative.com/intricacies-of-ai-tools-can-ai-tools-take-over-the-jobs-of-technical-writers-af36836f625c |last=Siddiqui |first=Zafar |title=Will Best Artificial Intelligence Take Over any Technical Content Writer? |date=2022 |website=writingcooperative.com |publisher=The Writing Cooperative |access-date=2023-11-19 }}
* {{cite web |url=https://www.managementnote.com/features-of-technical-communication/#google_vignette |title=Features of Technical Communication |last=Smirti |date=2022 |website=managementnote.com |publisher=Management Note |access-date= 2023-11-05 }}
* {{cite web |url=https://www.stc.org/about-stc/ |title=About STC |last=Society for Technical Communication |first= |date=2023a |website=stc.org |publisher= |access-date=2023-10-27 }}
* {{cite web |url=https://www.stc.org/about-stc/ethical-principles/ |title=Ethical Principles |last=Society for Technical Communication |first= |date=2023b |website=stc.org |publisher= |access-date=2023-10-27 }}
* {{cite web |url=https://www.bls.gov/ooh/media-and-communication/technical-writers.htm#tab-6 |title=Occupational Outlook Handbook |last=United States Bureau of Labor Statistics |first= |date=2023 |website=bls.gov |publisher=United States Department of Labor |access-date=2023-11-07 }}
* {{cite web |url=https://uca.edu/cetal/chat-gpt/ |title=Chat GPT: What is it? |last=University of Central Arkansas |first= |date= |website=uca.edu |publisher= University of Central Arkansas |access-date=2023-10-09 }}
* {{cite web |url=https://www.viralnation.com/blog/what-is-digital-content-creation-and-how-can-it-help-me-as-a-marketing-manager/#:~:text=A%20rule%20of%20thumb%20in%20digital%20content%20creation,turn%2C%20share%20it%20with%20others%20in%20their%20network. |title=What is Digital Content Creation? (and How Can It Help Me as a Marketing Manager) |last=Viral Nation |date=2019 |website=viralnation.com |publisher= Viral Nation |access-date=2023-11-05 }}
* {{cite web |url=https://www.w3.org/WAI/fundamentals/accessibility-intro/|title=Introduction to Web Accessibility |last=WAI |first=|date=2022 |website=W3.org|publisher= |access-date= 2023-10-26 |quote= }}
* {{cite web |url=https://scribehow.com/library/user-guide |title=What is a User Guide? Everything You Need to Know |last=Wainaina |first=Timan |date=2022 |website= |publisher= |access-date=22 November 2023 |quote= }}
* {{cite web |url=https://wcag.com/legal/|title=Accessibility and the Law |last=WCAG |first= |date=2023 |website=wcag.com|publisher=eSSENTIAL Accessibility |access-date= 2023-10-26 |quote= }}
* {{cite book |last=Zeleznik |first=J. M. |last2=Burnett |first2=R. E. |last3=Benson |first3=P. J. |date=1999 |title=Technical Writing: What It Is and How to Do It |url= |location= |publisher=National Book Network |pages=107 |isbn= |author-link= }}

{{Refend}}

[[Category:Fall 2023]]
[[Category:ENGL 5106]]

Technical Writing in the Digital Age

2023-11-28T20:13:57Z

APitts: /* Digital Technologies Tools */ citation needed

'''Technical Writing in the Digital Age''' represents the dynamic and evolving discipline of creating written materials that convey complex information, instructions, and technical concepts in the context of contemporary digital technologies. Its purview encompasses the creation, dissemination, and management of technical documents and content within an expansive digital landscape. Connected networks of workstations, laptops, cell phones, tablets, and servers are the central nervous system in the technical workplace.

Major considerations revolve around adapting traditional principles of rhetoric to digital platforms, ensuring effective communication in an era of rapid technological advancements. 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. In essence, technical writing in the digital age encapsulates the art and science of conveying technical information in a manner that is comprehensible and accessible to diverse audiences in our digitally driven society.

==Overview==

=== Aims of Technical Communication ===
Technical communication is a discipline utilized by various fields like education, business, and science. In any domain, technical documentation shares a common objective: assisting the audience in achieving a task or goal.{{sfn|Markel|Selber|2019}} This common objective is achieved by the technical writer developing the ability to communicate complex and technical information more easily to the audience.{{sfn|United States Bureau of Labor Statistics|2023}}

=== 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.

==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.{{Citation needed}}

Advances in technology thrust the technical writing profession into a new era. The technical writer's work 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}}

==Features of Technical Communication==
Technical communication involves conveying complex information to a specific audience. Key features include accuracy, attention to detail, visuals, and clear and concise organization to enhance user understanding.{{sfn|Smirti|2022}}

=== Accuracy ===

==== Standards Compliant ====
Many technical fields have industry-specific regulations and guidelines which are determined by governing bodies, and also impact their technical communication. Furthermore, many organizations may have a style guide that outlines preferred language usage, tone, and formatting.{{sfn|Smirti|2022}}

==== Detail-Oriented ====
Technical communication should be detail-oriented and free of errors and inconsistencies. Accurate information that is delivered with precision and specificity is essential to providing communication that is unambiguous and free of discrepancies.{{sfn|Smirti|2022}}

==== Objective ====
Objective communication is presented in an unbiased and impartial manner and is free of personal opinions. It relies upon facts and evidence and avoids an overly emotional tone. This approach is particularly important in fields where accuracy and impartiality are essential.{{sfn|Detwiler|2021}}

===== Clear and Concise =====
Technical communication should be logically organized, straightforward, and easily understood by the target audience. The language used should avoid needless jargon and be written in a manner that avoids redundant word usage and/or excessive explanations.{{sfn|Smirti|2022}}{{sfn|Proofed Editors|2020}}

=== Soundness ===

==== Formatted and Organized ====
Technical documents should be formatted in a way that is consistent with the norms and standards of applicable professional fields. Additionally, formatting should adhere to guidelines that enhance usability. Information should be logically organized for easy reading comprehension. This may involve using headings, subheadings, bullet points, and numbered lists. Formatting details should remain consistent throughout the document.{{sfn|Smirti|2022}}{{sfn|Proofed Editors|2020}}

==== Graphical ====
Technical communication utilizes visuals strategically to facilitate understanding of textual content. Visuals such as diagrams, charts, graphs, or images can enhance understanding of a technical document. When presented properly, visuals can explain difficult concepts and make material accessible to a more diverse audience.{{sfn|AI and the LinkedIn Community|2023}}

=== Appropriateness ===

==== Audience-specific ====
Where possible, technical communication should be customized to align with the knowledge and needs of its audience. Communication style and tone should be tailored to match the audience's level of expertise and should take into consideration such factors as the users' technical background, familiarity with the subject, and specific requirements.{{sfn|Viral Nation|2019}} The tone sets the overall mood for the piece.

====Document Design====
Documents' appropriateness requires that readers can quickly understand the message of the document. The document should be of appropriate style and length for the readers' needs.

==Personas in Digital Writing==
Personas in the context of digital writing, which is writing composed, created and read in digital environments, refer to semi-fictional characters that encapsulate the characteristics, behaviors, and needs of target audience segments. They align closely with the principles of user-centered design (UCD).{{sfn|Lucas|2023a}} There are myriad ways to integrate user-centered thinking into the creative process of UX design, and personas are one of the most effective ways to empathize with and analyze users.{{sfn|Goltz|2014}}

Personas may guide the creation of documentation and tutorials catering to different user needs. It is crucial to adjust the language and tone to match the persona preference. Different personas can influence and guide the design of the project.

==Rhetorical Strategies in the Digital Age==
[https://en.wikipedia.org/wiki/Rhetoric Rhetoric] is a communication strategy whose primary goal is to persuade an audience. It is grounded in three foundational concepts first defined by the Greek philosopher Aristotle. These concepts are ''logos'', which engages with the reader’s sense of logic or reason; ''pathos'', which appeals to the reader’s emotions; and ''ethos'', which addresses the audience’s values and the writer’s credibility. Within this framework, writers utilize specific techniques or devices to influence and engage readers. Examples include appealing to an audience’s sense of logic by using factual examples to support a point or evoking emotion through descriptive visual language.{{sfn|Gagich|Zickel|n.d.|pp=34-37}}

In today’s digital age, writers can use digital technologies as rhetorical devices to influence the reader. Electronic images and informational graphics can be incorporated into digital and online documents to illustrate or reinforce points made in the text.{{sfn|Markel|Selber|2019}} [[#Hyperlinking|Hyperlinks]] can provide access to additional information that supports authors’ ideas and enhances their credibility.{{sfn|Lucas|2023g|}} Nevertheless, the writer's basic task of informing and persuading an audience is the same in digital communication as in other forms of writing.{{sfn|DeVoss|National Writing Project|Eidman-Aadahl|Hicks|2010|p=105}}

Digital writers must therefore consider specific elements that compose the rhetorical context in which texts are created and delivered. Such elements may include evaluating the demographics, habits, and needs of an intended audience; determining the overall objective of the communications; and deciding what technologies will be used to create the content. Together, this analysis allows writers to craft messages that both appeal to and inform the target audience. In the digital age, such rhetorical messages may be conveyed through websites, social media, and other digital platforms.{{sfn|Lawrence|2022|pp=6-14}}

==Digital Technologies Tools==
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}}

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

=== Content Management Systems (CMS) ===
A content management system (CMS) is a software application that allows users to create, manage, and modify digital content on a website. It provides a user-friendly interface and tools to easily organize, publish, and update content, including text, images, videos, and documents. Additionally, CMSs often offer features like user permissions, version control, and Search Engine Optimization (SEO) to enhance the overall website management experience.{{sfn|Carroll|2006|p=129}} Some popular examples of CMS include [https://wordpress.com/ WordPress], [https://www.wix.com/ Wix], and [https://www.blogger.com/about/?bpli=1 Blogger].

=== Image Processing Software ===
Image processing software plays a valuable role in technical and digital writing by facilitating the creation and enhancement of visuals. Documentation and tutorials help optimize images to convey processes or procedures effectively. Whether for screen captures illustrating software interfaces, data visualizations, or graphics for digital content, image processing tools contribute to creating clear and visually appealing materials.{{sfn|Robbins|2018|p=664}} These tools, such as [https://www.adobe.com/ Adobe] and [https://www.canva.com/ Canva], enhance the visual impact of technical and digital writing, ensuring that images are optimized, informative, and engaging for the audience.

=== Word Processors ===
Word processors are software applications designed for creating, editing, and formatting documents on a computer. They provide many features, such as spell-checking, grammar-checking, and inserting images and tables. These programs are typically used for writing essays, creating reports, or drafting professional documents.{{sfn|Carroll|2010|p=229}} Some popular software applications are [https://www.microsoft.com/en-us/microsoft-365/word Microsoft Word], [https://www.google.com/docs/about/ Google Docs][https://www.microsoft.com/en-us/microsoft-365/sharepoint/collaboration , SharePoint], and [https://www.apple.com/pages/ Apple Pages]. These programs allow documents to be readily disseminated. Comment capability enables audience members to interact about a document with one another and the author.

=== 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.

== 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}}

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

=== Case Studies ===
Case studies are a form of empirical or observational research that consists of in-depth examination of distinct individuals, groups, events, or scenarios. This research can be used to generate qualitative or quantitative data.{{sfn|Johnson-Sheehan|2018|pp=401-404}}

=== Data Sheets ===
A data sheet, also known as a technical datasheet, is a document used to describe and summarize the characteristics of a product, material, component, or technology.{{sfn|IDA|2020|p=}}

=== 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}}

*Product: provides detailed information about a specific item, including its features, specifications, and benefits.
*Process: provides step-by-step instructions on how to perform a particular task or achieve a specific outcome.

=== Documentation ===
Documentation comprises various texts that allow users to accomplish tasks or gain information. It generally falls into three categories, which can be defined as follows:
* Instructions: Text that describes how to complete a task, often offering numbered steps. Examples include how to download software or assemble a product.{{sfn|Balzotti|2022|p=167}}
* Specifications: Communications that deliver technical details on how a product is put together or a specific operation is executed. Also known as "specs," these texts may be written by engineers or technicians.{{sfn|Johnson-Sheehan|2018|p=205}}
* Procedures and Protocols: Guidelines to ensure consistency, quality, and safety in the workplace. For example, a hospital may provide staff with procedures on how to adapt operations during an emergency, such as a power outage.{{sfn|Johnson-Sheehan|2018|p=205}}

=== Email ===
Emails are the primary form of communication in the workplace, used for both internal and external communication. They facilitate information exchange, idea exchange, and activity coordination.{{sfn|Lannon|Gurak|2020|p=335}} Emails should be brief, concise, readable, and targeted to specific audiences with specific subject lines.{{sfn|Lannon|Gurak|2020|p=348}}

=== Letters ===
Letters are a traditional form of communication most often used by employees to communicate with individuals outside of a company or organization. They are typically written on company letterhead. Today, letters are sent either by U.S. mail or electronically.{{sfn|Johnson-Sheehan|2018|p=139}}

=== Memos ===
A memo (short for memorandum) is an official communication, usually a message from the company, a manager or director, or another person or group acting in an official capacity, used to communicate with others within the same organization.{{sfn|Lannon|Gurak|2020|p=353}}

=== 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}}

=== Proposals ===
A proposal is a document that identifies an existing problem or opportunity and outlines a comprehensive strategy for addressing it. Organizations create ''internal'' proposals to describe programs and projects that meet specific operational needs, such as a plan to replace an outdated software system. Companies develop ''external'' proposals for potential customers or clients. These documents detail new products, services, or initiatives that a company will implement to address a specific customer concern.{{sfn|Johnson-Sheehan|2018|p=245}}

=== Reports ===
A report is a concise, easily understandable document that presents technical information in a clear, organized format, allowing readers to access varying levels of information. Reports are categorized as informal, such as briefs, and formal, such as research, scientific, and completion reports.{{sfn|Johnson-Sheehan|2018|loc=chpt 10 & 11}}

==== Informal or Brief Reports ====
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.
* 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.
* Laboratory Reports describe experiments, tests, or inspections.

==== Formal Reports ====
A formal report is a factual and data-driven response to a research question.
* Research reports present the findings of a study.
* Scientific research reports outline the process, progress, and results of technical or scientific research or the current state of a research problem.
* Completion reports assess the outcomes of a project or initiative and provide feedback to management or the client.

=== 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.

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}}

=== 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}}

==Search Engine Optimization (SEO)==
SEO refers to the practice of optimizing online content to enhance its visibility and ranking on search engine results pages (SERPs), making it a crucial skill for digital writers.{{sfn|Lucas|2023b}} To optimize content for SEO means to have the goal of SEO in mind at the time of designing, creating, and writing a web page for publication. Using keywords and alt-text are two examples of optimizing content for SEO.{{sfn|Barr|2010|loc=chpt. 17}}

===Keywords===
Keywords are the words that search engines crawl a website for and index as the page's most important words. Based on other pages using the same keywords, the website is added into the search engine results pages from best matches to worst matches. The position of a website in search results is influenced by where it ranks on a scale determined by the keywords that a user searches for.{{sfn|Lucas|2023b}} To optimize a website's keywords, you should begin with researching keywords on your own website and ensure that you have an XML [https://en.wikipedia.org/wiki/Sitemaps sitemap] so search engines such as [https://en.wikipedia.org/wiki/Google Google] can crawl your web pages for updated information. In addition to using keywords, updating a page's metadata information can also help with showing up on SERPs. Using title and header tags as well as meta descriptions for content also helps optimize a website's ratings in SERPs.{{sfn|Lucas|2023b}}

===Alt-Text===
Alt-Text (alternative text), or [https://en.wikipedia.org/wiki/Alt_attribute Alt Attributes], is a practice that increases the usability and accessibility of a web page for users. Alt-Text is often used for visual elements that cannot be displayed in a different format but still provides description of the element for screen readers or users that may have a disability. Alt-Text also improves a website's SEO as a form of content optimization.{{sfn|Lucas|2023b}}

===Social Media Presence===
Sharing content from a website across different social media platforms is another way to create SEO optimization. This technique can help with being seen as legitimate and improves visibility of the website overall. Additionally, it can drive traffic and enables back-linking to occur when other websites have the ability to also link to the website.{{sfn|Lucas|2023b}}

=== Goals of Searching: The User's Perspective===
A user of search engines formulates queries by using keywords or posing questions. One of the most important elements of building an SEO strategy for a website is developing a thorough understanding of the psychology of your target audience and how they use words and concepts to obtain information about the services and/or products you provide. Once you understand how the average search engine user—and, more specifically, your target audience—utilizes query-based search engines, you can more effectively reach and keep those users.{{sfn|Enge|Spencer|Stricchiola|2022|p=9}}

==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}}

===Characteristics of Digital Documents===

====Electronic Format ====
Digital documents exist in electronic formats, which means they are stored and transmitted as binary data. This format allows for efficient storage, retrieval, and transmission of information via electronic devices.{{sfn|Lucas|2023c}} Digital documentation is the only method to meet a critical challenge of the relatively new concept of "knowledge management" that applies to all organizations. A digital knowledge management system is crucial to an organization so everyone can access information created by employees who are no longer with the organization or to allow cross-referencing with other seemingly unrelated departments.{{sfn|IBM}}

====Non-Tangible====
Unlike paper documents, digital documents lack physical presence. They are intangible and exist as electronic files, residing on devices or in the cloud.{{sfn|Lucas|2023c}}

====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}} It is a legal requirement to include accessibility features in website design.{{sfn|WCAG|2023}} It is also ethically imperative to make sure there is accessibility in digital writing. 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}} Accessibility broadens the reach of digital content and reaches a wider audience. This is important for technical writers, as their documentation and instructions are critical resources for users of varied abilities.

====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|Burnett|Benson|1999|p=207}} The other four Cs are coherent, concrete, correct and complete.{{sfn|Last|2019}}

====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 implementing visual elements, white space, concise language, highlighting, and emphasis.

====Ease of Reproduction and Distribution====
Digital documents are easily copied and distributed. They can be duplicated without any loss of quality, making it simple to share information widely and at minimal cost.{{sfn|Lucas|2023c}}

====Hyperlinking ====
Hyperlinking is a quick and efficient method for directing readers to relevant information in digital documents, facilitating seamless navigation between sections, references, and external resources.{{sfn|Carroll|2010|p=79}}

====Multimedia====
Digital documents can incorporate multimedia elements like images, audio, video, and interactive content, enhancing engagement through visual and auditory elements. Multiple media formats work best when sharing new, complicated ideas.{{sfn|Carroll|2010|p=36}} Increasing multimodality on a website improves engagement, usability, and accessibility. This can improve the impact of the website's standings in SERPs.{{sfn|Carroll|2010|p=280}}

====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}}

====Remote Collaboration====
One form of collaborative technical writing is a wiki, which is a "website developed collaboratively by a community of users, allowing any user to add and edit content."{{sfn|Lucas|2021}} One of the predominant elements of a wiki is that it is defined as being open source. As a result, anyone can modify it regardless of their geographic locations.

====Security Measures====
Digital documents can be protected with encryption, passwords, and access controls to safeguard sensitive information. These security measures enhance data protection and privacy.{{sfn|Lucas|2023c}}

====Environmental Impact====
Digital documents have a smaller environmental footprint compared to paper documents, as they reduce the need for paper production, printing, and transportation.{{sfn|Lucas|2023c}}

====Dynamic Updates====
Online digital documents can be updated dynamically, ensuring that users always have access to the most current information. This is particularly valuable in fast-changing fields.{{sfn|Lucas|2023c}}

====Global Accessibility====
Digital documents can be shared globally, transcending geographical boundaries and time zones. They support international collaboration and the dissemination of knowledge on a global scale.{{sfn|Lucas|2023c}}

====Data Integration====
In business and research settings, digital documents can integrate with databases and data analysis tools. This integration streamlines data collection, analysis, and reporting processes.{{sfn|Lucas|2023c}}

====Data Analytics ====
Digital documents can be subjected to data analytics techniques, allowing organizations to extract valuable insights from large volumes of textual data, which can inform decision-making and strategy.{{sfn|Lucas|2023c}}

==Examples of Digital Documents==
In technical and professional writing, digital documentation takes various forms. These methods streamline the sharing of technical information, enhance collaboration, and ensure easy accessibility within professional settings, contributing to efficient communication and knowledge dissemination.

=== Infographics ===
Infographics, shared as digital documents, typically combine text, graphics, and illustrations to convey complex concepts or data in a concise and visually appealing format. Infographics are often used to simplify information, making it more accessible to a broader audience, and are found in presentations, reports, websites, and educational materials.{{sfn|Lannon|Gurak|2020|pp=292-293}}

=== Presentations ===
Presentations created with [https://en.wikipedia.org/wiki/Microsoft_PowerPoint PowerPoint] or [https://en.wikipedia.org/wiki/Google_Slides Google Slides] are vital for professional communication and knowledge sharing. They condense complex information into visually appealing slides for effective presentations by using photos, videos, graphics, charts, and graphs.{{sfn|Parkinson|2018|loc=chpt. 4}}

=== Blogs ===
A blog, short for "weblog," is an informational website organized into short articles called posts, typically chronologically ordered series of website updates, written and organized similar to a traditional diary.{{sfn|Bair|2014|p=7}} They are regularly updated, providing readers with insights on a specific topic or subject. Blogs serve various purposes, including sharing opinions, providing news, offering educational content, and documenting personal experiences.{{sfn|Rose|Garret|2012|p=2}}

==User Experience==
User experience (UX) is how a product works from the perspective of the user. Digital documents can be created with efficient user experiences by practicing several design methods, including user-centered design, information architecture, responsive design, and usability.

===User-Centered Design===
The approach of user-centered design (UCD) in technical writing consists of the following methodology{{sfn|Lucas|2023e}}:

* User Research: the act of conducting thorough research through surveys, interviews, and usability testing to gain a better understanding of user needs and experiences when using a digital document
* Ideation and prototyping: the process of creating digital designs and prototypes to assist with exploring possible solutions to meet user needs
* Usability testing: the act of having users interact with digital document designs and recording and adjusting the design based on user feedback
* Implementation: the stage in which the design is implemented after making adjustments from prior testing
* Evaluation: the stage in which the digital document is assessed to ensure that it is meeting user needs
* Maintenance and updates: to maintain a digital document based on user feedback and changing needs

===Information Architecture===

To ensure a digital document has effective UX design and accessible information, technical writers need to construct a clear and organized information architecture (IA). IA is a design principle that organizes information so that it is easily found and understood by users, prioritizing their needs and reducing information overload. A design challenge is making IA understood across multiple digital experiences, changing the navigation structure to fit different medias while staying logical and consistent for the user.{{sfn|Rosenfeld|pp=1, 17-18}} IA that is not constructed well can confuse the user and could cause them to give up their search of information in frustration.{{sfn|Garrand|pp=12}}

The architecture components of IA can be divided into four different categories:{{sfn|Rosenfeld|pp=90}}

*Organization systems: how information is categorized and organized for user understanding

*Labeling systems: how information is represented

*Navigation systems: how users browse information and navigate between pages

*Searching systems: how users search for specific information

=== Responsive Design ===

Responsive design is a strategy that appropriately updates the layout and content of a website or document in relation to the screen size, device, and/or orientation, allowing the site or document to be easily viewed and navigated regardless of device used. With the increased use of mobile devices, web content should be constructed with proper responsive web design (RWD) to ensure effective UX and usability on those devices.{{sfn|Robbins| pp=485}}

There are several design strategies that can be implemented that will increase the success of RWD:{{sfn|Robbins| pp=487}}

*Fluid layout – Responsive sites can be constructed using a fluid layout (or flexible grid) system that will allow content to adjust and flow according to the available screen space.

*Flexible and responsive images – Images and other embedded media can be instructed so that they fit their containers instead of remaining at a fixed size. Images with varying resolutions can also be swapped according to screen size to avoid high-resolution images on smaller devices.

*CSS media queries – Media queries can be written into the CSS (Cascading Style Sheet), which would instruct the construction of the site according to screen width and orientation. Adding breakpoints for several screen sizes allows pages to be designed for specific devices.

*Content hierarchy – Carefully constructing content that is organized for the user and creating a hierarchy of content that prioritizes user needs is necessary to ensure effective user experience and navigation across multiple screen sizes.{{sfn|Robbins| pp=499}}

===Usability===

Technical writers must create documents and websites that meet the expectations of their readers and users, and in doing so, writers increase the usability of their site or document.{{sfn|Garrand|pp=26}} Usability can be applied with visual aids, clear and concise language, and structured design.

==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|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|Society for Technical Communication|2023a}} The STC promotes adherence to a list of ethical principles. They are legality, honesty, confidentiality, quality, fairness, and professionalism.{{sfn|Society for Technical Communication|2023b}}

Technical communicators also have to be careful to avoid plagiarism, or taking ideas, thoughts, or words from someone else and passing them off as one's own.{{sfn|Carroll|2010|p=280}}

Technical communicators have ethical standards to which they must abide. The standards are divided into three primary categories. They are the employer, the public, and the environment.{{sfn|Markel|2009}}

===The Employer===
Obligations to one's employer include competence and diligence, honesty and candor, confidentiality, and loyalty.{{sfn|Markel|2009}} The technical communicator must adhere to these obligations so that he/she does not harm the reputation or operation of the employer.

Technical communicators may occasionally work for an organization with strict privacy policies that prohibit them from using the documents they create outside of the organization. It is important for ethical communicators to follow the privacy policy for their organization because unauthorized release of information could lead to consequences up to and including termination.{{sfn|Balzotti|2022|p=83}}

=== The Public===
Organizations are obligated to treat customers fairly. Technical communicators must convey that the products or services an organization sells are safe and effective.{{sfn|Markel|2009}}

===The Environment===
Technical communicators have an obligation to the environment. This obligation includes alerting their supervisors, managers, and executive leadership to products or processes that are detrimental to the environment. Protecting the environment can be costly, however, and organizations may consider ignoring legal guidelines to save money.{{sfn|Markel|2009}} Yet, failure to adhere to U.S. Environmental Protection Agency regulations also has financial implications. For example, the penalty for mishandling hazardous waste is five years and/or up to $50,000 for each day of the violation.{{sfn|EPA|2023}}

=== Disinformation ===
One major ethical concern in all forms of writing, but especially in digital writing, is the creation and spread of disinformation. Disinformation, often referred to as "[[w:Fake news|fake news]]," is information that is purposefully spread as false or misleading and is a sub-type of misinformation.{{sfn|Lawrence|2022|loc=section 3.7}} Modern communication technologies allow for the spread of information to occur at a fast pace. Social media is one area where the spread of disinformation occurs regularly.

Some social media sites, such as Facebook, have begun to flag certain articles posted on the site as being questionable in their representation of facts or occurrences. Despite the widespread understanding and use of disinformation available today, digital writers need to be aware of their intent and the audience's needs and wants from their digital communication.{{sfn|Lucas|2023f}} Ethical considerations regarding citing sources, cross-referencing information, and using primary sources are good practices for maintaining ethical standing and credibility as a digital writer.

To help mitigate the problem of disinformation, technical writers should utilize gatekeepers. These individuals verify the accuracy of the information before it is distributed to primary readers. This helps protect the author from any ethical and/or legal issues.{{sfn|Balzotti|2022|p=83}}

==Pedagogical Approaches==
===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}}

===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}}

===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}}

==Future Trends and Challenges==
=== Future Trends===
Between 2022 and 2032, the [https://en.wikipedia.org/wiki/Bureau_of_Labor_Statistics, United States Bureau of Labor Statistics] is projecting a 7% job growth for technical writers.{{sfn|United States Bureau of Labor Statistics|2023}} To be relevant as a technical writer in the digital age, one must possess the skills of conducting in-depth research, critical thinking, being detail oriented, design, and technical expertise. To succeed at communicating the complex to specific audiences, the technical writer must understand much of the subject in its complexity. This is accomplished through possessing the skills of communication, collaboration, and teamwork.{{sfn|Fechter|2023}}

===Challenges===
Barriers to teaching technical communications include the speed at which digital tools evolve, the complexity of software,{{sfn|Hovde|Renguette|2017|pp=395-411}} and the dependency on input information accuracy. Outdated, incorrect, or inconsistent data delays the publication, requires more reparative efforts, and decreases productivity.{{sfn|Ajose-Coker|2022}} Also, technical writers often have to contend with complex, outdated or unsuitable tools. This can make their job more difficult and time-consuming, and can lead to frustration and errors.{{sfn|Ajose-Coker|2022}}

===Artificial Intelligence===
Artificial intelligence programs, utilizing natural language processing, are capable of producing technical writing and have advanced in recent years becoming more adept.{{sfn|Marr|2023}}

One such program is [https://en.wikipedia.org/wiki/ChatGPT ChatGPT], which uses machine learning to produce texts with human-like style and tone.{{sfn|University of Central Arkansas|2023}} Another leader in this area, Contentbot, uses a WordPress plugin which gives blog writers ideas to enhance their posts which are shared via email.{{sfn|Siddiqui|2022}}

===Plagiarism===
Because of the ability of chatbots to imitate human-like language, some education administrators have taken precautions to minimize the occurrence of students passing off artificially generated texts as their own. In some instances, educators have taken the view that material drawn from artificial intelligence software must be handled in the same way as sources from human authors.{{sfn|Klein|2023}} In such cases, students who incorporate artificially generated text into their work have been made to denote credit for the artificial intelligence program utilized.

===Credit ===
The advent of chatbots has complicated the issue of credit where creative work is concerned. Because chatbots can simulate human speech, their ability to create cinematic dialogues and other types of creative writing have threatened the credits and financial condition of professional writers. According to an article by Aaron Mok and Jacob Zinkula on ''[https://www.businessinsider.com/ Business Insider]'', writing jobs are among the top 10 roles that AI is most likely to replace.{{sfn|Mok|2023}}

==References==
===Citations===
{{Reflist}}

===Bibliography===
{{Refbegin|30em}} 
* {{cite web |url=https://www.linkedin.com/advice/0/how-can-you-create-effective-visual-aids-1c |title=How Can You Create Effective Visual Aids for Technical Writing? |last=AI and the LinkedIn Community |date=2023 |website=www.linkedin.com |publisher=LinkedIn |access-date=2023-11-05 }}
* {{cite web |url=https://componize.com/common-problems-in-technical-writing-and-how-to-resolve-them/ |title=Common Problems in Technical Writing and How to Solve Them |last=Ajose-Coker |first=Dipo |date=2022 |website=componize.com |publisher=Componize Software |access-date=2023-11-19 }}
* {{cite book |last=Bair|first=Amy Lupold |date=2014 |title=Blogging for Dummies|url=|location=Hoboken, NJ |publisher=Jon Wiley & Sons, Inc|pages=|isbn=|author-link= }}
* {{cite book |last=Balzotti |first=Jon |date=2022 |title=Technical Communication: A Design-Centric Approach |edition= 2nd |url= |location=New York |publisher=Routledge |isbn=9780367438302 }}
* {{cite book |last=Barr |first=Chris |date=2010 |title=The Yahoo! Style Guide |url= |location=New York |publisher=St. Martin's }}
* {{cite book |last=Carroll |first=Brian |date=2010 |title=Writing for Digital Media |url= |location=New York |publisher=Routledge }}
* {{cite book |last1=Coco |first1=Pete |last2=Torres |first2=M. Gabriella |date=2014 |editor-last1=Dougherty |editor-first1=Jack |editor-last2=O'Donnell |editor-first2=Tennyson |title=Web Writing: Why and How for Liberal Arts Teaching and Learning |publisher=University of Michigan Press |pages=175-188 |chapter=“Writing as Curation: Using a ‘Building’ and ‘Breaking’ Pedagogy to Teach Culture in the Digital Age" |chapter-url=https://epress.trincoll.edu/webwriting/chapter/cocotorres |ref=harv }}
* {{cite web |url=https://www.betonconsultingeng.com/objectivity-in-technical-writing/#:~:text=Pointers%20for%20objective%20technical%20writing%201%20If%20you,5%20Remember%20that%20correlation%20is%20not%20causality.%20 |title=Objectivity in Technical Writing |last=Detwiler |first=Rachel |date=2021 |website=www.betonconsultingeng.com |publisher=Beton Consulting Engineers L.L.C. |access-date=2023-11-05 }}
* {{cite book |last=DeVoss |first=Danielle |last2=National Writing Project |last3=Eidman-Aadahl |first3=Elyse |last4=Hicks |first4=Troy |date=2010 |title=Because Digital Writing Matters: Improving Student Writing in Online and Multimedia Environments |location=San Francisco |publisher=Jossey-Bass |pages=105 |isbn= |url=https://openlibrary.org/books/OL34593323M/Because_Digital_Writing_Matters }}
*{{cite book |last=Enge |first=Eric |last2=Spencer |first2=Stephan |last3=Stricchiola |first3=Jessie |date=2022 |title=The Art of SEO: Mastering Search Engine Optimization |url=https://archive.org/details/artofseomasterin0000enge |location=Sebastopol, CA |publisher=O'Reilly |pages=9 }}
* {{cite web |url=https://www.epa.gov/enforcement/criminal-provisions-resource-conservation-and-recovery-act-rcra |title=Criminal Provisions of the Resource Conservation and Recovery Act (RCRA) |date=2023 |publisher=United States Environmental Protection Agency }}
* {{cite web |url=https://technicalwriterhq.com/career/technical-writer/technical-writing-skills/ |title=Essential Technical Writing Skills |last=Fechter |first=Josh |date=2023 |website=technicalwriterhq.com |access-date=2023-11-21}}
* {{cite book |last=Gagich |first=Melanie |last2=Zickel |first2=Emilie |date=n.d. |title=Writing Arguments in Stem |chapter=Rhetorical Appeals: Logos, Pathos, and Ethos Defined |publisher=Digital Commons |url=https://digitalcommons.calpoly.edu/cgi/viewcontent.cgi?article=1000&context=oercoursematerials#page=44 |location= |pages=34-37 }}
* {{cite book |last=Garrand |first=Timothy |date=2006 |title=Writing for Multimedia and the Web: A Practical Guide to Content Development for Interactive Media |edition=3rd |location=Burlington, MA |publisher=Focal Press |ref=harv }}
* {{cite book |last=Garrett |first=Jesse James |title=The Elements of User Experience: User-Centered Design for the Web and Beyond |publisher=New Riders |edition=2nd |date=2011 |location=Berkeley, CA |page=17 }}
* {{cite book |last=Godson |first=Williams|title=Web Design with HTML and CSS |p=37-41}}
* {{cite web |url=https://smashingmagazine.com/2014/08/a-closer-look-at-personas-part-2/ |title=A Closer Look at Personas: A Guide to Developing The Right Ones (Part 2) |last=Goltz | first=Shlomo |date=2014 |website=smashingmagazine.com |publisher=Smashing Media AG |access-date=2023-11-13 }}
* {{cite magazine |last=Grimstead |first=Deborah M. |date=1999 |title=Technical Writers are in Demand: Do You Have The Right Stuff? |magazine=Black Collegian |pages=128 }}
* {{cite journal |last1=Hovde |first1=Marjorie |last2=Renguette |first2=Corinne |date=2017 |title=Technological Literacy: A Framework for Teaching Technical Communication Software Tools |journal=Technical Communication Quarterly |volume=26 |pages=395-411 |doi=10.1080/10572252.2017.1385998}}
* {{cite web |url=https://www.ibm.com/topics/knowledge-management |title=What is Knowledge Management? |first= |last=IBM |website=ibm.com |access-date=2023-11-24}}
* {{cite web |url=https://www.idassoc.com/product-information-definition/data-sheet |title=Product Information Encyclopedia |last=IDA |first= |date=2020 |website=Industrial Data Associates |publisher= |access-date=2023-11-20 |quote= }}
* {{cite book |last=Johnson-Sheehan |first=Richard |title=Technical Communication Today |url= |edition=6 |location=Boston, MA |publisher=Pearson |date=2018 |pages= }}
* {{cite news |last=Klein |first=Alyson |date=2023 |title=ChatGPT Cheating: What to Do When It Happens |url=https://www.edweek.org/technology/chatgpt-cheating-what-to-do-when-it-happens/ |work=Education Week |location=Bethesda, MD |access-date=2023-11-05 }}
* {{cite book |last=Krug |first=Steve |date=2014 |title=Don’t Make Me Think, Revisited|url= |location=Berkeley, CA |publisher=New Riders |pages= |isbn= |author-link= }}
* {{cite book |last=Lannon |first=John M. |last2=Gurak |first2=Laura J. |date=2020 |title=Technical Communication |edition=15 |url= |location= |publisher=Pearson Education |page= }}
* {{cite book |last=Last|first=Susan |date=2019 |title=Technical Writing Essentials|url=https://pressbooks.bccampus.ca/technicalwriting/chapter/communicatingprecision/|location= |publisher= Victoria, B.C. University of Victoria |pages= |isbn= |author-link= }}
* {{cite book |last=Lawrence |first=Dan |date=2022 |title=Digital Writing: A Guide to Writing for Social Media and the Web |location=Peterborough, Ontario, Canada |publisher=Broadview Press |page=85 }}
* {{cite web |url=https://grlucas.net/grl/Writing_on_a_Wiki |title=Writing on a Wiki |last=Lucas |first=Gerald| date=2021| website=grlucas.net| publisher=MediaWiki| access-date=2023-10-31 }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Personas |title= Using Personas in Digital Writing
|last=Lucas |first=Gerald |date=2023a| website=grlucas.net |publisher=MediaWiki |access-date=2023-11-07 }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/SEO |title=Search Engine Optimization: Strategies and Best Practices for Effective Online Visibility |last=Lucas |first=Gerald |date=2023b |website=grlucas.net |publisher=MediaWiki |access-date=2023-11-19 }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Documents|title=Exploring the Dichotomy: A Comparative Analysis of Digital and Paper Documents |last=Lucas |first=Gerald |date=2023c |website=grlucas.net |publisher=MediaWiki |access-date=2023-10-29 |quote= }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Design/Users |title=User-Centered Design in Digital Documents |last=Lucas |first=Gerald |date=2023d |website=grlucas.net |publisher=MediaWiki |access-date=2023-11-15 |quote= }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Style |title=Audience-Centric Style in Digital Writing |last=Lucas |first=Gerald |date=2023e |website=grlucas.net |publisher=MediaWiki |access-date=2023-10-22 |quote= }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Credibility |title=The Significance of Credibility in Digital Writing |last=Lucas |first=Gerald |date=2023f |website=grlucas.net |publisher=MediaWiki |access-date=2023-11-21 }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Tech_Writing |title=Combining Disciplinary Approach to Technical Writing with Digital Writing: Enhancing Communication in the Digital Age |last=Lucas |first=Gerald |date=2023g |website=grlucas.net |publisher=MediaWiki |access-date=2023-11-27 |quote= }}
* {{cite web |url=https://www.indeed.com/career-advice/careers/what-does-a-technical-writer-do |title=What Does a Technical Writer Do? (Plus How To Become One) |last=Macari |first=Sabina |date=2023 |website=indeed.com |publisher=Indeed |access-date=2023-11-05 }}
* {{cite magazine |last=Malone |first=Ed |date=2008 |title=Joseph D. Chapline: Technical Communication's Mozart |url=https://web.mst.edu/~malonee/chapline.pdf |magazine=IEEE Professional Communication Society Newsletter |access-date=2023-10-31 }}
* {{cite journal |last=Malone |first=Edward |date=November 2011 |title=The First Wave (1953-1961) of the Professionalization Movement in Technical Communication |url=https://www.stc.org/techcomm/wp-content/uploads/sites/3/2016/08/november-2011-58-4.pdf |journal=Technical Communication |volume=58 |issue=4 |pages=285-306 |doi= |access-date=2023-10-11 }}
* {{cite book |last=Markel |first=Michael |title=Technical Communication |date=2009 |edition=9th |location=Boston |publisher=Bedford/St. Martin's |pages=22-25 }}
* {{cite book |last=Markel |first=Mike |last2=Selber |first2=Stuart A. |date=2019 |title=Practical Strategies of Technical Communication |edition=3rd |url= |location=Boston |publisher=Bedford/St. Martin’s |page= }}
* {{cite web |url=https://www.forbes.com/sites/bernardmarr/2023/01/23/how-chatgpt-and-natural-language-technology-might-affect-your-job-if-you-are-a-computer-programmer/?sh=6d9acf79174b |title=How ChatGPT And Natural Language Technology Might Affect Your Job If You Are A Computer Programmer |last=Marr |first=Bernard |date=2023 |website=Forbes.com |publisher=Forbes Media |access-date=2023-10-31 |quote= }}
* {{cite web |url=https://www.businessinsider.com/chatgpt-jobs-at-risk-replacement-artificial-intelligence-ai-labor-trends-2023-02 |title=ChatGPT may be coming for our jobs. Here are the 10 roles AI is most likely to replace |last=Mok |first=Aaron |date=2023 |website=Insider |publisher=Business Insider |access-date= 2023-11-05 }}
* {{cite book |last=Mussack |first=Brigitte |date=2021 |title=Introduction to Technical and Professional Communication |url=https://pressbooks.umn.edu/techwriting/front-matter/introduction/ |location= |publisher=Creative Commons Attribution NonCommercial |pages=n.p. |author-link= }}
* {{cite book| last=Parkinson |first=Mike |title=A Trainer’s Guide to PowerPoint: Best Practices for Master Presenters| location=United States| publisher=Association for Talent Development| chapter=Chapter 4. PowerPoint Tips, Tricks, and Secrets| date=2018 }}
* {{cite book |last=Perelman |first=Leslie |date=1998 |title=The Mayfield Handbook of Technical and Scientific Writing |url=https://www.mit.edu/course/21/21.guide/ |location=Mountain View |publisher=Mayfield Publishing Company |pages=n.p. |isbn= |author-link= }}
* {{cite web |url=https://learn.g2.com/how-to-write-a-press-release |title=How to Write a Press Release That Catches People's Attention |date=2021 |last=Pradhan |first=Ninisha |website=learn.g2.com |publisher=G2.com |access-date=2023-11-21 }}
* {{cite web |url=https://proofed.com/writing-tips/a-beginners-guide-to-technical-writing/ |title=A Beginner’s Guide to Technical Writing |last=Proofed Editors |date=2020 |website=Proofed.com |publisher=Proofed |access-date=2023-11-05 }}
* {{cite journal |last=Rathbone |first=Robert |title=Growth of the technical writing profession |journal=STWE Review |volume=5 |issue=1 |date=1958 |pages=5-16 }}
*{{cite book |last=Robbins |first=Jennifer Niederst |date=2018 |title=Learning Web Design: A Beginner’s Guide to HTML, CSS, JavaScript, and Web Graphics (5th ed.) |url= |location=Sebastopol, CA |publisher= O’Reilly Media, Inc. }}
* {{cite book |last=Rose|first=Darren |last2=Garret |first2=Chris|date=2012 |title=ProBlogger: Secrets for Blogging Your Way to a Six-Figure Income|url=|location=Indianapolis, IN |publisher=Jon Wiley & Sons, Inc|pages=|isbn=|author-link= }}
* {{cite book |last1=Rosenfeld |first1=Louis |last2=Morville |first2=Peter |last3=Arango |first3=Jorge |date=2006 |title=Information Architecture for the Web and Beyond |edition=4th |location=Sebastopol, CA |publisher=O'Reilly Media, Inc.}}
* {{cite web |url=https://writingcooperative.com/intricacies-of-ai-tools-can-ai-tools-take-over-the-jobs-of-technical-writers-af36836f625c |last=Siddiqui |first=Zafar |title=Will Best Artificial Intelligence Take Over any Technical Content Writer? |date=2022 |website=writingcooperative.com |publisher=The Writing Cooperative |access-date=2023-11-19 }}
* {{cite web |url=https://www.managementnote.com/features-of-technical-communication/#google_vignette |title=Features of Technical Communication |last=Smirti |date=2022 |website=managementnote.com |publisher=Management Note |access-date= 2023-11-05 }}
* {{cite web |url=https://www.stc.org/about-stc/ |title=About STC |last=Society for Technical Communication |first= |date=2023a |website=stc.org |publisher= |access-date=2023-10-27 }}
* {{cite web |url=https://www.stc.org/about-stc/ethical-principles/ |title=Ethical Principles |last=Society for Technical Communication |first= |date=2023b |website=stc.org |publisher= |access-date=2023-10-27 }}
* {{cite web |url=https://www.bls.gov/ooh/media-and-communication/technical-writers.htm#tab-6 |title=Occupational Outlook Handbook |last=United States Bureau of Labor Statistics |first= |date=2023 |website=bls.gov |publisher=United States Department of Labor |access-date=2023-11-07 }}
* {{cite web |url=https://uca.edu/cetal/chat-gpt/ |title=Chat GPT: What is it? |last=University of Central Arkansas |first= |date= |website=uca.edu |publisher= University of Central Arkansas |access-date=2023-10-09 }}
* {{cite web |url=https://www.viralnation.com/blog/what-is-digital-content-creation-and-how-can-it-help-me-as-a-marketing-manager/#:~:text=A%20rule%20of%20thumb%20in%20digital%20content%20creation,turn%2C%20share%20it%20with%20others%20in%20their%20network. |title=What is Digital Content Creation? (and How Can It Help Me as a Marketing Manager) |last=Viral Nation |date=2019 |website=viralnation.com |publisher= Viral Nation |access-date=2023-11-05 }}
* {{cite web |url=https://www.w3.org/WAI/fundamentals/accessibility-intro/|title=Introduction to Web Accessibility |last=WAI |first=|date=2022 |website=W3.org|publisher= |access-date= 2023-10-26 |quote= }}
* {{cite web |url=https://scribehow.com/library/user-guide |title=What is a User Guide? Everything You Need to Know |last=Wainaina |first=Timan |date=2022 |website= |publisher= |access-date=22 November 2023 |quote= }}
* {{cite web |url=https://wcag.com/legal/|title=Accessibility and the Law |last=WCAG |first= |date=2023 |website=wcag.com|publisher=eSSENTIAL Accessibility |access-date= 2023-10-26 |quote= }}
* {{cite book |last=Zeleznik |first=J. M. |last2=Burnett |first2=R. E. |last3=Benson |first3=P. J. |date=1999 |title=Technical Writing: What It Is and How to Do It |url= |location= |publisher=National Book Network |pages=107 |isbn= |author-link= }}

{{Refend}}

[[Category:Fall 2023]]
[[Category:ENGL 5106]]

Technical Writing in the Digital Age

2023-11-28T18:59:20Z

APitts: /* Historical Context */ removed citation message

'''Technical Writing in the Digital Age''' represents the dynamic and evolving discipline of creating written materials that convey complex information, instructions, and technical concepts in the context of contemporary digital technologies. Its purview encompasses the creation, dissemination, and management of technical documents and content within an expansive digital landscape. Connected networks of workstations, laptops, cell phones, tablets, and servers are the central nervous system in the technical workplace.

Major considerations revolve around adapting traditional principles of rhetoric to digital platforms, ensuring effective communication in an era defined by rapid technological advancements. 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. The use of multi-modality and the interfacing of multiple media platforms and sources also plays a role in digital technical writing. In essence, technical writing in the digital age encapsulates the art and science of conveying technical information in a manner that is comprehensible and accessible to diverse audiences in our digitally driven society.

==Overview==

=== Aims of Technical Communication ===
Technical communication is a discipline present in various fields like education, business, and science. In any domain, technical documentation shares a common objective: assisting the audience in achieving a task or goal.{{sfn|Markel|Selber|2019}}

=== 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 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.{{Citation needed}}

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}}

==Features of Technical Communication==
Technical communication involves conveying complex information to a specific audience. Key features include accuracy, attention to detail, visuals, and clear and concise organization to enhance user understanding.{{sfn|Smirti|2022}}

=== Accuracy ===

==== Standards Compliant ====
Many technical fields have industry-specific regulations and guidelines which are determined by governing bodies and that also have an impact on their technical communication. Furthermore, many organizations may have a style guide that outlines preferred language usage, tone, and formatting.{{sfn|Smirti|2022}}

==== Detail-Oriented ====
Technical communication should be detail-oriented and free of errors and inconsistencies. Accurate information that is delivered with precision and specificity is essential to providing communication that is unambiguous and free of discrepancies.{{sfn|Smirti|2022}}

==== Objective ====
Objective communication is presented in an unbiased and impartial manner and is free of personal opinions. It relies upon facts and evidence and avoids an overly emotional tone. This approach is particularly important in fields where accuracy and impartiality are essential.{{sfn|Detwiler|2021}}

===== Clear and Concise =====
Technical communication should be logically organized, straightforward, and easily understood by the target audience. The language used should avoid needless jargon and be written in a manner that avoids redundant word usage and/or excessive explanations.{{sfn|Smirti|2022}}{{sfn|Proofed Editors|2020}}

=== Soundness ===

==== Formatted and Organized ====
Technical documents should be formatted in a way that is consistent with the norms and standards of applicable professional fields. Additionally, formatting should adhere to guidelines that enhance usability. Information should be logically organized for easy reading comprehension. This may involve using headings, subheadings, bullet points, and numbered lists. Formatting details should remain consistent throughout the document.{{sfn|Smirti|2022}}{{sfn|Proofed Editors|2020}}

==== Graphical ====
Technical communication utilizes visuals strategically to facilitate understanding of textual content. Visuals such as diagrams, charts, graphs, or images can enhance understanding of a technical document. When presented properly, visuals can explain difficult concepts and make material accessible to a more diverse audience.{{sfn|AI and the LinkedIn Community|2023}}

=== Appropriateness ===

==== Audience-specific ====
Where possible, technical communication should be customized to align with the knowledge and needs of its audience. Communication style and tone should be tailored to match the audience's level of expertise and should take into consideration such factors as the users' technical background, familiarity with the subject, and specific requirements.{{sfn|Viral Nation|2019}} The tone sets the overall mood for the piece.

====Document Design====
Documents' appropriateness requires that readers can quickly understand the message of the document. The document should be of appropriate style and length for the readers' needs.

==Personas in Digital Writing==
Personas in the context of digital writing, which is writing composed, created and read in digital environments, refer to semi-fictional characters that encapsulate the characteristics, behaviors, and needs of target audience segments. They align closely with the principles of user-centered design (UCD).{{sfn|Lucas|2023a}} There are myriad ways to integrate user-centered thinking into the creative process of UX design, and personas are one of the most effective ways to empathize with and analyze users.{{sfn|Goltz|2014}}

Personas may guide the creation of documentation and tutorials catering to different user needs. It is crucial to adjust the language and tone to match the persona preference. Different personas can influence and guide the design of the project.

==Rhetorical Strategies in the Digital Age==
[https://en.wikipedia.org/wiki/Rhetoric Rhetoric] is a communication strategy whose primary goal is to persuade an audience. It is grounded in three foundational concepts first defined by the Greek philosopher Aristotle. These concepts are ''logos'', which engages with the reader’s sense of logic or reason; ''pathos'', which appeals to the reader’s emotions; and ''ethos'', which addresses the audience’s values and the writer’s credibility. Within this framework, writers utilize specific techniques or devices to influence and engage readers. Examples include appealing to an audience’s sense of logic by using factual examples to support a point or evoking emotion through descriptive visual language.{{sfn|Gagich|Zickel|n.d.|pp=34-37}}

In today’s digital age, writers can use digital technologies as rhetorical devices to influence the reader. Electronic images and informational graphics can be incorporated into digital and online documents to illustrate or reinforce points made in the text.{{sfn|Markel|Selber|2019}} [[#Hyperlinking|Hyperlinks]] can provide access to additional information that supports authors’ ideas and enhances their credibility.{{sfn|Lucas|2023g|}} Nevertheless, the writer's basic task of informing and persuading an audience is the same in digital communication as in other forms of writing.{{sfn|DeVoss|National Writing Project|Eidman-Aadahl|Hicks|2010|p=105}}

Digital writers must therefore consider specific elements that compose the rhetorical context in which texts are created and delivered. Such elements may include evaluating the demographics, habits, and needs of an intended audience; determining the overall objective of the communications; and deciding what technologies will be used to create the content. Together, this analysis allows writers to craft messages that both appeal to and inform the target audience. In the digital age, such rhetorical messages may be conveyed through websites, social media, and other digital platforms.{{sfn|Lawrence|2022|pp=6-14}}

==Digital Technologies Tools==
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.

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

=== Content Management Systems (CMS) ===
A content management system (CMS) is a software application that allows users to create, manage, and modify digital content on a website. It provides a user-friendly interface and tools to easily organize, publish, and update content, including text, images, videos, and documents. Additionally, CMSs often offer features like user permissions, version control, and Search Engine Optimization (SEO) to enhance the overall website management experience.{{sfn|Carroll|2006|p=129}} Some popular examples of CMS include [https://wordpress.com/ WordPress], [https://www.wix.com/ Wix], and [https://www.blogger.com/about/?bpli=1 Blogger].

=== Image Processing Software ===
Image processing software plays a valuable role in technical and digital writing by facilitating the creation and enhancement of visuals. Documentation and tutorials help optimize images to convey processes or procedures effectively. Whether for screen captures illustrating software interfaces, data visualizations, or graphics for digital content, image processing tools contribute to creating clear and visually appealing materials.{{sfn|Robbins|2018|p=664}} These tools, such as [https://www.adobe.com/ Adobe] and [https://www.canva.com/ Canva], enhance the visual impact of technical and digital writing, ensuring that images are optimized, informative, and engaging for the audience.

=== Word Processors ===
Word processors are software applications designed for creating, editing, and formatting documents on a computer. They provide many features, such as spell-checking, grammar-checking, and inserting images and tables. These programs are typically used for writing essays, creating reports, or drafting professional documents.{{sfn|Carroll|2010|p=229}} Some popular software applications are [https://www.microsoft.com/en-us/microsoft-365/word Microsoft Word], [https://www.google.com/docs/about/ Google Docs][https://www.microsoft.com/en-us/microsoft-365/sharepoint/collaboration , SharePoint], and [https://www.apple.com/pages/ Apple Pages]. These programs allow documents to be readily disseminated. Comment capability enables audience members to interact about a document with one another and the author.

=== 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.

== 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}}

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

=== Case Studies ===
Case studies are a form of empirical or observational research that consists of in-depth examination of distinct individuals, groups, events, or scenarios. This research can be used to generate qualitative or quantitative data.{{sfn|Johnson-Sheehan|2018|pp=401-404}}

=== Data Sheets ===
A data sheet, also known as a technical datasheet, is a document used to describe and summarize the characteristics of a product, material, component, or technology.{{sfn|IDA|2020|p=}}

=== 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}}

*Product: provides detailed information about a specific item, including its features, specifications, and benefits.
*Process: provides step-by-step instructions on how to perform a particular task or achieve a specific outcome.

=== Documentation ===
Documentation comprises various texts that allow users to accomplish tasks or gain information. It generally falls into three categories, which can be defined as follows:
* Instructions: Text that describes how to complete a task, often offering numbered steps. Examples include how to download software or assemble a product.{{sfn|Balzotti|2022|p=167}}
* Specifications: Communications that deliver technical details on how a product is put together or a specific operation is executed. Also known as "specs," these texts may be written by engineers or technicians.{{sfn|Johnson-Sheehan|2018|p=205}}
* Procedures and Protocols: Guidelines to ensure consistency, quality, and safety in the workplace. For example, a hospital may provide staff with procedures on how to adapt operations during an emergency, such as a power outage.{{sfn|Johnson-Sheehan|2018|p=205}}

=== Email ===
Emails are the primary form of communication in the workplace, used for both internal and external communication. They facilitate information exchange, idea exchange, and activity coordination.{{sfn|Lannon|Gurak|2020|p=335}} Emails should be brief, concise, readable, and targeted to specific audiences with specific subject lines.{{sfn|Lannon|Gurak|2020|p=348}}

=== Letters ===
Letters are a traditional form of communication most often used by employees to communicate with individuals outside of a company or organization. They are typically written on company letterhead. Today, letters are sent either by U.S. mail or electronically.{{sfn|Johnson-Sheehan|2018|p=139}}

=== Memos ===
A memo (short for memorandum) is an official communication, usually a message from the company, a manager or director, or another person or group acting in an official capacity, used to communicate with others within the same organization.{{sfn|Lannon|Gurak|2020|p=353}}

=== 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}}

=== Proposals ===
A proposal is a document that identifies an existing problem or opportunity and outlines a comprehensive strategy for addressing it. Organizations create ''internal'' proposals to describe programs and projects that meet specific operational needs, such as a plan to replace an outdated software system. Companies develop ''external'' proposals for potential customers or clients. These documents detail new products, services, or initiatives that a company will implement to address a specific customer concern.{{sfn|Johnson-Sheehan|2018|p=245}}

=== Reports ===
A report is a concise, easily understandable document that presents technical information in a clear, organized format, allowing readers to access varying levels of information. Reports are categorized as informal, such as briefs, and formal, such as research, scientific, and completion reports.{{sfn|Johnson-Sheehan|2018|loc=chpt 10 & 11}}

==== Informal or Brief Reports ====
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.
* 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.
* Laboratory Reports describe experiments, tests, or inspections.

==== Formal Reports ====
A formal report is a factual and data-driven response to a research question.
* Research reports present the findings of a study.
* Scientific research reports outline the process, progress, and results of technical or scientific research or the current state of a research problem.
* Completion reports assess the outcomes of a project or initiative and provide feedback to management or the client.

=== 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.

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}}

=== 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}}

==Search Engine Optimization (SEO)==
SEO refers to the practice of optimizing online content to enhance its visibility and ranking on search engine results pages (SERPs), making it a crucial skill for digital writers.{{sfn|Lucas|2023b}} To optimize content for SEO means to have the goal of SEO in mind at the time of designing, creating, and writing a web page for publication. Using keywords and alt-text are two examples of optimizing content for SEO.{{sfn|Barr|2010|loc=chpt. 17}}

===Keywords===
Keywords are the words that search engines crawl a website for and index as the page's most important words. Based on other pages using the same keywords, the website is added into the search engine results pages from best matches to worst matches. The position of a website in search results is influenced by where it ranks on a scale determined by the keywords that a user searches for.{{sfn|Lucas|2023b}} To optimize a website's keywords, you should begin with researching keywords on your own website and ensure that you have an XML [https://en.wikipedia.org/wiki/Sitemaps sitemap] so search engines such as [https://en.wikipedia.org/wiki/Google Google] can crawl your web pages for updated information. In addition to using keywords, updating a page's metadata information can also help with showing up on SERPs. Using title and header tags as well as meta descriptions for content also helps optimize a website's ratings in SERPs.{{sfn|Lucas|2023b}}

===Alt-Text===
Alt-Text (alternative text), or [https://en.wikipedia.org/wiki/Alt_attribute Alt Attributes], is a practice that increases the usability and accessibility of a web page for users. Alt-Text is often used for visual elements that cannot be displayed in a different format but still provides description of the element for screen readers or users that may have a disability. Alt-Text also improves a website's SEO as a form of content optimization.{{sfn|Lucas|2023b}}

===Social Media Presence===
Sharing content from a website across different social media platforms is another way to create SEO optimization. This technique can help with being seen as legitimate and improves visibility of the website overall. Additionally, it can drive traffic and enables back-linking to occur when other websites have the ability to also link to the website.{{sfn|Lucas|2023b}}

=== Goals of Searching: The User's Perspective===
A user of search engines formulates queries by using keywords or posing questions. One of the most important elements of building an SEO strategy for a website is developing a thorough understanding of the psychology of your target audience and how they use words and concepts to obtain information about the services and/or products you provide. Once you understand how the average search engine user—and, more specifically, your target audience—utilizes query-based search engines, you can more effectively reach and keep those users.{{sfn|Enge|Spencer|Stricchiola|2022|p=9}}

==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}}

===Characteristics of Digital Documents===

====Electronic Format ====
Digital documents exist in electronic formats, which means they are stored and transmitted as binary data. This format allows for efficient storage, retrieval, and transmission of information via electronic devices.{{sfn|Lucas|2023c}} Digital documentation is the only method to meet a critical challenge of the relatively new concept of "knowledge management" that applies to all organizations. A digital knowledge management system is crucial to an organization so everyone can access information created by employees who are no longer with the organization or to allow cross-referencing with other seemingly unrelated departments.{{sfn|IBM}}

====Non-Tangible====
Unlike paper documents, digital documents lack physical presence. They are intangible and exist as electronic files, residing on devices or in the cloud.{{sfn|Lucas|2023c}}

====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}} It is a legal requirement to include accessibility features in website design.{{sfn|WCAG|2023}} It is also ethically imperative to make sure there is accessibility in digital writing. 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}} Accessibility broadens the reach of digital content and reaches a wider audience. This is important for technical writers, as their documentation and instructions are critical resources for users of varied abilities.

====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|Burnett|Benson|1999|p=207}} The other four Cs are coherent, concrete, correct and complete.{{sfn|Last|2019}}

====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 implementing visual elements, white space, concise language, highlighting, and emphasis.

====Ease of Reproduction and Distribution====
Digital documents are easily copied and distributed. They can be duplicated without any loss of quality, making it simple to share information widely and at minimal cost.{{sfn|Lucas|2023c}}

====Hyperlinking ====
Hyperlinking is a quick and efficient method for directing readers to relevant information in digital documents, facilitating seamless navigation between sections, references, and external resources.{{sfn|Carroll|2010|p=79}}

====Multimedia====
Digital documents can incorporate multimedia elements like images, audio, video, and interactive content, enhancing engagement through visual and auditory elements. Multiple media formats work best when sharing new, complicated ideas.{{sfn|Carroll|2010|p=36}} Increasing multimodality on a website improves engagement, usability, and accessibility. This can improve the impact of the website's standings in SERPs.{{sfn|Carroll|2010|p=280}}

====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}}

====Remote Collaboration====
One form of collaborative technical writing is a wiki, which is a "website developed collaboratively by a community of users, allowing any user to add and edit content."{{sfn|Lucas|2021}} One of the predominant elements of a wiki is that it is defined as being open source. As a result, anyone can modify it regardless of their geographic locations.

====Security Measures====
Digital documents can be protected with encryption, passwords, and access controls to safeguard sensitive information. These security measures enhance data protection and privacy.{{sfn|Lucas|2023c}}

====Environmental Impact====
Digital documents have a smaller environmental footprint compared to paper documents, as they reduce the need for paper production, printing, and transportation.{{sfn|Lucas|2023c}}

====Dynamic Updates====
Online digital documents can be updated dynamically, ensuring that users always have access to the most current information. This is particularly valuable in fast-changing fields.{{sfn|Lucas|2023c}}

====Global Accessibility====
Digital documents can be shared globally, transcending geographical boundaries and time zones. They support international collaboration and the dissemination of knowledge on a global scale.{{sfn|Lucas|2023c}}

====Data Integration====
In business and research settings, digital documents can integrate with databases and data analysis tools. This integration streamlines data collection, analysis, and reporting processes.{{sfn|Lucas|2023c}}

====Data Analytics ====
Digital documents can be subjected to data analytics techniques, allowing organizations to extract valuable insights from large volumes of textual data, which can inform decision-making and strategy.{{sfn|Lucas|2023c}}

==Examples of Digital Documents==
In technical and professional writing, digital documentation takes various forms. These methods streamline the sharing of technical information, enhance collaboration, and ensure easy accessibility within professional settings, contributing to efficient communication and knowledge dissemination.

=== Infographics ===
Infographics, shared as digital documents, typically combine text, graphics, and illustrations to convey complex concepts or data in a concise and visually appealing format. Infographics are often used to simplify information, making it more accessible to a broader audience, and are found in presentations, reports, websites, and educational materials.{{sfn|Lannon|Gurak|2020|pp=292-293}}

=== Presentations ===
Presentations created with [https://en.wikipedia.org/wiki/Microsoft_PowerPoint PowerPoint] or [https://en.wikipedia.org/wiki/Google_Slides Google Slides] are vital for professional communication and knowledge sharing. They condense complex information into visually appealing slides for effective presentations by using photos, videos, graphics, charts, and graphs.{{sfn|Parkinson|2018|loc=chpt. 4}}

=== Blogs ===
A blog, short for "weblog," is an informational website organized into short articles called posts, typically chronologically ordered series of website updates, written and organized similar to a traditional diary.{{sfn|Bair|2014|p=7}} They are regularly updated, providing readers with insights on a specific topic or subject. Blogs serve various purposes, including sharing opinions, providing news, offering educational content, and documenting personal experiences.{{sfn|Rose|Garret|2012|p=2}}

==User Experience==
User experience (UX) is how a product works from the perspective of the user. Digital documents can be created with efficient user experiences by practicing several design methods, including user-centered design, information architecture, responsive design, and usability.

===User-Centered Design===
The approach of user-centered design (UCD) in technical writing consists of the following methodology{{sfn|Lucas|2023e}}:

* User Research: the act of conducting thorough research through surveys, interviews, and usability testing to gain a better understanding of user needs and experiences when using a digital document
* Ideation and prototyping: the process of creating digital designs and prototypes to assist with exploring possible solutions to meet user needs
* Usability testing: the act of having users interact with digital document designs and recording and adjusting the design based on user feedback
* Implementation: the stage in which the design is implemented after making adjustments from prior testing
* Evaluation: the stage in which the digital document is assessed to ensure that it is meeting user needs
* Maintenance and updates: to maintain a digital document based on user feedback and changing needs

===Information Architecture===

To ensure a digital document has effective UX design and accessible information, technical writers need to construct a clear and organized information architecture (IA). IA is a design principle that organizes information so that it is easily found and understood by users, prioritizing their needs and reducing information overload. A design challenge is making IA understood across multiple digital experiences, changing the navigation structure to fit different medias while staying logical and consistent for the user.{{sfn|Rosenfeld|pp=1, 17-18}} IA that is not constructed well can confuse the user and could cause them to give up their search of information in frustration.{{sfn|Garrand|pp=12}}

The architecture components of IA can be divided into four different categories:{{sfn|Rosenfeld|pp=90}}

*Organization systems: how information is categorized and organized for user understanding

*Labeling systems: how information is represented

*Navigation systems: how users browse information and navigate between pages

*Searching systems: how users search for specific information

=== Responsive Design ===

Responsive design is a strategy that appropriately updates the layout and content of a website or document in relation to the screen size, device, and/or orientation, allowing the site or document to be easily viewed and navigated regardless of device used. With the increased use of mobile devices, web content should be constructed with proper responsive web design (RWD) to ensure effective UX and usability on those devices.{{sfn|Robbins| pp=485}}

There are several design strategies that can be implemented that will increase the success of RWD:{{sfn|Robbins| pp=487}}

*Fluid layout – Responsive sites can be constructed using a fluid layout (or flexible grid) system that will allow content to adjust and flow according to the available screen space.

*Flexible and responsive images – Images and other embedded media can be instructed so that they fit their containers instead of remaining at a fixed size. Images with varying resolutions can also be swapped according to screen size to avoid high-resolution images on smaller devices.

*CSS media queries – Media queries can be written into the CSS (Cascading Style Sheet), which would instruct the construction of the site according to screen width and orientation. Adding breakpoints for several screen sizes allows pages to be designed for specific devices.

*Content hierarchy – Carefully constructing content that is organized for the user and creating a hierarchy of content that prioritizes user needs is necessary to ensure effective user experience and navigation across multiple screen sizes.{{sfn|Robbins| pp=499}}

===Usability===

Technical writers must create documents and websites that meet the expectations of their readers and users, and in doing so, writers increase the usability of their site or document.{{sfn|Garrand|pp=26}} Usability can be applied with visual aids, clear and concise language, and structured design.

==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|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|Society for Technical Communication|2023a}} The STC promotes adherence to a list of ethical principles. They are legality, honesty, confidentiality, quality, fairness, and professionalism.{{sfn|Society for Technical Communication|2023b}}

Technical communicators also have to be careful to avoid plagiarism, or taking ideas, thoughts, or words from someone else and passing them off as one's own.{{sfn|Carroll|2010|p=280}}

Technical communicators have ethical standards to which they must abide. The standards are divided into three primary categories. They are the employer, the public, and the environment.{{sfn|Markel|2009}}

===The Employer===
Obligations to one's employer include competence and diligence, honesty and candor, confidentiality, and loyalty.{{sfn|Markel|2009}} The technical communicator must adhere to these obligations so that he/she does not harm the reputation or operation of the employer.

Technical communicators may occasionally work for an organization with strict privacy policies that prohibit them from using the documents they create outside of the organization. It is important for ethical communicators to follow the privacy policy for their organization because unauthorized release of information could lead to consequences up to and including termination.{{sfn|Balzotti|2022|p=83}}

=== The Public===
Organizations are obligated to treat customers fairly. Technical communicators must convey that the products or services an organization sells are safe and effective.{{sfn|Markel|2009}}

===The Environment===
Technical communicators have an obligation to the environment. This obligation includes alerting their supervisors, managers, and executive leadership to products or processes that are detrimental to the environment. Protecting the environment can be costly, however, and organizations may consider ignoring legal guidelines to save money.{{sfn|Markel|2009}} Yet, failure to adhere to U.S. Environmental Protection Agency regulations also has financial implications. For example, the penalty for mishandling hazardous waste is five years and/or up to $50,000 for each day of the violation.{{sfn|EPA|2023}}

=== Disinformation ===
One major ethical concern in all forms of writing, but especially in digital writing, is the creation and spread of disinformation. Disinformation, often referred to as "[[w:Fake news|fake news]]," is information that is purposefully spread as false or misleading and is a sub-type of misinformation.{{sfn|Lawrence|2022|loc=section 3.7}} Modern communication technologies allow for the spread of information to occur at a fast pace. Social media is one area where the spread of disinformation occurs regularly.

Some social media sites, such as Facebook, have begun to flag certain articles posted on the site as being questionable in their representation of facts or occurrences. Despite the widespread understanding and use of disinformation available today, digital writers need to be aware of their intent and the audience's needs and wants from their digital communication.{{sfn|Lucas|2023f}} Ethical considerations regarding citing sources, cross-referencing information, and using primary sources are good practices for maintaining ethical standing and credibility as a digital writer.

To help mitigate the problem of disinformation, technical writers should utilize gatekeepers. These individuals verify the accuracy of the information before it is distributed to primary readers. This helps protect the author from any ethical and/or legal issues.{{sfn|Balzotti|2022|p=83}}

==Pedagogical Approaches==
===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}}

===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}}

===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}}

==Future Trends and Challenges==
=== Future Trends===
Between 2022 and 2032, the [https://en.wikipedia.org/wiki/Bureau_of_Labor_Statistics, United States Bureau of Labor Statistics] is projecting a 7% job growth for technical writers.{{sfn|United States Bureau of Labor Statistics|2023}} To be relevant as a technical writer in the digital age, one must possess the skills of conducting in-depth research, critical thinking, being detail oriented, design, and technical expertise. To succeed at communicating the complex to specific audiences, the technical writer must understand much of the subject in its complexity. This is accomplished through possessing the skills of communication, collaboration, and teamwork.{{sfn|Fechter|2023}}

===Challenges===
Barriers to teaching technical communications include the speed at which digital tools evolve, the complexity of software,{{sfn|Hovde|Renguette|2017|pp=395-411}} and the dependency on input information accuracy. Outdated, incorrect, or inconsistent data delays the publication, requires more reparative efforts, and decreases productivity.{{sfn|Ajose-Coker|2022}} Also, technical writers often have to contend with complex, outdated or unsuitable tools. This can make their job more difficult and time-consuming, and can lead to frustration and errors.{{sfn|Ajose-Coker|2022}}

===Artificial Intelligence===
Artificial intelligence programs, utilizing natural language processing, are capable of producing technical writing and have advanced in recent years becoming more adept.{{sfn|Marr|2023}}

One such program is [https://en.wikipedia.org/wiki/ChatGPT ChatGPT], which uses machine learning to produce texts with human-like style and tone.{{sfn|University of Central Arkansas|2023}} Another leader in this area, Contentbot, uses a WordPress plugin which gives blog writers ideas to enhance their posts which are shared via email.{{sfn|Siddiqui|2022}}

===Plagiarism===
Because of the ability of chatbots to imitate human-like language, some education administrators have taken precautions to minimize the occurrence of students passing off artificially generated texts as their own. In some instances, educators have taken the view that material drawn from artificial intelligence software must be handled in the same way as sources from human authors.{{sfn|Klein|2023}} In such cases, students who incorporate artificially generated text into their work have been made to denote credit for the artificial intelligence program utilized.

===Credit ===
The advent of chatbots has complicated the issue of credit where creative work is concerned. Because chatbots can simulate human speech, their ability to create cinematic dialogues and other types of creative writing have threatened the credits and financial condition of professional writers. According to an article by Aaron Mok and Jacob Zinkula on ''[https://www.businessinsider.com/ Business Insider]'', writing jobs are among the top 10 roles that AI is most likely to replace.{{sfn|Mok|2023}}

==References==
===Citations===
{{Reflist}}

===Bibliography===
{{Refbegin|30em}} 
* {{cite web |url=https://www.linkedin.com/advice/0/how-can-you-create-effective-visual-aids-1c |title=How Can You Create Effective Visual Aids for Technical Writing? |last=AI and the LinkedIn Community |date=2023 |website=www.linkedin.com |publisher=LinkedIn |access-date=2023-11-05 }}
* {{cite web |url=https://componize.com/common-problems-in-technical-writing-and-how-to-resolve-them/ |title=Common Problems in Technical Writing and How to Solve Them |last=Ajose-Coker |first=Dipo |date=2022 |website=componize.com |publisher=Componize Software |access-date=2023-11-19 }}
* {{cite book |last=Bair|first=Amy Lupold |date=2014 |title=Blogging for Dummies|url=|location=Hoboken, NJ |publisher=Jon Wiley & Sons, Inc|pages=|isbn=|author-link= }}
* {{cite book |last=Balzotti |first=Jon |date=2022 |title=Technical Communication: A Design-Centric Approach |edition= 2nd |url= |location=New York |publisher=Routledge |isbn=9780367438302 }}
* {{cite book |last=Barr |first=Chris |date=2010 |title=The Yahoo! Style Guide |url= |location=New York |publisher=St. Martin's }}
* {{cite book |last=Carroll |first=Brian |date=2010 |title=Writing for Digital Media |url= |location=New York |publisher=Routledge }}
* {{cite book |last1=Coco |first1=Pete |last2=Torres |first2=M. Gabriella |date=2014 |editor-last1=Dougherty |editor-first1=Jack |editor-last2=O'Donnell |editor-first2=Tennyson |title=Web Writing: Why and How for Liberal Arts Teaching and Learning |publisher=University of Michigan Press |pages=175-188 |chapter=“Writing as Curation: Using a ‘Building’ and ‘Breaking’ Pedagogy to Teach Culture in the Digital Age" |chapter-url=https://epress.trincoll.edu/webwriting/chapter/cocotorres |ref=harv }}
* {{cite web |url=https://www.betonconsultingeng.com/objectivity-in-technical-writing/#:~:text=Pointers%20for%20objective%20technical%20writing%201%20If%20you,5%20Remember%20that%20correlation%20is%20not%20causality.%20 |title=Objectivity in Technical Writing |last=Detwiler |first=Rachel |date=2021 |website=www.betonconsultingeng.com |publisher=Beton Consulting Engineers L.L.C. |access-date=2023-11-05 }}
* {{cite book |last=DeVoss |first=Danielle |last2=National Writing Project |last3=Eidman-Aadahl |first3=Elyse |last4=Hicks |first4=Troy |date=2010 |title=Because Digital Writing Matters: Improving Student Writing in Online and Multimedia Environments |location=San Francisco |publisher=Jossey-Bass |pages=105 |isbn= |url=https://openlibrary.org/books/OL34593323M/Because_Digital_Writing_Matters }}
*{{cite book |last=Enge |first=Eric |last2=Spencer |first2=Stephan |last3=Stricchiola |first3=Jessie |date=2022 |title=The Art of SEO: Mastering Search Engine Optimization |url=https://archive.org/details/artofseomasterin0000enge |location=Sebastopol, CA |publisher=O'Reilly |pages=9 }}
* {{cite web |url=https://www.epa.gov/enforcement/criminal-provisions-resource-conservation-and-recovery-act-rcra |title=Criminal Provisions of the Resource Conservation and Recovery Act (RCRA) |date=2023 |publisher=United States Environmental Protection Agency }}
* {{cite web |url=https://technicalwriterhq.com/career/technical-writer/technical-writing-skills/ |title=Essential Technical Writing Skills |last=Fechter |first=Josh |date=2023 |website=technicalwriterhq.com |access-date=2023-11-21}}
* {{cite book |last=Gagich |first=Melanie |last2=Zickel |first2=Emilie |date=n.d. |title=Writing Arguments in Stem |chapter=Rhetorical Appeals: Logos, Pathos, and Ethos Defined |publisher=Digital Commons |url=https://digitalcommons.calpoly.edu/cgi/viewcontent.cgi?article=1000&context=oercoursematerials#page=44 |location= |pages=34-37 }}
* {{cite book |last=Garrand |first=Timothy |date=2006 |title=Writing for Multimedia and the Web: A Practical Guide to Content Development for Interactive Media |edition=3rd |location=Burlington, MA |publisher=Focal Press |ref=harv }}
* {{cite book |last=Garrett |first=Jesse James |title=The Elements of User Experience: User-Centered Design for the Web and Beyond |publisher=New Riders |edition=2nd |date=2011 |location=Berkeley, CA |page=17 }}
* {{cite book |last=Godson |first=Williams|title=Web Design with HTML and CSS |p=37-41}}
* {{cite web |url=https://smashingmagazine.com/2014/08/a-closer-look-at-personas-part-2/ |title=A Closer Look at Personas: A Guide to Developing The Right Ones (Part 2) |last=Goltz | first=Shlomo |date=2014 |website=smashingmagazine.com |publisher=Smashing Media AG |access-date=2023-11-13 }}
* {{cite magazine |last=Grimstead |first=Deborah M. |date=1999 |title=Technical Writers are in Demand: Do You Have The Right Stuff? |magazine=Black Collegian |pages=128 }}
* {{cite journal |last1=Hovde |first1=Marjorie |last2=Renguette |first2=Corinne |date=2017 |title=Technological Literacy: A Framework for Teaching Technical Communication Software Tools |journal=Technical Communication Quarterly |volume=26 |pages=395-411 |doi=10.1080/10572252.2017.1385998}}
* {{cite web |url=https://www.ibm.com/topics/knowledge-management |title=What is Knowledge Management? |first= |last=IBM |website=ibm.com |access-date=2023-11-24}}
* {{cite web |url=https://www.idassoc.com/product-information-definition/data-sheet |title=Product Information Encyclopedia |last=IDA |first= |date=2020 |website=Industrial Data Associates |publisher= |access-date=2023-11-20 |quote= }}
* {{cite book |last=Johnson-Sheehan |first=Richard |title=Technical Communication Today |url= |edition=6 |location=Boston, MA |publisher=Pearson |date=2018 |pages= }}
* {{cite news |last=Klein |first=Alyson |date=2023 |title=ChatGPT Cheating: What to Do When It Happens |url=https://www.edweek.org/technology/chatgpt-cheating-what-to-do-when-it-happens/ |work=Education Week |location=Bethesda, MD |access-date=2023-11-05 }}
* {{cite book |last=Krug |first=Steve |date=2014 |title=Don’t Make Me Think, Revisited|url= |location=Berkeley, CA |publisher=New Riders |pages= |isbn= |author-link= }}
* {{cite book |last=Lannon |first=John M. |last2=Gurak |first2=Laura J. |date=2020 |title=Technical Communication |edition=15 |url= |location= |publisher=Pearson Education |page= }}
* {{cite book |last=Last|first=Susan |date=2019 |title=Technical Writing Essentials|url=https://pressbooks.bccampus.ca/technicalwriting/chapter/communicatingprecision/|location= |publisher= Victoria, B.C. University of Victoria |pages= |isbn= |author-link= }}
* {{cite book |last=Lawrence |first=Dan |date=2022 |title=Digital Writing: A Guide to Writing for Social Media and the Web |location=Peterborough, Ontario, Canada |publisher=Broadview Press |page=85 }}
* {{cite web |url=https://grlucas.net/grl/Writing_on_a_Wiki |title=Writing on a Wiki |last=Lucas |first=Gerald| date=2021| website=grlucas.net| publisher=MediaWiki| access-date=2023-10-31 }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Personas |title= Using Personas in Digital Writing
|last=Lucas |first=Gerald |date=2023a| website=grlucas.net |publisher=MediaWiki |access-date=2023-11-07 }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/SEO |title=Search Engine Optimization: Strategies and Best Practices for Effective Online Visibility |last=Lucas |first=Gerald |date=2023b |website=grlucas.net |publisher=MediaWiki |access-date=2023-11-19 }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Documents|title=Exploring the Dichotomy: A Comparative Analysis of Digital and Paper Documents |last=Lucas |first=Gerald |date=2023c |website=grlucas.net |publisher=MediaWiki |access-date=2023-10-29 |quote= }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Design/Users |title=User-Centered Design in Digital Documents |last=Lucas |first=Gerald |date=2023d |website=grlucas.net |publisher=MediaWiki |access-date=2023-11-15 |quote= }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Style |title=Audience-Centric Style in Digital Writing |last=Lucas |first=Gerald |date=2023e |website=grlucas.net |publisher=MediaWiki |access-date=2023-10-22 |quote= }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Credibility |title=The Significance of Credibility in Digital Writing |last=Lucas |first=Gerald |date=2023f |website=grlucas.net |publisher=MediaWiki |access-date=2023-11-21 }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Tech_Writing |title=Combining Disciplinary Approach to Technical Writing with Digital Writing: Enhancing Communication in the Digital Age |last=Lucas |first=Gerald |date=2023g |website=grlucas.net |publisher=MediaWiki |access-date=2023-11-27 |quote= }}
* {{cite web |url=https://www.indeed.com/career-advice/careers/what-does-a-technical-writer-do |title=What Does a Technical Writer Do? (Plus How To Become One) |last=Macari |first=Sabina |date=2023 |website=indeed.com |publisher=Indeed |access-date=2023-11-05 }}
* {{cite magazine |last=Malone |first=Ed |date=2008 |title=Joseph D. Chapline: Technical Communication's Mozart |url=https://web.mst.edu/~malonee/chapline.pdf |magazine=IEEE Professional Communication Society Newsletter |access-date=2023-10-31 }}
* {{cite journal |last=Malone |first=Edward |date=November 2011 |title=The First Wave (1953-1961) of the Professionalization Movement in Technical Communication |url=https://www.stc.org/techcomm/wp-content/uploads/sites/3/2016/08/november-2011-58-4.pdf |journal=Technical Communication |volume=58 |issue=4 |pages=285-306 |doi= |access-date=2023-10-11 }}
* {{cite book |last=Markel |first=Michael |title=Technical Communication |date=2009 |edition=9th |location=Boston |publisher=Bedford/St. Martin's |pages=22-25 }}
* {{cite book |last=Markel |first=Mike |last2=Selber |first2=Stuart A. |date=2019 |title=Practical Strategies of Technical Communication |edition=3rd |url= |location=Boston |publisher=Bedford/St. Martin’s |page= }}
* {{cite web |url=https://www.forbes.com/sites/bernardmarr/2023/01/23/how-chatgpt-and-natural-language-technology-might-affect-your-job-if-you-are-a-computer-programmer/?sh=6d9acf79174b |title=How ChatGPT And Natural Language Technology Might Affect Your Job If You Are A Computer Programmer |last=Marr |first=Bernard |date=2023 |website=Forbes.com |publisher=Forbes Media |access-date=2023-10-31 |quote= }}
* {{cite web |url=https://www.businessinsider.com/chatgpt-jobs-at-risk-replacement-artificial-intelligence-ai-labor-trends-2023-02 |title=ChatGPT may be coming for our jobs. Here are the 10 roles AI is most likely to replace |last=Mok |first=Aaron |date=2023 |website=Insider |publisher=Business Insider |access-date= 2023-11-05 }}
* {{cite book |last=Mussack |first=Brigitte |date=2021 |title=Introduction to Technical and Professional Communication |url=https://pressbooks.umn.edu/techwriting/front-matter/introduction/ |location= |publisher=Creative Commons Attribution NonCommercial |pages=n.p. |author-link= }}
* {{cite book| last=Parkinson |first=Mike |title=A Trainer’s Guide to PowerPoint: Best Practices for Master Presenters| location=United States| publisher=Association for Talent Development| chapter=Chapter 4. PowerPoint Tips, Tricks, and Secrets| date=2018 }}
* {{cite book |last=Perelman |first=Leslie |date=1998 |title=The Mayfield Handbook of Technical and Scientific Writing |url=https://www.mit.edu/course/21/21.guide/ |location=Mountain View |publisher=Mayfield Publishing Company |pages=n.p. |isbn= |author-link= }}
* {{cite web |url=https://learn.g2.com/how-to-write-a-press-release |title=How to Write a Press Release That Catches People's Attention |date=2021 |last=Pradhan |first=Ninisha |website=learn.g2.com |publisher=G2.com |access-date=2023-11-21 }}
* {{cite web |url=https://proofed.com/writing-tips/a-beginners-guide-to-technical-writing/ |title=A Beginner’s Guide to Technical Writing |last=Proofed Editors |date=2020 |website=Proofed.com |publisher=Proofed |access-date=2023-11-05 }}
* {{cite journal |last=Rathbone |first=Robert |title=Growth of the technical writing profession |journal=STWE Review |volume=5 |issue=1 |date=1958 |pages=5-16 }}
*{{cite book |last=Robbins |first=Jennifer Niederst |date=2018 |title=Learning Web Design: A Beginner’s Guide to HTML, CSS, JavaScript, and Web Graphics (5th ed.) |url= |location=Sebastopol, CA |publisher= O’Reilly Media, Inc. }}
* {{cite book |last=Rose|first=Darren |last2=Garret |first2=Chris|date=2012 |title=ProBlogger: Secrets for Blogging Your Way to a Six-Figure Income|url=|location=Indianapolis, IN |publisher=Jon Wiley & Sons, Inc|pages=|isbn=|author-link= }}
* {{cite book |last1=Rosenfeld |first1=Louis |last2=Morville |first2=Peter |last3=Arango |first3=Jorge |date=2006 |title=Information Architecture for the Web and Beyond |edition=4th |location=Sebastopol, CA |publisher=O'Reilly Media, Inc.}}
* {{cite web |url=https://writingcooperative.com/intricacies-of-ai-tools-can-ai-tools-take-over-the-jobs-of-technical-writers-af36836f625c |last=Siddiqui |first=Zafar |title=Will Best Artificial Intelligence Take Over any Technical Content Writer? |date=2022 |website=writingcooperative.com |publisher=The Writing Cooperative |access-date=2023-11-19 }}
* {{cite web |url=https://www.managementnote.com/features-of-technical-communication/#google_vignette |title=Features of Technical Communication |last=Smirti |date=2022 |website=managementnote.com |publisher=Management Note |access-date= 2023-11-05 }}
* {{cite web |url=https://www.stc.org/about-stc/ |title=About STC |last=Society for Technical Communication |first= |date=2023a |website=stc.org |publisher= |access-date=2023-10-27 }}
* {{cite web |url=https://www.stc.org/about-stc/ethical-principles/ |title=Ethical Principles |last=Society for Technical Communication |first= |date=2023b |website=stc.org |publisher= |access-date=2023-10-27 }}
* {{cite web |url=https://www.bls.gov/ooh/media-and-communication/technical-writers.htm#tab-6 |title=Occupational Outlook Handbook |last=United States Bureau of Labor Statistics |first= |date=2023 |website=bls.gov |publisher=United States Department of Labor |access-date=2023-11-07 }}
* {{cite web |url=https://uca.edu/cetal/chat-gpt/ |title=Chat GPT: What is it? |last=University of Central Arkansas |first= |date= |website=uca.edu |publisher= University of Central Arkansas |access-date=2023-10-09 }}
* {{cite web |url=https://www.viralnation.com/blog/what-is-digital-content-creation-and-how-can-it-help-me-as-a-marketing-manager/#:~:text=A%20rule%20of%20thumb%20in%20digital%20content%20creation,turn%2C%20share%20it%20with%20others%20in%20their%20network. |title=What is Digital Content Creation? (and How Can It Help Me as a Marketing Manager) |last=Viral Nation |date=2019 |website=viralnation.com |publisher= Viral Nation |access-date=2023-11-05 }}
* {{cite web |url=https://www.w3.org/WAI/fundamentals/accessibility-intro/|title=Introduction to Web Accessibility |last=WAI |first=|date=2022 |website=W3.org|publisher= |access-date= 2023-10-26 |quote= }}
* {{cite web |url=https://scribehow.com/library/user-guide |title=What is a User Guide? Everything You Need to Know |last=Wainaina |first=Timan |date=2022 |website= |publisher= |access-date=22 November 2023 |quote= }}
* {{cite web |url=https://wcag.com/legal/|title=Accessibility and the Law |last=WCAG |first= |date=2023 |website=wcag.com|publisher=eSSENTIAL Accessibility |access-date= 2023-10-26 |quote= }}
* {{cite book |last=Zeleznik |first=J. M. |last2=Burnett |first2=R. E. |last3=Benson |first3=P. J. |date=1999 |title=Technical Writing: What It Is and How to Do It |url= |location= |publisher=National Book Network |pages=107 |isbn= |author-link= }}

{{Refend}}

[[Category:Fall 2023]]
[[Category:ENGL 5106]]

Technical Writing in the Digital Age

2023-11-28T18:57:54Z

APitts: /* Historical Context */ citation needed

'''Technical Writing in the Digital Age''' represents the dynamic and evolving discipline of creating written materials that convey complex information, instructions, and technical concepts in the context of contemporary digital technologies. Its purview encompasses the creation, dissemination, and management of technical documents and content within an expansive digital landscape. Connected networks of workstations, laptops, cell phones, tablets, and servers are the central nervous system in the technical workplace.

Major considerations revolve around adapting traditional principles of rhetoric to digital platforms, ensuring effective communication in an era defined by rapid technological advancements. 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. The use of multi-modality and the interfacing of multiple media platforms and sources also plays a role in digital technical writing. In essence, technical writing in the digital age encapsulates the art and science of conveying technical information in a manner that is comprehensible and accessible to diverse audiences in our digitally driven society.

==Overview==

=== Aims of Technical Communication ===
Technical communication is a discipline present in various fields like education, business, and science. In any domain, technical documentation shares a common objective: assisting the audience in achieving a task or goal.{{sfn|Markel|Selber|2019}}

=== 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 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.{{Citation needed|date={{subst:November}} {{subst: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}}

==Features of Technical Communication==
Technical communication involves conveying complex information to a specific audience. Key features include accuracy, attention to detail, visuals, and clear and concise organization to enhance user understanding.{{sfn|Smirti|2022}}

=== Accuracy ===

==== Standards Compliant ====
Many technical fields have industry-specific regulations and guidelines which are determined by governing bodies and that also have an impact on their technical communication. Furthermore, many organizations may have a style guide that outlines preferred language usage, tone, and formatting.{{sfn|Smirti|2022}}

==== Detail-Oriented ====
Technical communication should be detail-oriented and free of errors and inconsistencies. Accurate information that is delivered with precision and specificity is essential to providing communication that is unambiguous and free of discrepancies.{{sfn|Smirti|2022}}

==== Objective ====
Objective communication is presented in an unbiased and impartial manner and is free of personal opinions. It relies upon facts and evidence and avoids an overly emotional tone. This approach is particularly important in fields where accuracy and impartiality are essential.{{sfn|Detwiler|2021}}

===== Clear and Concise =====
Technical communication should be logically organized, straightforward, and easily understood by the target audience. The language used should avoid needless jargon and be written in a manner that avoids redundant word usage and/or excessive explanations.{{sfn|Smirti|2022}}{{sfn|Proofed Editors|2020}}

=== Soundness ===

==== Formatted and Organized ====
Technical documents should be formatted in a way that is consistent with the norms and standards of applicable professional fields. Additionally, formatting should adhere to guidelines that enhance usability. Information should be logically organized for easy reading comprehension. This may involve using headings, subheadings, bullet points, and numbered lists. Formatting details should remain consistent throughout the document.{{sfn|Smirti|2022}}{{sfn|Proofed Editors|2020}}

==== Graphical ====
Technical communication utilizes visuals strategically to facilitate understanding of textual content. Visuals such as diagrams, charts, graphs, or images can enhance understanding of a technical document. When presented properly, visuals can explain difficult concepts and make material accessible to a more diverse audience.{{sfn|AI and the LinkedIn Community|2023}}

=== Appropriateness ===

==== Audience-specific ====
Where possible, technical communication should be customized to align with the knowledge and needs of its audience. Communication style and tone should be tailored to match the audience's level of expertise and should take into consideration such factors as the users' technical background, familiarity with the subject, and specific requirements.{{sfn|Viral Nation|2019}} The tone sets the overall mood for the piece.

====Document Design====
Documents' appropriateness requires that readers can quickly understand the message of the document. The document should be of appropriate style and length for the readers' needs.

==Personas in Digital Writing==
Personas in the context of digital writing, which is writing composed, created and read in digital environments, refer to semi-fictional characters that encapsulate the characteristics, behaviors, and needs of target audience segments. They align closely with the principles of user-centered design (UCD).{{sfn|Lucas|2023a}} There are myriad ways to integrate user-centered thinking into the creative process of UX design, and personas are one of the most effective ways to empathize with and analyze users.{{sfn|Goltz|2014}}

Personas may guide the creation of documentation and tutorials catering to different user needs. It is crucial to adjust the language and tone to match the persona preference. Different personas can influence and guide the design of the project.

==Rhetorical Strategies in the Digital Age==
[https://en.wikipedia.org/wiki/Rhetoric Rhetoric] is a communication strategy whose primary goal is to persuade an audience. It is grounded in three foundational concepts first defined by the Greek philosopher Aristotle. These concepts are ''logos'', which engages with the reader’s sense of logic or reason; ''pathos'', which appeals to the reader’s emotions; and ''ethos'', which addresses the audience’s values and the writer’s credibility. Within this framework, writers utilize specific techniques or devices to influence and engage readers. Examples include appealing to an audience’s sense of logic by using factual examples to support a point or evoking emotion through descriptive visual language.{{sfn|Gagich|Zickel|n.d.|pp=34-37}}

In today’s digital age, writers can use digital technologies as rhetorical devices to influence the reader. Electronic images and informational graphics can be incorporated into digital and online documents to illustrate or reinforce points made in the text.{{sfn|Markel|Selber|2019}} [[#Hyperlinking|Hyperlinks]] can provide access to additional information that supports authors’ ideas and enhances their credibility.{{sfn|Lucas|2023g|}} Nevertheless, the writer's basic task of informing and persuading an audience is the same in digital communication as in other forms of writing.{{sfn|DeVoss|National Writing Project|Eidman-Aadahl|Hicks|2010|p=105}}

Digital writers must therefore consider specific elements that compose the rhetorical context in which texts are created and delivered. Such elements may include evaluating the demographics, habits, and needs of an intended audience; determining the overall objective of the communications; and deciding what technologies will be used to create the content. Together, this analysis allows writers to craft messages that both appeal to and inform the target audience. In the digital age, such rhetorical messages may be conveyed through websites, social media, and other digital platforms.{{sfn|Lawrence|2022|pp=6-14}}

==Digital Technologies Tools==
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.

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

=== Content Management Systems (CMS) ===
A content management system (CMS) is a software application that allows users to create, manage, and modify digital content on a website. It provides a user-friendly interface and tools to easily organize, publish, and update content, including text, images, videos, and documents. Additionally, CMSs often offer features like user permissions, version control, and Search Engine Optimization (SEO) to enhance the overall website management experience.{{sfn|Carroll|2006|p=129}} Some popular examples of CMS include [https://wordpress.com/ WordPress], [https://www.wix.com/ Wix], and [https://www.blogger.com/about/?bpli=1 Blogger].

=== Image Processing Software ===
Image processing software plays a valuable role in technical and digital writing by facilitating the creation and enhancement of visuals. Documentation and tutorials help optimize images to convey processes or procedures effectively. Whether for screen captures illustrating software interfaces, data visualizations, or graphics for digital content, image processing tools contribute to creating clear and visually appealing materials.{{sfn|Robbins|2018|p=664}} These tools, such as [https://www.adobe.com/ Adobe] and [https://www.canva.com/ Canva], enhance the visual impact of technical and digital writing, ensuring that images are optimized, informative, and engaging for the audience.

=== Word Processors ===
Word processors are software applications designed for creating, editing, and formatting documents on a computer. They provide many features, such as spell-checking, grammar-checking, and inserting images and tables. These programs are typically used for writing essays, creating reports, or drafting professional documents.{{sfn|Carroll|2010|p=229}} Some popular software applications are [https://www.microsoft.com/en-us/microsoft-365/word Microsoft Word], [https://www.google.com/docs/about/ Google Docs][https://www.microsoft.com/en-us/microsoft-365/sharepoint/collaboration , SharePoint], and [https://www.apple.com/pages/ Apple Pages]. These programs allow documents to be readily disseminated. Comment capability enables audience members to interact about a document with one another and the author.

=== 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.

== 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}}

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

=== Case Studies ===
Case studies are a form of empirical or observational research that consists of in-depth examination of distinct individuals, groups, events, or scenarios. This research can be used to generate qualitative or quantitative data.{{sfn|Johnson-Sheehan|2018|pp=401-404}}

=== Data Sheets ===
A data sheet, also known as a technical datasheet, is a document used to describe and summarize the characteristics of a product, material, component, or technology.{{sfn|IDA|2020|p=}}

=== 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}}

*Product: provides detailed information about a specific item, including its features, specifications, and benefits.
*Process: provides step-by-step instructions on how to perform a particular task or achieve a specific outcome.

=== Documentation ===
Documentation comprises various texts that allow users to accomplish tasks or gain information. It generally falls into three categories, which can be defined as follows:
* Instructions: Text that describes how to complete a task, often offering numbered steps. Examples include how to download software or assemble a product.{{sfn|Balzotti|2022|p=167}}
* Specifications: Communications that deliver technical details on how a product is put together or a specific operation is executed. Also known as "specs," these texts may be written by engineers or technicians.{{sfn|Johnson-Sheehan|2018|p=205}}
* Procedures and Protocols: Guidelines to ensure consistency, quality, and safety in the workplace. For example, a hospital may provide staff with procedures on how to adapt operations during an emergency, such as a power outage.{{sfn|Johnson-Sheehan|2018|p=205}}

=== Email ===
Emails are the primary form of communication in the workplace, used for both internal and external communication. They facilitate information exchange, idea exchange, and activity coordination.{{sfn|Lannon|Gurak|2020|p=335}} Emails should be brief, concise, readable, and targeted to specific audiences with specific subject lines.{{sfn|Lannon|Gurak|2020|p=348}}

=== Letters ===
Letters are a traditional form of communication most often used by employees to communicate with individuals outside of a company or organization. They are typically written on company letterhead. Today, letters are sent either by U.S. mail or electronically.{{sfn|Johnson-Sheehan|2018|p=139}}

=== Memos ===
A memo (short for memorandum) is an official communication, usually a message from the company, a manager or director, or another person or group acting in an official capacity, used to communicate with others within the same organization.{{sfn|Lannon|Gurak|2020|p=353}}

=== 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}}

=== Proposals ===
A proposal is a document that identifies an existing problem or opportunity and outlines a comprehensive strategy for addressing it. Organizations create ''internal'' proposals to describe programs and projects that meet specific operational needs, such as a plan to replace an outdated software system. Companies develop ''external'' proposals for potential customers or clients. These documents detail new products, services, or initiatives that a company will implement to address a specific customer concern.{{sfn|Johnson-Sheehan|2018|p=245}}

=== Reports ===
A report is a concise, easily understandable document that presents technical information in a clear, organized format, allowing readers to access varying levels of information. Reports are categorized as informal, such as briefs, and formal, such as research, scientific, and completion reports.{{sfn|Johnson-Sheehan|2018|loc=chpt 10 & 11}}

==== Informal or Brief Reports ====
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.
* 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.
* Laboratory Reports describe experiments, tests, or inspections.

==== Formal Reports ====
A formal report is a factual and data-driven response to a research question.
* Research reports present the findings of a study.
* Scientific research reports outline the process, progress, and results of technical or scientific research or the current state of a research problem.
* Completion reports assess the outcomes of a project or initiative and provide feedback to management or the client.

=== 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.

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}}

=== 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}}

==Search Engine Optimization (SEO)==
SEO refers to the practice of optimizing online content to enhance its visibility and ranking on search engine results pages (SERPs), making it a crucial skill for digital writers.{{sfn|Lucas|2023b}} To optimize content for SEO means to have the goal of SEO in mind at the time of designing, creating, and writing a web page for publication. Using keywords and alt-text are two examples of optimizing content for SEO.{{sfn|Barr|2010|loc=chpt. 17}}

===Keywords===
Keywords are the words that search engines crawl a website for and index as the page's most important words. Based on other pages using the same keywords, the website is added into the search engine results pages from best matches to worst matches. The position of a website in search results is influenced by where it ranks on a scale determined by the keywords that a user searches for.{{sfn|Lucas|2023b}} To optimize a website's keywords, you should begin with researching keywords on your own website and ensure that you have an XML [https://en.wikipedia.org/wiki/Sitemaps sitemap] so search engines such as [https://en.wikipedia.org/wiki/Google Google] can crawl your web pages for updated information. In addition to using keywords, updating a page's metadata information can also help with showing up on SERPs. Using title and header tags as well as meta descriptions for content also helps optimize a website's ratings in SERPs.{{sfn|Lucas|2023b}}

===Alt-Text===
Alt-Text (alternative text), or [https://en.wikipedia.org/wiki/Alt_attribute Alt Attributes], is a practice that increases the usability and accessibility of a web page for users. Alt-Text is often used for visual elements that cannot be displayed in a different format but still provides description of the element for screen readers or users that may have a disability. Alt-Text also improves a website's SEO as a form of content optimization.{{sfn|Lucas|2023b}}

===Social Media Presence===
Sharing content from a website across different social media platforms is another way to create SEO optimization. This technique can help with being seen as legitimate and improves visibility of the website overall. Additionally, it can drive traffic and enables back-linking to occur when other websites have the ability to also link to the website.{{sfn|Lucas|2023b}}

=== Goals of Searching: The User's Perspective===
A user of search engines formulates queries by using keywords or posing questions. One of the most important elements of building an SEO strategy for a website is developing a thorough understanding of the psychology of your target audience and how they use words and concepts to obtain information about the services and/or products you provide. Once you understand how the average search engine user—and, more specifically, your target audience—utilizes query-based search engines, you can more effectively reach and keep those users.{{sfn|Enge|Spencer|Stricchiola|2022|p=9}}

==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}}

===Characteristics of Digital Documents===

====Electronic Format ====
Digital documents exist in electronic formats, which means they are stored and transmitted as binary data. This format allows for efficient storage, retrieval, and transmission of information via electronic devices.{{sfn|Lucas|2023c}} Digital documentation is the only method to meet a critical challenge of the relatively new concept of "knowledge management" that applies to all organizations. A digital knowledge management system is crucial to an organization so everyone can access information created by employees who are no longer with the organization or to allow cross-referencing with other seemingly unrelated departments.{{sfn|IBM}}

====Non-Tangible====
Unlike paper documents, digital documents lack physical presence. They are intangible and exist as electronic files, residing on devices or in the cloud.{{sfn|Lucas|2023c}}

====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}} It is a legal requirement to include accessibility features in website design.{{sfn|WCAG|2023}} It is also ethically imperative to make sure there is accessibility in digital writing. 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}} Accessibility broadens the reach of digital content and reaches a wider audience. This is important for technical writers, as their documentation and instructions are critical resources for users of varied abilities.

====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|Burnett|Benson|1999|p=207}} The other four Cs are coherent, concrete, correct and complete.{{sfn|Last|2019}}

====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 implementing visual elements, white space, concise language, highlighting, and emphasis.

====Ease of Reproduction and Distribution====
Digital documents are easily copied and distributed. They can be duplicated without any loss of quality, making it simple to share information widely and at minimal cost.{{sfn|Lucas|2023c}}

====Hyperlinking ====
Hyperlinking is a quick and efficient method for directing readers to relevant information in digital documents, facilitating seamless navigation between sections, references, and external resources.{{sfn|Carroll|2010|p=79}}

====Multimedia====
Digital documents can incorporate multimedia elements like images, audio, video, and interactive content, enhancing engagement through visual and auditory elements. Multiple media formats work best when sharing new, complicated ideas.{{sfn|Carroll|2010|p=36}} Increasing multimodality on a website improves engagement, usability, and accessibility. This can improve the impact of the website's standings in SERPs.{{sfn|Carroll|2010|p=280}}

====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}}

====Remote Collaboration====
One form of collaborative technical writing is a wiki, which is a "website developed collaboratively by a community of users, allowing any user to add and edit content."{{sfn|Lucas|2021}} One of the predominant elements of a wiki is that it is defined as being open source. As a result, anyone can modify it regardless of their geographic locations.

====Security Measures====
Digital documents can be protected with encryption, passwords, and access controls to safeguard sensitive information. These security measures enhance data protection and privacy.{{sfn|Lucas|2023c}}

====Environmental Impact====
Digital documents have a smaller environmental footprint compared to paper documents, as they reduce the need for paper production, printing, and transportation.{{sfn|Lucas|2023c}}

====Dynamic Updates====
Online digital documents can be updated dynamically, ensuring that users always have access to the most current information. This is particularly valuable in fast-changing fields.{{sfn|Lucas|2023c}}

====Global Accessibility====
Digital documents can be shared globally, transcending geographical boundaries and time zones. They support international collaboration and the dissemination of knowledge on a global scale.{{sfn|Lucas|2023c}}

====Data Integration====
In business and research settings, digital documents can integrate with databases and data analysis tools. This integration streamlines data collection, analysis, and reporting processes.{{sfn|Lucas|2023c}}

====Data Analytics ====
Digital documents can be subjected to data analytics techniques, allowing organizations to extract valuable insights from large volumes of textual data, which can inform decision-making and strategy.{{sfn|Lucas|2023c}}

==Examples of Digital Documents==
In technical and professional writing, digital documentation takes various forms. These methods streamline the sharing of technical information, enhance collaboration, and ensure easy accessibility within professional settings, contributing to efficient communication and knowledge dissemination.

=== Infographics ===
Infographics, shared as digital documents, typically combine text, graphics, and illustrations to convey complex concepts or data in a concise and visually appealing format. Infographics are often used to simplify information, making it more accessible to a broader audience, and are found in presentations, reports, websites, and educational materials.{{sfn|Lannon|Gurak|2020|pp=292-293}}

=== Presentations ===
Presentations created with [https://en.wikipedia.org/wiki/Microsoft_PowerPoint PowerPoint] or [https://en.wikipedia.org/wiki/Google_Slides Google Slides] are vital for professional communication and knowledge sharing. They condense complex information into visually appealing slides for effective presentations by using photos, videos, graphics, charts, and graphs.{{sfn|Parkinson|2018|loc=chpt. 4}}

=== Blogs ===
A blog, short for "weblog," is an informational website organized into short articles called posts, typically chronologically ordered series of website updates, written and organized similar to a traditional diary.{{sfn|Bair|2014|p=7}} They are regularly updated, providing readers with insights on a specific topic or subject. Blogs serve various purposes, including sharing opinions, providing news, offering educational content, and documenting personal experiences.{{sfn|Rose|Garret|2012|p=2}}

==User Experience==
User experience (UX) is how a product works from the perspective of the user. Digital documents can be created with efficient user experiences by practicing several design methods, including user-centered design, information architecture, responsive design, and usability.

===User-Centered Design===
The approach of user-centered design (UCD) in technical writing consists of the following methodology{{sfn|Lucas|2023e}}:

* User Research: the act of conducting thorough research through surveys, interviews, and usability testing to gain a better understanding of user needs and experiences when using a digital document
* Ideation and prototyping: the process of creating digital designs and prototypes to assist with exploring possible solutions to meet user needs
* Usability testing: the act of having users interact with digital document designs and recording and adjusting the design based on user feedback
* Implementation: the stage in which the design is implemented after making adjustments from prior testing
* Evaluation: the stage in which the digital document is assessed to ensure that it is meeting user needs
* Maintenance and updates: to maintain a digital document based on user feedback and changing needs

===Information Architecture===

To ensure a digital document has effective UX design and accessible information, technical writers need to construct a clear and organized information architecture (IA). IA is a design principle that organizes information so that it is easily found and understood by users, prioritizing their needs and reducing information overload. A design challenge is making IA understood across multiple digital experiences, changing the navigation structure to fit different medias while staying logical and consistent for the user.{{sfn|Rosenfeld|pp=1, 17-18}} IA that is not constructed well can confuse the user and could cause them to give up their search of information in frustration.{{sfn|Garrand|pp=12}}

The architecture components of IA can be divided into four different categories:{{sfn|Rosenfeld|pp=90}}

*Organization systems: how information is categorized and organized for user understanding

*Labeling systems: how information is represented

*Navigation systems: how users browse information and navigate between pages

*Searching systems: how users search for specific information

=== Responsive Design ===

Responsive design is a strategy that appropriately updates the layout and content of a website or document in relation to the screen size, device, and/or orientation, allowing the site or document to be easily viewed and navigated regardless of device used. With the increased use of mobile devices, web content should be constructed with proper responsive web design (RWD) to ensure effective UX and usability on those devices.{{sfn|Robbins| pp=485}}

There are several design strategies that can be implemented that will increase the success of RWD:{{sfn|Robbins| pp=487}}

*Fluid layout – Responsive sites can be constructed using a fluid layout (or flexible grid) system that will allow content to adjust and flow according to the available screen space.

*Flexible and responsive images – Images and other embedded media can be instructed so that they fit their containers instead of remaining at a fixed size. Images with varying resolutions can also be swapped according to screen size to avoid high-resolution images on smaller devices.

*CSS media queries – Media queries can be written into the CSS (Cascading Style Sheet), which would instruct the construction of the site according to screen width and orientation. Adding breakpoints for several screen sizes allows pages to be designed for specific devices.

*Content hierarchy – Carefully constructing content that is organized for the user and creating a hierarchy of content that prioritizes user needs is necessary to ensure effective user experience and navigation across multiple screen sizes.{{sfn|Robbins| pp=499}}

===Usability===

Technical writers must create documents and websites that meet the expectations of their readers and users, and in doing so, writers increase the usability of their site or document.{{sfn|Garrand|pp=26}} Usability can be applied with visual aids, clear and concise language, and structured design.

==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|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|Society for Technical Communication|2023a}} The STC promotes adherence to a list of ethical principles. They are legality, honesty, confidentiality, quality, fairness, and professionalism.{{sfn|Society for Technical Communication|2023b}}

Technical communicators also have to be careful to avoid plagiarism, or taking ideas, thoughts, or words from someone else and passing them off as one's own.{{sfn|Carroll|2010|p=280}}

Technical communicators have ethical standards to which they must abide. The standards are divided into three primary categories. They are the employer, the public, and the environment.{{sfn|Markel|2009}}

===The Employer===
Obligations to one's employer include competence and diligence, honesty and candor, confidentiality, and loyalty.{{sfn|Markel|2009}} The technical communicator must adhere to these obligations so that he/she does not harm the reputation or operation of the employer.

Technical communicators may occasionally work for an organization with strict privacy policies that prohibit them from using the documents they create outside of the organization. It is important for ethical communicators to follow the privacy policy for their organization because unauthorized release of information could lead to consequences up to and including termination.{{sfn|Balzotti|2022|p=83}}

=== The Public===
Organizations are obligated to treat customers fairly. Technical communicators must convey that the products or services an organization sells are safe and effective.{{sfn|Markel|2009}}

===The Environment===
Technical communicators have an obligation to the environment. This obligation includes alerting their supervisors, managers, and executive leadership to products or processes that are detrimental to the environment. Protecting the environment can be costly, however, and organizations may consider ignoring legal guidelines to save money.{{sfn|Markel|2009}} Yet, failure to adhere to U.S. Environmental Protection Agency regulations also has financial implications. For example, the penalty for mishandling hazardous waste is five years and/or up to $50,000 for each day of the violation.{{sfn|EPA|2023}}

=== Disinformation ===
One major ethical concern in all forms of writing, but especially in digital writing, is the creation and spread of disinformation. Disinformation, often referred to as "[[w:Fake news|fake news]]," is information that is purposefully spread as false or misleading and is a sub-type of misinformation.{{sfn|Lawrence|2022|loc=section 3.7}} Modern communication technologies allow for the spread of information to occur at a fast pace. Social media is one area where the spread of disinformation occurs regularly.

Some social media sites, such as Facebook, have begun to flag certain articles posted on the site as being questionable in their representation of facts or occurrences. Despite the widespread understanding and use of disinformation available today, digital writers need to be aware of their intent and the audience's needs and wants from their digital communication.{{sfn|Lucas|2023f}} Ethical considerations regarding citing sources, cross-referencing information, and using primary sources are good practices for maintaining ethical standing and credibility as a digital writer.

To help mitigate the problem of disinformation, technical writers should utilize gatekeepers. These individuals verify the accuracy of the information before it is distributed to primary readers. This helps protect the author from any ethical and/or legal issues.{{sfn|Balzotti|2022|p=83}}

==Pedagogical Approaches==
===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}}

===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}}

===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}}

==Future Trends and Challenges==
=== Future Trends===
Between 2022 and 2032, the [https://en.wikipedia.org/wiki/Bureau_of_Labor_Statistics, United States Bureau of Labor Statistics] is projecting a 7% job growth for technical writers.{{sfn|United States Bureau of Labor Statistics|2023}} To be relevant as a technical writer in the digital age, one must possess the skills of conducting in-depth research, critical thinking, being detail oriented, design, and technical expertise. To succeed at communicating the complex to specific audiences, the technical writer must understand much of the subject in its complexity. This is accomplished through possessing the skills of communication, collaboration, and teamwork.{{sfn|Fechter|2023}}

===Challenges===
Barriers to teaching technical communications include the speed at which digital tools evolve, the complexity of software,{{sfn|Hovde|Renguette|2017|pp=395-411}} and the dependency on input information accuracy. Outdated, incorrect, or inconsistent data delays the publication, requires more reparative efforts, and decreases productivity.{{sfn|Ajose-Coker|2022}} Also, technical writers often have to contend with complex, outdated or unsuitable tools. This can make their job more difficult and time-consuming, and can lead to frustration and errors.{{sfn|Ajose-Coker|2022}}

===Artificial Intelligence===
Artificial intelligence programs, utilizing natural language processing, are capable of producing technical writing and have advanced in recent years becoming more adept.{{sfn|Marr|2023}}

One such program is [https://en.wikipedia.org/wiki/ChatGPT ChatGPT], which uses machine learning to produce texts with human-like style and tone.{{sfn|University of Central Arkansas|2023}} Another leader in this area, Contentbot, uses a WordPress plugin which gives blog writers ideas to enhance their posts which are shared via email.{{sfn|Siddiqui|2022}}

===Plagiarism===
Because of the ability of chatbots to imitate human-like language, some education administrators have taken precautions to minimize the occurrence of students passing off artificially generated texts as their own. In some instances, educators have taken the view that material drawn from artificial intelligence software must be handled in the same way as sources from human authors.{{sfn|Klein|2023}} In such cases, students who incorporate artificially generated text into their work have been made to denote credit for the artificial intelligence program utilized.

===Credit ===
The advent of chatbots has complicated the issue of credit where creative work is concerned. Because chatbots can simulate human speech, their ability to create cinematic dialogues and other types of creative writing have threatened the credits and financial condition of professional writers. According to an article by Aaron Mok and Jacob Zinkula on ''[https://www.businessinsider.com/ Business Insider]'', writing jobs are among the top 10 roles that AI is most likely to replace.{{sfn|Mok|2023}}

==References==
===Citations===
{{Reflist}}

===Bibliography===
{{Refbegin|30em}} 
* {{cite web |url=https://www.linkedin.com/advice/0/how-can-you-create-effective-visual-aids-1c |title=How Can You Create Effective Visual Aids for Technical Writing? |last=AI and the LinkedIn Community |date=2023 |website=www.linkedin.com |publisher=LinkedIn |access-date=2023-11-05 }}
* {{cite web |url=https://componize.com/common-problems-in-technical-writing-and-how-to-resolve-them/ |title=Common Problems in Technical Writing and How to Solve Them |last=Ajose-Coker |first=Dipo |date=2022 |website=componize.com |publisher=Componize Software |access-date=2023-11-19 }}
* {{cite book |last=Bair|first=Amy Lupold |date=2014 |title=Blogging for Dummies|url=|location=Hoboken, NJ |publisher=Jon Wiley & Sons, Inc|pages=|isbn=|author-link= }}
* {{cite book |last=Balzotti |first=Jon |date=2022 |title=Technical Communication: A Design-Centric Approach |edition= 2nd |url= |location=New York |publisher=Routledge |isbn=9780367438302 }}
* {{cite book |last=Barr |first=Chris |date=2010 |title=The Yahoo! Style Guide |url= |location=New York |publisher=St. Martin's }}
* {{cite book |last=Carroll |first=Brian |date=2010 |title=Writing for Digital Media |url= |location=New York |publisher=Routledge }}
* {{cite book |last1=Coco |first1=Pete |last2=Torres |first2=M. Gabriella |date=2014 |editor-last1=Dougherty |editor-first1=Jack |editor-last2=O'Donnell |editor-first2=Tennyson |title=Web Writing: Why and How for Liberal Arts Teaching and Learning |publisher=University of Michigan Press |pages=175-188 |chapter=“Writing as Curation: Using a ‘Building’ and ‘Breaking’ Pedagogy to Teach Culture in the Digital Age" |chapter-url=https://epress.trincoll.edu/webwriting/chapter/cocotorres |ref=harv }}
* {{cite web |url=https://www.betonconsultingeng.com/objectivity-in-technical-writing/#:~:text=Pointers%20for%20objective%20technical%20writing%201%20If%20you,5%20Remember%20that%20correlation%20is%20not%20causality.%20 |title=Objectivity in Technical Writing |last=Detwiler |first=Rachel |date=2021 |website=www.betonconsultingeng.com |publisher=Beton Consulting Engineers L.L.C. |access-date=2023-11-05 }}
* {{cite book |last=DeVoss |first=Danielle |last2=National Writing Project |last3=Eidman-Aadahl |first3=Elyse |last4=Hicks |first4=Troy |date=2010 |title=Because Digital Writing Matters: Improving Student Writing in Online and Multimedia Environments |location=San Francisco |publisher=Jossey-Bass |pages=105 |isbn= |url=https://openlibrary.org/books/OL34593323M/Because_Digital_Writing_Matters }}
*{{cite book |last=Enge |first=Eric |last2=Spencer |first2=Stephan |last3=Stricchiola |first3=Jessie |date=2022 |title=The Art of SEO: Mastering Search Engine Optimization |url=https://archive.org/details/artofseomasterin0000enge |location=Sebastopol, CA |publisher=O'Reilly |pages=9 }}
* {{cite web |url=https://www.epa.gov/enforcement/criminal-provisions-resource-conservation-and-recovery-act-rcra |title=Criminal Provisions of the Resource Conservation and Recovery Act (RCRA) |date=2023 |publisher=United States Environmental Protection Agency }}
* {{cite web |url=https://technicalwriterhq.com/career/technical-writer/technical-writing-skills/ |title=Essential Technical Writing Skills |last=Fechter |first=Josh |date=2023 |website=technicalwriterhq.com |access-date=2023-11-21}}
* {{cite book |last=Gagich |first=Melanie |last2=Zickel |first2=Emilie |date=n.d. |title=Writing Arguments in Stem |chapter=Rhetorical Appeals: Logos, Pathos, and Ethos Defined |publisher=Digital Commons |url=https://digitalcommons.calpoly.edu/cgi/viewcontent.cgi?article=1000&context=oercoursematerials#page=44 |location= |pages=34-37 }}
* {{cite book |last=Garrand |first=Timothy |date=2006 |title=Writing for Multimedia and the Web: A Practical Guide to Content Development for Interactive Media |edition=3rd |location=Burlington, MA |publisher=Focal Press |ref=harv }}
* {{cite book |last=Garrett |first=Jesse James |title=The Elements of User Experience: User-Centered Design for the Web and Beyond |publisher=New Riders |edition=2nd |date=2011 |location=Berkeley, CA |page=17 }}
* {{cite book |last=Godson |first=Williams|title=Web Design with HTML and CSS |p=37-41}}
* {{cite web |url=https://smashingmagazine.com/2014/08/a-closer-look-at-personas-part-2/ |title=A Closer Look at Personas: A Guide to Developing The Right Ones (Part 2) |last=Goltz | first=Shlomo |date=2014 |website=smashingmagazine.com |publisher=Smashing Media AG |access-date=2023-11-13 }}
* {{cite magazine |last=Grimstead |first=Deborah M. |date=1999 |title=Technical Writers are in Demand: Do You Have The Right Stuff? |magazine=Black Collegian |pages=128 }}
* {{cite journal |last1=Hovde |first1=Marjorie |last2=Renguette |first2=Corinne |date=2017 |title=Technological Literacy: A Framework for Teaching Technical Communication Software Tools |journal=Technical Communication Quarterly |volume=26 |pages=395-411 |doi=10.1080/10572252.2017.1385998}}
* {{cite web |url=https://www.ibm.com/topics/knowledge-management |title=What is Knowledge Management? |first= |last=IBM |website=ibm.com |access-date=2023-11-24}}
* {{cite web |url=https://www.idassoc.com/product-information-definition/data-sheet |title=Product Information Encyclopedia |last=IDA |first= |date=2020 |website=Industrial Data Associates |publisher= |access-date=2023-11-20 |quote= }}
* {{cite book |last=Johnson-Sheehan |first=Richard |title=Technical Communication Today |url= |edition=6 |location=Boston, MA |publisher=Pearson |date=2018 |pages= }}
* {{cite news |last=Klein |first=Alyson |date=2023 |title=ChatGPT Cheating: What to Do When It Happens |url=https://www.edweek.org/technology/chatgpt-cheating-what-to-do-when-it-happens/ |work=Education Week |location=Bethesda, MD |access-date=2023-11-05 }}
* {{cite book |last=Krug |first=Steve |date=2014 |title=Don’t Make Me Think, Revisited|url= |location=Berkeley, CA |publisher=New Riders |pages= |isbn= |author-link= }}
* {{cite book |last=Lannon |first=John M. |last2=Gurak |first2=Laura J. |date=2020 |title=Technical Communication |edition=15 |url= |location= |publisher=Pearson Education |page= }}
* {{cite book |last=Last|first=Susan |date=2019 |title=Technical Writing Essentials|url=https://pressbooks.bccampus.ca/technicalwriting/chapter/communicatingprecision/|location= |publisher= Victoria, B.C. University of Victoria |pages= |isbn= |author-link= }}
* {{cite book |last=Lawrence |first=Dan |date=2022 |title=Digital Writing: A Guide to Writing for Social Media and the Web |location=Peterborough, Ontario, Canada |publisher=Broadview Press |page=85 }}
* {{cite web |url=https://grlucas.net/grl/Writing_on_a_Wiki |title=Writing on a Wiki |last=Lucas |first=Gerald| date=2021| website=grlucas.net| publisher=MediaWiki| access-date=2023-10-31 }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Personas |title= Using Personas in Digital Writing
|last=Lucas |first=Gerald |date=2023a| website=grlucas.net |publisher=MediaWiki |access-date=2023-11-07 }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/SEO |title=Search Engine Optimization: Strategies and Best Practices for Effective Online Visibility |last=Lucas |first=Gerald |date=2023b |website=grlucas.net |publisher=MediaWiki |access-date=2023-11-19 }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Documents|title=Exploring the Dichotomy: A Comparative Analysis of Digital and Paper Documents |last=Lucas |first=Gerald |date=2023c |website=grlucas.net |publisher=MediaWiki |access-date=2023-10-29 |quote= }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Design/Users |title=User-Centered Design in Digital Documents |last=Lucas |first=Gerald |date=2023d |website=grlucas.net |publisher=MediaWiki |access-date=2023-11-15 |quote= }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Style |title=Audience-Centric Style in Digital Writing |last=Lucas |first=Gerald |date=2023e |website=grlucas.net |publisher=MediaWiki |access-date=2023-10-22 |quote= }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Credibility |title=The Significance of Credibility in Digital Writing |last=Lucas |first=Gerald |date=2023f |website=grlucas.net |publisher=MediaWiki |access-date=2023-11-21 }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Tech_Writing |title=Combining Disciplinary Approach to Technical Writing with Digital Writing: Enhancing Communication in the Digital Age |last=Lucas |first=Gerald |date=2023g |website=grlucas.net |publisher=MediaWiki |access-date=2023-11-27 |quote= }}
* {{cite web |url=https://www.indeed.com/career-advice/careers/what-does-a-technical-writer-do |title=What Does a Technical Writer Do? (Plus How To Become One) |last=Macari |first=Sabina |date=2023 |website=indeed.com |publisher=Indeed |access-date=2023-11-05 }}
* {{cite magazine |last=Malone |first=Ed |date=2008 |title=Joseph D. Chapline: Technical Communication's Mozart |url=https://web.mst.edu/~malonee/chapline.pdf |magazine=IEEE Professional Communication Society Newsletter |access-date=2023-10-31 }}
* {{cite journal |last=Malone |first=Edward |date=November 2011 |title=The First Wave (1953-1961) of the Professionalization Movement in Technical Communication |url=https://www.stc.org/techcomm/wp-content/uploads/sites/3/2016/08/november-2011-58-4.pdf |journal=Technical Communication |volume=58 |issue=4 |pages=285-306 |doi= |access-date=2023-10-11 }}
* {{cite book |last=Markel |first=Michael |title=Technical Communication |date=2009 |edition=9th |location=Boston |publisher=Bedford/St. Martin's |pages=22-25 }}
* {{cite book |last=Markel |first=Mike |last2=Selber |first2=Stuart A. |date=2019 |title=Practical Strategies of Technical Communication |edition=3rd |url= |location=Boston |publisher=Bedford/St. Martin’s |page= }}
* {{cite web |url=https://www.forbes.com/sites/bernardmarr/2023/01/23/how-chatgpt-and-natural-language-technology-might-affect-your-job-if-you-are-a-computer-programmer/?sh=6d9acf79174b |title=How ChatGPT And Natural Language Technology Might Affect Your Job If You Are A Computer Programmer |last=Marr |first=Bernard |date=2023 |website=Forbes.com |publisher=Forbes Media |access-date=2023-10-31 |quote= }}
* {{cite web |url=https://www.businessinsider.com/chatgpt-jobs-at-risk-replacement-artificial-intelligence-ai-labor-trends-2023-02 |title=ChatGPT may be coming for our jobs. Here are the 10 roles AI is most likely to replace |last=Mok |first=Aaron |date=2023 |website=Insider |publisher=Business Insider |access-date= 2023-11-05 }}
* {{cite book |last=Mussack |first=Brigitte |date=2021 |title=Introduction to Technical and Professional Communication |url=https://pressbooks.umn.edu/techwriting/front-matter/introduction/ |location= |publisher=Creative Commons Attribution NonCommercial |pages=n.p. |author-link= }}
* {{cite book| last=Parkinson |first=Mike |title=A Trainer’s Guide to PowerPoint: Best Practices for Master Presenters| location=United States| publisher=Association for Talent Development| chapter=Chapter 4. PowerPoint Tips, Tricks, and Secrets| date=2018 }}
* {{cite book |last=Perelman |first=Leslie |date=1998 |title=The Mayfield Handbook of Technical and Scientific Writing |url=https://www.mit.edu/course/21/21.guide/ |location=Mountain View |publisher=Mayfield Publishing Company |pages=n.p. |isbn= |author-link= }}
* {{cite web |url=https://learn.g2.com/how-to-write-a-press-release |title=How to Write a Press Release That Catches People's Attention |date=2021 |last=Pradhan |first=Ninisha |website=learn.g2.com |publisher=G2.com |access-date=2023-11-21 }}
* {{cite web |url=https://proofed.com/writing-tips/a-beginners-guide-to-technical-writing/ |title=A Beginner’s Guide to Technical Writing |last=Proofed Editors |date=2020 |website=Proofed.com |publisher=Proofed |access-date=2023-11-05 }}
* {{cite journal |last=Rathbone |first=Robert |title=Growth of the technical writing profession |journal=STWE Review |volume=5 |issue=1 |date=1958 |pages=5-16 }}
*{{cite book |last=Robbins |first=Jennifer Niederst |date=2018 |title=Learning Web Design: A Beginner’s Guide to HTML, CSS, JavaScript, and Web Graphics (5th ed.) |url= |location=Sebastopol, CA |publisher= O’Reilly Media, Inc. }}
* {{cite book |last=Rose|first=Darren |last2=Garret |first2=Chris|date=2012 |title=ProBlogger: Secrets for Blogging Your Way to a Six-Figure Income|url=|location=Indianapolis, IN |publisher=Jon Wiley & Sons, Inc|pages=|isbn=|author-link= }}
* {{cite book |last1=Rosenfeld |first1=Louis |last2=Morville |first2=Peter |last3=Arango |first3=Jorge |date=2006 |title=Information Architecture for the Web and Beyond |edition=4th |location=Sebastopol, CA |publisher=O'Reilly Media, Inc.}}
* {{cite web |url=https://writingcooperative.com/intricacies-of-ai-tools-can-ai-tools-take-over-the-jobs-of-technical-writers-af36836f625c |last=Siddiqui |first=Zafar |title=Will Best Artificial Intelligence Take Over any Technical Content Writer? |date=2022 |website=writingcooperative.com |publisher=The Writing Cooperative |access-date=2023-11-19 }}
* {{cite web |url=https://www.managementnote.com/features-of-technical-communication/#google_vignette |title=Features of Technical Communication |last=Smirti |date=2022 |website=managementnote.com |publisher=Management Note |access-date= 2023-11-05 }}
* {{cite web |url=https://www.stc.org/about-stc/ |title=About STC |last=Society for Technical Communication |first= |date=2023a |website=stc.org |publisher= |access-date=2023-10-27 }}
* {{cite web |url=https://www.stc.org/about-stc/ethical-principles/ |title=Ethical Principles |last=Society for Technical Communication |first= |date=2023b |website=stc.org |publisher= |access-date=2023-10-27 }}
* {{cite web |url=https://www.bls.gov/ooh/media-and-communication/technical-writers.htm#tab-6 |title=Occupational Outlook Handbook |last=United States Bureau of Labor Statistics |first= |date=2023 |website=bls.gov |publisher=United States Department of Labor |access-date=2023-11-07 }}
* {{cite web |url=https://uca.edu/cetal/chat-gpt/ |title=Chat GPT: What is it? |last=University of Central Arkansas |first= |date= |website=uca.edu |publisher= University of Central Arkansas |access-date=2023-10-09 }}
* {{cite web |url=https://www.viralnation.com/blog/what-is-digital-content-creation-and-how-can-it-help-me-as-a-marketing-manager/#:~:text=A%20rule%20of%20thumb%20in%20digital%20content%20creation,turn%2C%20share%20it%20with%20others%20in%20their%20network. |title=What is Digital Content Creation? (and How Can It Help Me as a Marketing Manager) |last=Viral Nation |date=2019 |website=viralnation.com |publisher= Viral Nation |access-date=2023-11-05 }}
* {{cite web |url=https://www.w3.org/WAI/fundamentals/accessibility-intro/|title=Introduction to Web Accessibility |last=WAI |first=|date=2022 |website=W3.org|publisher= |access-date= 2023-10-26 |quote= }}
* {{cite web |url=https://scribehow.com/library/user-guide |title=What is a User Guide? Everything You Need to Know |last=Wainaina |first=Timan |date=2022 |website= |publisher= |access-date=22 November 2023 |quote= }}
* {{cite web |url=https://wcag.com/legal/|title=Accessibility and the Law |last=WCAG |first= |date=2023 |website=wcag.com|publisher=eSSENTIAL Accessibility |access-date= 2023-10-26 |quote= }}
* {{cite book |last=Zeleznik |first=J. M. |last2=Burnett |first2=R. E. |last3=Benson |first3=P. J. |date=1999 |title=Technical Writing: What It Is and How to Do It |url= |location= |publisher=National Book Network |pages=107 |isbn= |author-link= }}

{{Refend}}

[[Category:Fall 2023]]
[[Category:ENGL 5106]]

Technical Writing in the Digital Age

2023-11-23T03:01:29Z

APitts: /* Bibliography */

'''Technical Writing in the Digital Age''' represents the dynamic and evolving discipline of creating written materials that convey complex information, instructions, and technical concepts in the context of contemporary digital technologies. Its purview encompasses the creation, dissemination, and management of technical documents and content within an expansive digital landscape.

Major considerations revolve around adapting traditional principles of rhetoric to digital platforms, ensuring effective communication in an era defined by rapid technological advancements. 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. The use of multi-modality and the interfacing of multiple media platforms and sources also plays a role in digital technical writing. In essence, technical writing in the digital age encapsulates the art and science of conveying technical information in a manner that is comprehensible and accessible to diverse audiences in our digitally driven society.

==Overview==

=== Aims of Technical Communication ===
As much as technical communication is a discipline in and of itself, it also exists within many other disciplines. Examples of technical communication communities can be found among such fields as varied as education, business, and science. Technical documentation within any domain typically embodies a similar aim: to help its audience act toward some sort of task or goal. {{sfn|Markel|Selber|2019}}

=== Characteristics of Technical Communication ===
Because technical communication is intended to guide an audience, it must be assembled in such a way that it is very 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.

== 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}}

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

==== Case Studies ====
Case studies are a form of empirical or observational research that consists of in-depth examination of distinct individuals, groups, events, or scenarios. This research can be used to generate qualitative or quantitative data. {{sfn|Johnson-Sheehan|2018|pp=401-404}}

==== Data Sheets ====
A data sheet, also known as a technical datasheet, is a document used to describe and summarize the characteristics of a product, material, component, or technology. {{sfn|IDA|2020|p=}}

====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}}

*Product: provides detailed information about a specific item, including its features, specifications, and benefits.
*Process: provides step-by-step instructions on how to perform a particular task or achieve a specific outcome.

==== Documentation ====
Documentation comprises various texts that allow users to accomplish tasks or gain information. It generally falls into three categories, which can be defined as follows:
* Instructions: Text that describes how to complete a task, often offering numbered steps. Examples include how to download software or assemble a product.{{sfn|Balzotti|2022|p=167}}
* Specifications: Communications that deliver technical details on how a product is put together or a specific operation is executed. Also known as "specs," these texts may be written by engineers or technicians.{{sfn|Johnson-Sheehan|2018|p=205}}
* Procedures and Protocols: Guidelines to ensure consistency, quality, and safety in the workplace. For example, a hospital may provide staff with procedures on how to adapt operations during an emergency, such as a power outage.{{sfn|Johnson-Sheehan|2018|p=205}}

==== Email ====
Emails are the primary form of communication in the workplace, used for both internal and external communication. They facilitate information exchange, idea exchange, and activity coordination.{{sfn|Lannon|Gurak|2020|p=335}} Emails should be brief, concise, readable, and targeted to specific audiences with specific subject lines.{{sfn|Lannon|Gurak|2020|p=348}}

==== Letters ====
Letters are a traditional form of communication most often used by employees to communicate with individuals outside of a company or organization. They are typically written on company letterhead. Today, letters are sent either by U.S. mail or electronically. {{sfn|Johnson-Sheehan|2018|p=139}}

==== Memos ====
A memo (short for memorandum) is an official communication, usually a message from the company, a manager or director, or another person or group acting in an official capacity, used to communicate with others within the same organization. {{sfn|Lannon|Gurak|2020|p=353}}

==== 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}}

==== Proposals ====
A proposal is a document that identifies an existing problem or opportunity and outlines a comprehensive strategy for addressing it. Organizations create ''internal'' proposals to describe programs and projects that meet specific operational needs, such as a plan to replace an outdated software system. Companies develop ''external'' proposals for potential customers or clients. These documents detail new products, services, or initiatives that a company will implement to address a specific customer concern.{{sfn|Johnson-Sheehan|2018|p=245}}

==== Reports ====
A report is a concise, easily understandable document that presents technical information in a clear, organized format, allowing readers to access varying levels of information. Reports are categorized as informal, such as briefs, and formal, such as research, scientific, and completion reports. {{sfn|Johnson-Sheehan|2018|loc=chpt 10 & 11}}

===== Informal Reports =====
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. Brief reports are categorized into three subcategories:

* Progress reports inform management about the progress or status of a project.
* White papers educate management or clients about important issues.

===== Formal Reports =====
A formal report is a factual and data-driven response to a research question.
* Research reports present the findings of a study.
* Scientific research reports outline the process, progress, and results of technical or scientific research or the current state of a research problem.
* Completion reports assess the outcomes of a project or initiative and provide feedback to management or the client.

==== Resumes ====
Résumés 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 résumés demonstrate the sequence of education and employment history and detail a person’s tasks, responsibilities, and achievements in each successive role. Skills résumés 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 ====
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}}

==Features of Technical Communication==
Technical communication involves conveying complex information to a specific audience. Key features include accuracy, attention to detail, visuals, and clear and concise organization to enhance user understanding. {{sfn|Smirti|2022}}

=== Accuracy ===

==== Standards Compliant ====
Many technical fields have industry-specific regulations and guidelines which are determined by governing bodies and that also have an impact on their technical communication. Furthermore, many organizations may have a style guide that outlines preferred language usage, tone, and formatting. {{sfn|Smirti|2022}}

==== Detailed ====
Accurate information that is delivered with precision and specificity is essential to providing communication that is unambiguous and free of discrepancies. {{sfn|Smirti|2022}} It is free of errors and inconsistencies.

==== Objective ====
Objective communication is presented in an unbiased and impartial manner and is free of personal opinions. It relies upon facts and evidence and avoids an overly emotional tone. This approach is particularly important in fields where accuracy and impartiality are essential. {{sfn|Detwiler|2021}}

===== Clear and Concise =====
Clear language is organized logically, is not unnecessarily involved, and is easily understood by the target audience. It will avoid needless jargon and complexity. Good technical communication expresses meaning in a way that is straightforward and that avoids redundant words or excessive explanations. It is easy to both absorb and process. {{sfn|Smirti|2022}} {{sfn|Proofed Editors|2020}}

=== Soundness ===

==== Formatted and Organized ====
Technical documents should be formatted in a way that is consistent with the norms and standards of applicable professional fields. Additionally, formatting should adhere to guidelines which enhance usability. Information should be logically organized for easy reading comprehension. This may involve using headings, subheadings, bullet points, and numbered lists. Formatting detail should remain consistent throughout the document. {{sfn|Smirti|2022}} {{sfn|Proofed Editors|2020}}

==== Graphical ====
Technical communication utilizes visuals strategically to facilitate understanding of textual content. Visuals such as diagrams, charts, graphs or images can enhance understanding on a technical document. When presented properly, they can elucidate difficult concepts and make material accessible to a more diverse audience. {{sfn|AI and the LinkedIn Community|2023}}

=== Appropriateness ===

==== Audience-specific ====
Where possible, technical communication should be customized to align with the knowledge and needs of its audience. Communication style and tone should be tailored to match the audience's level of expertise and should take into consideration such factors as the the users' technical background, familiarity with the subject, and specific requirements. {{sfn|Viral Nation|2019}}

==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}} And 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}}

== Digital Technologies and Technical Writing==
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 thus, it can be accessed by anyone with access to the internet. Such a phenomenon can be exploited to increase the audience of a virtual document.

There are several web-based tools and techniques which allow digital documents to be more easily shared. Online word processors such as [https://www.google.com/docs/about/ Google Docs] and [https://www.microsoft.com/en-us/microsoft-365/sharepoint/collaboration SharePoint] allow documents to be readily disseminated. Comment capability allows audience members to interact about a document with one another as well as with the document author. Relationships created by such online interaction fosters an environment whereby online authors might choose to link the works of various others to their own personal websites. In all, technical documentation posted online can grow a considerable audience over time. However, many aspects of effective technical writing, such as clarity, conciseness, completeness, and correctness, still need to be applied to technical writing created for digital interfaces. {{sfn|Carroll|2010|p=24}}

==Personas in Digital Writing==
Personas in the context of digital writing refer to semi-fictional characters that encapsulate the characteristics, behaviors, and needs of target audience segments. They align closely with the principles of user-centered design (UCD).{{sfn|Lucas|2023a}}
There are myriad ways to integrate user-centered thinking into the creative process of UX design, and personas are one of the most effective ways to empathize with and analyze users.{{sfn|Goltz|2014}}

==Rhetorical Strategies in the Digital Age==
Rhetoric is a communication strategy whose primary goal is to persuade an audience. It is grounded in three foundational concepts first defined by the Greek philosopher Aristotle. These concepts are ''logos'', which engages with the reader’s sense of logic or reason; ''pathos'', which appeals to the reader’s emotions; and ''ethos'', which addresses the audience’s values and the writer’s credibility. Within this framework, writers utilize specific techniques or devices to influence and engage readers. Examples include appealing to an audience’s sense of logic by using factual examples to support a point or evoking emotion through descriptive visual language. {{sfn|Gagich|Zickel|n.d.|pp=34-37}}

In today’s digital age, writers can use digital technologies as rhetorical devices to influence the reader. Electronic images and informational graphics can be incorporated into digital and online documents to illustrate or reinforce points made in the text.{{sfn|Markel|Selber|2019}} Hyperlinks can be used to provide additional information that supports the author's ideas. Nevertheless, the writer's basic task of informing and persuading an audience is the same in digital communication as in other forms of writing.{{sfn|DeVoss|National Writing Project|Eidman-Aadahl|Hicks|2010|p=105}}

Rhetorical analysis involves analyzing the demographics and habits of an intended audience. The information gathered allows writers to craft messages that appeal to the target audience. In the digital age, websites and social media platforms convey rhetorical messages.{{sfn|Lawrence|2022|pp=6-14}}

==Search Engine Optimization (SEO)==
SEO refers to the practice of optimizing online content to enhance its visibility and ranking on search engine results pages (SERPs), making it a crucial skill for digital writers.{{sfn|Lucas|2023b}} To optimize content for SEO means to have the goal of SEO in mind at the time of designing, creating, and writing a web page for publication. Using keywords and alt-text are two examples of optimizing content for SEO. {{sfn|Barr|2010|loc=chpt. 17}}

=== Keywords ===
Keywords are the words that search engines crawl a website for and index as the page's most important words. Based on other pages using the same keywords, the website is added into the search engine results pages from best matches to worse matches. Depending on where the website falls in that scale based on the specific keywords being searched by a user, influences where the website pops up in the associated search results.{{sfn|Lucas|2023b}} To optimize a website's keywords, you should begin with researching keywords on your own website and ensure that you have an XML [https://en.wikipedia.org/wiki/Sitemaps sitemap] so search engine's such as [https://en.wikipedia.org/wiki/Google Google] can crawl your web pages for updated information. In addition to using keywords, updating a page's metadata information can also help with showing up on SERPs. Using title and header tags as well as meta descriptions for content also helps optimize a website's ratings in SERPs.{{sfn|Lucas|2023b}}

=== Alt-Text ===
Alt-Text (alternative text), or [https://en.wikipedia.org/wiki/Alt_attribute Alt Attributes], is a practice that increases the usability and accessibility of a web page for users. Alt-Text is often used for visual elements that cannot be displayed in a different format but still provides description of the element for screen readers or users that may have a disability. Alt-Text also improves a website's SEO as a form of content optimization.{{sfn|Lucas|2023b}}

=== Social Media Presence ===
Sharing content from a website across different social media platforms is another way to create SEO optimization. This technique can help with being seen as legitimate and improves visibility of the website overall. Additionally it can drive traffic and enables back-linking to occur when other websites have the ability to also link to the website.{{sfn|Lucas|2023b}}

=== Goals of Searching: The User's Perspective ===
A user of search engines formulates queries by using keywords or posing questions. One of the most important elements of building an SEO strategy for a website is developing a thorough understanding of the psychology of your target audience, and how they use words and concepts to obtain information about the services and/or products you provide. Once you understand how the average search engine user—and, more specifically, your target audience—utilizes query-based search engines, you can more effectively reach and keep those users. {{sfn|Enge|Spencer|Stricchiola|2022|p=9}}

==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}}

===Characteristics of Digital Documents===

==== Electronic Format ====
Digital documents exist in electronic formats, which means they are stored and transmitted as binary data. This format allows for efficient storage, retrieval, and transmission of information via electronic devices.{{sfn|Lucas|2023c}}

==== Non-Tangible ====
Unlike paper documents, digital documents lack physical presence. They are intangible and exist as electronic files, residing on devices or in the cloud.{{sfn|Lucas|2023c}}

====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}} 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====
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====
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}}

==== Ease of Reproduction and Distribution ====
Digital documents are easily copied and distributed. They can be duplicated without any loss of quality, making it simple to share information widely and at minimal cost.{{sfn|Lucas|2023c}}

====Hyperlinking====
Hyperlinking is a quick and efficient method for directing readers to relevant information in digital documents, facilitating seamless navigation between sections, references, and external resources.{{sfn|Carroll|2010|p=79}}

====Multimedia====
Digital documents can incorporate multimedia elements like images, audio, video, and interactive content, enhancing engagement through visual and auditory elements. Multiple media formats work best when sharing new, complicated ideas.{{sfn|Carroll|2010|p=36}} Increasing multimodality on a website improves engagement, usability, and accessibility. This can improve the impact of the website's standings in SERPs.{{sfn|Carroll|2010|p=280}}

====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}}

==== Remote Collaboration ====
One form of collaborative technical writing is a wiki, which is a "Web site developed collaboratively by a community of users, allowing any user to add and edit content.{{sfn|Lucas|2021}} One of the predominant elements of a wiki is that it is defined as being open source. As a result, anyone can modify it regardless of their geographic locations.

==== Security Measures ====
Digital documents can be protected with encryption, passwords, and access controls to safeguard sensitive information. These security measures enhance data protection and privacy.{{sfn|Lucas|2023c}}

==== Environmental Impact ====
Digital documents have a smaller environmental footprint compared to paper documents, as they reduce the need for paper production, printing, and transportation.{{sfn|Lucas|2023c}}

==== Dynamic Updates ====
Online digital documents can be updated dynamically, ensuring that users always have access to the most current information. This is particularly valuable in fast-changing fields.{{sfn|Lucas|2023c}}

==== Global Accessibility ====
Digital documents can be shared globally, transcending geographical boundaries and time zones. They support international collaboration and the dissemination of knowledge on a global scale.{{sfn|Lucas|2023c}}

==== Data Integration ====
In business and research settings, digital documents can integrate with databases and data analysis tools. This integration streamlines data collection, analysis, and reporting processes.{{sfn|Lucas|2023c}}

==== Data Analytics ====
Digital documents can be subjected to data analytics techniques, allowing organizations to extract valuable insights from large volumes of textual data, which can inform decision-making and strategy.{{sfn|Lucas|2023c}}

==Examples of Digital Documents==
In technical and professional writing, digital documentation takes various forms. These methods streamline the sharing of technical information, enhance collaboration, and ensure easy accessibility within professional settings, contributing to efficient communication and knowledge dissemination.

==== Infographics ====
Infographics, shared as digital documents, typically combine text, graphics, and illustrations to convey complex concepts or data in a concise and visually appealing format. Infographics are often used to simplify information, making it more accessible to a broader audience, and are found in presentations, reports, websites, and educational materials. {{sfn|Lannon|Gurak|2020|pp=292-293}}

==== Presentations ====
Presentations created with [https://en.wikipedia.org/wiki/Microsoft_PowerPoint PowerPoint] or [https://en.wikipedia.org/wiki/Google_Slides Google Slides] are vital for professional communication and knowledge sharing. They condense complex information into visually appealing slides for effective presentations by using photos, videos, graphics, charts, and graphs.{{sfn|Parkinson|2018|loc=chpt. 4}}

==== Blogs ====
A blog, short for "weblog," is an informational website organized into short articles called posts, typically chronologically ordered series of website updates, written and organized similar to a traditional diary.{{sfn|Bair|2014|p=7}} They are regularly updated, providing readers with insights on a specific topic or subject. Blogs serve various purposes, including sharing opinions, providing news, offering educational content, and documenting personal experiences.{{sfn|Rose|Garret|2012|p=2}}

==User Experience==
User experience is how a product works from the perspective of the user. Digital documents can be created with efficient user experiences by focusing on user-centered design. {{sfn|Garrett|2011|p=17}}

=== User-Centered Design ===
The approach of user-centered design (UCD) in technical writing consists of the following methodology{{sfn|Lucas|2023e}}:

==== User Research ====
User research is the act of conducting thorough research through surveys, interviews, and usability testing to gain a better understanding of user needs and experiences when using a digital document.

==== Ideation and Prototyping ====
Ideation and prototyping refers to the process of creating digital designs and prototypes to assist with exploring possible solutions to meet user needs.

==== Usability Testing ====
Usability testing refers to the act of having users interact with digital document designs and recording and adjusting the design based on user feedback.

==== Implementation ====
Implementation is the stage in which the design is implemented after making adjustments from prior testing.

==== Evaluation ====
Evaluation refers to the stage in which the digital document is assessed to ensure that it is meeting user needs.

==== Maintenance and Updates ====
Maintenance and updates are required in order to maintain a digital document based on user feedback and changing needs.

==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|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|Society for Technical Communication|2023a}} The STC promotes adherence to a list of ethical principles. They are legality, honesty, confidentiality, quality, fairness, and professionalism.{{sfn|Society for Technical Communication|2023b}}

Technical communicators also have to be careful to avoid plagiarism, or taking ideas, thoughts, or words from someone else and passing them off as one's own.{{sfn|Carroll|2010|p=280}}

Technical communicators have ethical standards to which they must abide. The standards are divided into three primary categories. They are the employer, the public, and the environment.{{sfn|Markel|2009}}

=== The Employer ===
Obligations to one's employer include competence and diligence, honesty and candor, confidentiality, and loyalty.{{sfn|Markel|2009}} The technical communicator must adhere to these obligations so that he/she does not harm the reputation or operation of the employer.

Technical communicators may occasionally work for an organization with strict privacy policies that prohibit them from using the documents they create outside of the organization. It is important for ethical communicators to follow the privacy policy for their organization because unauthorized release of information could lead to consequences up to and including termination.{{sfn|Balzotti|2022|p=83}}

=== The Public ===
Organizations are obligated to treat customers fairly. Technical communicators must convey that the products or services an organization sells are safe and effective.{{sfn|Markel|2009}}

=== The Environment ===
Technical communicators have an obligation to the environment. This obligation includes alerting their supervisors, managers, and executive leadership to products or processes that are detrimental to the environment. Protecting the environment can be costly, however, and organizations may consider ignoring legal guidelines to save money.{{sfn|Markel|2009}} Yet, failure to adhere to U.S. Environmental Protection Agency regulations also has financial implications. For example, the penalty for mishandling hazardous waste is five years and/or up to $50,000 for each day of the violation.{{sfn|EPA|2023}}

===Disinformation===
One major ethical concern in all forms of writing, but especially in digital writing, is the creation and spread of disinformation. Disinformation, often referred to as "[[w:Fake news|fake news]]," is information that is purposefully spread as false or misleading and is a sub-type of misinformation.{{sfn|Lawrence|2022|loc=section 3.7}} Modern communication technologies allow for the spread of information to occur at a fast pace. Social media is one area where the spread of disinformation occurs regularly. Some social media sites, such as Facebook, have begun to flag certain articles posted on the site as being questionable in their representation of facts or occurrences. Despite the widespread understanding and use of disinformation available today, digital writers need to be aware of their intent and the audience's needs and wants from their digital communication.{{sfn|Lucas|2023f}} Ethical considerations regarding citing sources, cross-referencing information, and using primary sources are good practices for maintaining ethical standing and credibility as a digital writer.

To help mitigate the problem of disinformation, technical writers should utilize gatekeepers. These individuals verify the accuracy of the information before it is distributed to primary readers. This helps protect the author from any ethical and/or legal issues.{{sfn|Balzotti|2022|p=83}}

==Pedagogical Approaches==
Barriers to teaching technical communications include the speed at which digital tools evolve and the complexity of software. {{sfn|Hovde|2017|pp=395-411}}

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. Others even used emoticons. Colleges and universities now must focus on educating students on the different forms of written communication and when best to employ them.{{sfn|Carroll|2010|p=280}}

==Future Trends and Challenges==
===Future Trends===
Between 2022 and 2032, the [https://en.wikipedia.org/wiki/Bureau_of_Labor_Statistics, United States Bureau of Labor Statistics] is projecting a 7% job growth for technical writers. {{sfn|United States Bureau of Labor Statistics|2023}} To be relevant as a technical writer in the digital age, one must possess the skills of conducting in-depth research, critical thinking, being detail oriented, design, and technical expertise. To succeed at communicating the complex to specific audiences, the technical writer must understand much of the subject in its complexity. This is accomplished through possessing the skills of communication, collaboration, and teamwork.{{sfn|Fechter|2023}}

===Challenges===
Among others, a prominent barrier to technical writers is the dependency on input information accuracy. Outdated, incorrect, or inconsistent data delays the publication, requires more reparative efforts, and decreases productivity.{{sfn|Ajose-Coker|2022}} Also, Technical writers often have to contend with complex, outdated or unsuitable tools. This can make their job more difficult and time-consuming, and can lead to frustration and errors.{{sfn|Ajose-Coker|2022}}

===Artificial Intelligence===
Artificial intelligence programs, utilizing natural language processing, are capable of producing technical writing and have advanced in recent years becoming more adept.{{sfn|Marr|2023}}

One such program is [https://en.wikipedia.org/wiki/ChatGPT ChatGPT], which uses machine learning to produce texts with human-like style and tone. {{sfn|University of Central Arkansas|2023}} Another leader in this area, Contentbot, uses a WordPress plugin which gives blog writers ideas to enhance their posts which are shared via email.{{sfn|Siddiqui|2022}}

===Plagiarism===
Because of the ability of chatbots to imitate human-like language, some education administrators have taken precautions to minimize the occurrence of students passing off artificially generated texts as their own. In some instances, educators have taken the view that material drawn from artificial intelligence software must be handled in the same way as sources from human authors. {{sfn|Klein|2023}} In such cases, students who incorporate artificially generated text into their work have been made to denote credit for the artificial intelligence program utilized.

===Credit===
The advent of chatbots has complicated the issue of credit where creative work is concerned. Because chatbots can simulate human speech, their ability to create cinematic dialogues and other types of creative writing have threatened the credits and financial condition of professional writers. According to an article by Aaron Mok and Jacob Zinkula on ''[https://www.businessinsider.com/ Business Insider]'', writing jobs are among the top 10 roles that AI is most likely to replace. {{sfn|Mok|2023}}

==References==
===Citations===
{{Reflist}}

===Bibliography ===
{{Refbegin|30em}} 
* {{cite web |url=https://www.linkedin.com/advice/0/how-can-you-create-effective-visual-aids-1c |title=How Can You Create Effective Visual Aids for Technical Writing? |last=AI and the LinkedIn Community |date=2023 |website=www.linkedin.com |publisher=LinkedIn |access-date=2023-11-05 }}
* {{cite web |url=https://componize.com/common-problems-in-technical-writing-and-how-to-resolve-them/ |title=Common Problems in Technical Writing and How to Solve Them |last=Ajose-Coker |first=Dipo |date=2022 |website=componize.com |publisher=Componize Software |access-date=2023-11-19 }}
* {{cite book |last=Bair|first=Amy Lupold |date=2014 |title=Blogging for Dummies|url=|location=Hoboken, NJ |publisher=Jon Wiley & Sons, Inc|pages=|isbn=|author-link= }}
* {{cite book |last=Balzotti |first=Jon|date=2022 |title=Technical Communication: A Design-Centric Approach |url= |location=New York |publisher=Routledge }}
* {{cite book |last=Barr |first=Chris |date=2010 |title=The Yahoo! Style Guide |url= |location=New York |publisher=St. Martin's }}
* {{cite book |last=Carroll |first=Brian |date=2010 |title=Writing for Digital Media |url= |location=New York |publisher=Routledge }}
* {{cite web |url=https://uca.edu/cetal/chat-gpt/ |title=Chat GPT: What is it? |last=University of Central Arkansas |first= |date= |website=uca.edu |publisher= University of Central Arkansas |access-date=2023-10-09 }}
* {{cite web |url=https://www.betonconsultingeng.com/objectivity-in-technical-writing/#:~:text=Pointers%20for%20objective%20technical%20writing%201%20If%20you,5%20Remember%20that%20correlation%20is%20not%20causality.%20 |title=Objectivity in Technical Writing |last=Detwiler |first=Rachel |date=2021 |website=www.betonconsultingeng.com |publisher=Beton Consulting Engineers L.L.C. |access-date=2023-11-05 }}
* {{cite book |last=DeVoss |first=Danielle |last2=National Writing Project |last3=Eidman-Aadahl |first3=Elyse |last4=Hicks |first4=Troy |date=2010 |title=Because Digital Writing Matters: Improving Student Writing in Online and Multimedia Environments |location=San Francisco |publisher=Jossey-Bass |pages=105 |isbn= |url=https://openlibrary.org/books/OL34593323M/Because_Digital_Writing_Matters }}
*{{cite book |last=Enge |first=Eric |last2=Spencer |first2=Stephan |last3=Stricchiola |first3=Jessie |date=2022 |title=The Art of SEO: Mastering Search Engine Optimization |url=https://archive.org/details/artofseomasterin0000enge |location=Sebastopol, CA |publisher=O'Reilly |pages=9 }}
* {{cite web |url=https://www.epa.gov/enforcement/criminal-provisions-resource-conservation-and-recovery-act-rcra |title=Criminal Provisions of the Resource Conservation and Recovery Act (RCRA) |date=2023 |publisher=United States Environmental Protection Agency }}
* {{cite web |url=https://technicalwriterhq.com/career/technical-writer/technical-writing-skills/ |title=Essential Technical Writing Skills |last=Fechter |first=Josh |date=2023 |website=technicalwriterhq.com |access-date=2023-11-21}}
* {{cite book |last=Gagich |first=Melanie |last2=Zickel |first2=Emilie |date=n.d. |title=Writing Arguments in Stem |chapter=Rhetorical Appeals: Logos, Pathos, and Ethos Defined |publisher=Digital Commons |url=https://digitalcommons.calpoly.edu/cgi/viewcontent.cgi?article=1000&context=oercoursematerials#page=44 |location= |pages=34-37 }}
* {{cite book |last=Garrett |first=Jesse James |title=The Elements of User Experience: User-Centered Design for the Web and Beyond |publisher=New Riders |edition=2nd |date=2011 |location=Berkeley, CA |page=17 }}
* {{cite web |url=https://smashingmagazine.com/2014/08/a-closer-look-at-personas-part-2/ |title=A Closer Look at Personas: A Guide to Developing The Right Ones (Part 2) |last=Goltz | first=Shlomo |date=2014 |website=smashingmagazine.com |publisher=Smashing Media AG |access-date=2023-11-13 }}
* {{cite magazine |last=Grimstead |first=Deborah M. |date=1999 |title=Technical Writers are in Demand: Do You Have The Right Stuff? |magazine=Black Collegian |pages=128 }}
* {{cite web |url=https://www.idassoc.com/product-information-definition/data-sheet |title=Product Information Encyclopedia |last=IDA |first= |date=2020 |website=Industrial Data Associates |publisher= |access-date=2023-11-20 |quote= }}
* {{cite web |url=https://learn.g2.com/how-to-write-a-press-release |title=How to Write a Press Release That Catches People's Attention |last=Pradham |first=Ninisha |date=2021 |website=Learn.G2 |publisher= |access-date=2023-11-21 |quote= }}
* {{cite book |last=Johnson-Sheehan |first=Richard |title=Technical Communication Today |url= |edition=6 |chapter=Chapter 4: Managing Ethical Challenges |location=Boston, MA |publisher=Pearson |date=2018 |pages=71-98 }}
* {{cite news |last=Klein |first=Alyson |date=2023 |title=ChatGPT Cheating: What to Do When It Happens |url=https://www.edweek.org/technology/chatgpt-cheating-what-to-do-when-it-happens/ |work=Education Week |location=Bethesda, MD |access-date=2023-11-05 }}
* {{cite book |last=Krug |first=Steve |date=2014 |title=Don’t Make Me Think, Revisited|url= |location=Berkeley, CA |publisher=New Riders |pages= |isbn= |author-link= }}
* {{cite book |last=Lannon |first=John M. |last2=Gurak |first2=Laura J. |date=2020 |title=Technical Communication |edition=15 |url= |location= |publisher=Pearson Education |page= }}
* {{cite book |last=Last|first=Susan |date=2019 |title=Technical Writing Essentials|url=https://pressbooks.bccampus.ca/technicalwriting/chapter/communicatingprecision/|location= |publisher= Victoria, B.C. University of Victoria |pages= |isbn= |author-link= }}
* {{cite book |last=Lawrence |first=Dan |date=2022 |title=Digital Writing: A Guide to Writing for Social Media and the Web |location=Peterborough, Ontario, Canada |publisher=Broadview Press |page=85 }}
* {{cite web |url=https://grlucas.net/grl/Writing_on_a_Wiki |title=Writing on a Wiki |last=Lucas |first=Gerald| date=2021| website=grlucas.net| publisher=MediaWiki| access-date=2023-10-31 }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Personas |title= Using Personas in Digital Writing
|last=Lucas |first=Gerald |date=2023a| website=grlucas.net |publisher=MediaWiki |access-date=2023-11-07 }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/SEO |title=Search Engine Optimization: Strategies and Best Practices for Effective Online Visibility |last=Lucas |first=Gerald |date=2023b |website=grlucas.net |publisher=MediaWiki |access-date=2023-11-19 }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Documents|title=Exploring the Dichotomy: A Comparative Analysis of Digital and Paper Documents |last=Lucas |first=Gerald |date=2023c |website=grlucas.net |publisher=MediaWiki |access-date=2023-10-29 |quote= }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Design/Users |title=User-Centered Design in Digital Documents |last=Lucas |first=Gerald |date=2023d |website=grlucas.net |publisher=MediaWiki |access-date=2023-11-15 |quote= }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Style |title=Audience-Centric Style in Digital Writing |last=Lucas |first=Gerald |date=2023e |website=grlucas.net |publisher=MediaWiki |access-date=2023-10-22 |quote= }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Credibility |title=The Significance of Credibility in Digital Writing |last=Lucas |first=Gerald |date=2023f |website=grlucas.net |publisher=MediaWiki |access-date=2023-11-21 }}
* {{cite web |url=https://www.indeed.com/career-advice/careers/what-does-a-technical-writer-do |title=What Does a Technical Writer Do? (Plus How To Become One) |last=Macari |first=Sabina |date=2023 |website=indeed.com |publisher=Indeed |access-date=2023-11-05 }}
* {{cite magazine |last=Malone |first=Ed |date=2008 |title=Joseph D. Chapline: Technical Communication's Mozart |url=https://web.mst.edu/~malonee/chapline.pdf |magazine=IEEE Professional Communication Society Newsletter |access-date=2023-10-31 }}
* {{cite journal |last=Malone |first=Edward |date=November 2011 |title=The First Wave (1953-1961) of the Professionalization Movement in Technical Communication |url=https://www.stc.org/techcomm/wp-content/uploads/sites/3/2016/08/november-2011-58-4.pdf |journal=Technical Communication |volume=58 |issue=4 |pages=285-306 |doi= |access-date=2023-10-11 }}
* {{cite book |last=Markel |first=Michael |title=Technical Communication |date=2009 |edition=9th |location=Boston |publisher=Bedford/St. Martin's |pages=22-25 }}
* {{cite book |last=Markel |first=Mike |last2=Selber |first2=Stuart A. |date=2019 |title=Practical Strategies of Technical Communication |edition=3rd |url= |location=Boston |publisher=Bedford/St. Martin’s |page= }}
* {{cite web |url=https://www.forbes.com/sites/bernardmarr/2023/01/23/how-chatgpt-and-natural-language-technology-might-affect-your-job-if-you-are-a-computer-programmer/?sh=6d9acf79174b |title=How ChatGPT And Natural Language Technology Might Affect Your Job If You Are A Computer Programmer |last=Marr |first=Bernard |date=2023 |website=Forbes.com |publisher=Forbes Media |access-date=2023-10-31 |quote= }}
* {{cite web |url=https://www.businessinsider.com/chatgpt-jobs-at-risk-replacement-artificial-intelligence-ai-labor-trends-2023-02 |title=ChatGPT may be coming for our jobs. Here are the 10 roles AI is most likely to replace |last=Mok |first=Aaron |date=2023 |website=Insider |publisher=Business Insider |access-date= 2023-11-05 }}
* {{cite book |last=Mussack |first=Brigitte |date=2021 |title=Introduction to Technical and Professional Communication |url=https://pressbooks.umn.edu/techwriting/front-matter/introduction/ |location= |publisher=Creative Commons Attribution NonCommercial |pages=n.p. |author-link= }}
* {{cite book| last=Parkinson |first=Mike |title=A Trainer’s Guide to PowerPoint: Best Practices for Master Presenters| location=United States| publisher=Association for Talent Development| chapter=Chapter 4. PowerPoint Tips, Tricks, and Secrets| date=2018 }}
* {{cite book |last=Perelman |first=Leslie |date=1998 |title=The Mayfield Handbook of Technical and Scientific Writing |url=https://www.mit.edu/course/21/21.guide/ |location=Mountain View |publisher=Mayfield Publishing Company |pages=n.p. |isbn= |author-link= }}
* {{cite web |url=https://learn.g2.com/how-to-write-a-press-release |title=How to Write a Press Release That Catches People's Attention |date=2021 |last=Pradhan |first=Ninisha |website=learn.g2.com |publisher=G2.com |access-date=2023-11-21 }}
* {{cite web |url=https://proofed.com/writing-tips/a-beginners-guide-to-technical-writing/ |title=A Beginner’s Guide to Technical Writing |last=Proofed Editors |date=2020 |website=Proofed.com |publisher=Proofed |access-date=2023-11-05 }}
* {{cite journal |last=Rathbone |first=Robert |title=Growth of the technical writing profession |journal=STWE Review |volume=5 |issue=1 |date=1958 |pages=5-16 }}
* {{cite book |last=Rose|first=Darren |last2=Garret |first2=Chris|date=2012 |title=ProBlogger: Secrets for Blogging Your Way to a Six-Figure Income|url=|location=Indianapolis, IN |publisher=Jon Wiley & Sons, Inc|pages=|isbn=|author-link= }}
*{{cite book |last=Robbins |first=Jennifer Niederst |date=2018 |title=Learning Web Design: A Beginner’s Guide to HTML, CSS, JavaScript, and Web Graphics (5th ed.) |url= |location=Sebastopol, CA |publisher= O’Reilly Media, Inc. }}
* {{cite web |url=https://writingcooperative.com/intricacies-of-ai-tools-can-ai-tools-take-over-the-jobs-of-technical-writers-af36836f625c |last=Siddiqui |first=Zafar |title=Will Best Artificial Intelligence Take Over any Technical Content Writer? |date=2022 |website=writingcooperative.com |publisher=The Writing Cooperative |access-date=2023-11-19 }}
* {{cite web |url=https://www.managementnote.com/features-of-technical-communication/#google_vignette |title=Features of Technical Communication |last=Smirti |date=2022 |website=managementnote.com |publisher=Management Note |access-date= 2023-11-05 }}
* {{cite web |url=https://www.stc.org/about-stc/ |title=About STC |last=Society for Technical Communication |first= |date=2023a |website=stc.org |publisher= |access-date=2023-10-27 }}
* {{cite web |url=https://www.stc.org/about-stc/ethical-principles/ |title=Ethical Principles |last=Society for Technical Communication |first= |date=2023b |website=stc.org |publisher= |access-date=2023-10-27 }}
* {{cite web |url=https://www.bls.gov/ooh/media-and-communication/technical-writers.htm#tab-6 |title=Occupational Outlook Handbook |last=United States Bureau of Labor Statistics |first= |date=2023 |website=bls.gov |publisher=United States Department of Labor |access-date=2023-11-07 }}
* {{cite web |url=https://uca.edu/cetal/chat-gpt/ |title=Chat GPT: What is it? |last=University of Central Arkansas |first= |date= |website=uca.edu |publisher= University of Central Arkansas |access-date=2023-10-09 }}
* {{cite web |url=https://www.viralnation.com/blog/what-is-digital-content-creation-and-how-can-it-help-me-as-a-marketing-manager/#:~:text=A%20rule%20of%20thumb%20in%20digital%20content%20creation,turn%2C%20share%20it%20with%20others%20in%20their%20network. |title=What is Digital Content Creation? (and How Can It Help Me as a Marketing Manager) |last=Viral Nation |date=2019 |website=viralnation.com |publisher= Viral Nation |access-date=2023-11-05 }}
* {{cite web |url=https://www.w3.org/WAI/fundamentals/accessibility-intro/|title=Introduction to Web Accessibility |last=WAI |first=|date=2022 |website=W3.org|publisher= |access-date= 2023-10-26 |quote= }}
* {{cite web |url=https://scribehow.com/library/user-guide |title=What is a User Guide? Everything You Need to Know |last=Wainaina |first=Timan |date=2022 |website= |publisher= |access-date=22 November 2023 |quote= |ref=harv }}
* {{cite web |url=https://wcag.com/legal/|title=Accessibility and the Law |last=WCAG |first= |date=2023 |website=wcag.com|publisher=eSSENTIAL Accessibility |access-date= 2023-10-26 |quote= }}
* {{cite book |last=Zeleznik |first=J. M. |last2=Burnett |first2=R. E. |last3=Benson |first3=P. J. |date=1999 |title=Technical Writing: What It Is and How to Do It |url= |location= |publisher=National Book Network |pages=107 |isbn= |author-link= }}

{{Refend}}

[[Category:Fall 2023]]
[[Category:ENGL 5106]]

User talk:Beth Kennedy

2023-11-23T02:46:50Z

APitts: Blanked the page

User talk:Beth Kennedy

2023-11-23T02:46:25Z

APitts: Created page with "Thank you, Beth. You're a life saver! User:APitts"

Thank you, Beth. You're a life saver! [[User:APitts]]

Talk:Technical Writing in the Digital Age

2023-11-22T14:33:39Z

APitts: /* References question */

Talk:Technical Writing in the Digital Age

2023-11-22T14:32:59Z

APitts: /* References question */

Talk:Technical Writing in the Digital Age

2023-11-22T14:32:28Z

APitts: /* References question */

2023-11-22T02:42:05Z

APitts: Fixed citation.

'''Technical Writing in the Digital Age''' represents the dynamic and evolving discipline of creating written materials that convey complex information, instructions, and technical concepts in the context of contemporary digital technologies. Its purview encompasses the creation, dissemination, and management of technical documents and content within an expansive digital landscape.

Major considerations revolve around adapting traditional principles of rhetoric to digital platforms, ensuring effective communication in an era defined by rapid technological advancements. 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. The use of multi-modality and the interfacing of multiple media platforms and sources also plays a role in digital technical writing. In essence, technical writing in the digital age encapsulates the art and science of conveying technical information in a manner that is comprehensible and accessible to diverse audiences in our digitally driven society.

==Overview==

=== Aims of Technical Communication ===
As much as technical communication is a discipline in and of itself, it also exists within many other disciplines. Examples of technical communication communities can be found among such fields as varied as education, business, and science. Technical documentation within any domain typically embodies a similar aim: to help its audience act toward some sort of task or goal. {{sfn|Markel|Selber|2019}}

=== Characteristics of Technical Communication ===
Because technical communication is intended to guide an audience, it must be assembled in such a way that it is very 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.

== 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}}

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

==== Case Studies ====
Case studies are a form of empirical or observational research that consists of in-depth examination of distinct individuals, groups, events, or scenarios. This research can be used to generate qualitative or quantitative data. {{sfn|Johnson-Sheehan |2018|p=401-404}}

==== Data Sheets ====
A data sheet, also known as a technical datasheet, is a document used to describe and summarize the characteristics of a product, material, component, or technology. {{sfn|IDA|2020|p=}}

====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|p=443-453}}

*Product: provides detailed information about a specific item, including its features, specifications, and benefits.
*Process: provides step-by-step instructions on how to perform a particular task or achieve a specific outcome.

==== Documentation ====
Documentation comprises various texts that allow users to accomplish tasks or gain information. It generally falls into three categories, which can be defined as follows:
* Instructions: Text that describes how to complete a task, often offering numbered steps. Examples include how to download software or assemble a product.{{sfn|Balzotti |2022|p=167}}
* Specifications: Communications that deliver technical details on how a product is put together or a specific operation is executed. Also known as "specs," these texts may be written by engineers or technicians.{{sfn|Johnson-Sheehan |2018|p=205}}
* Procedures and Protocols: Guidelines to ensure consistency, quality, and safety in the workplace. For example, a hospital may provide staff with procedures on how to adapt operations during an emergency, such as a power outage.{{sfn|Johnson-Sheehan |2018|p=205}}

==== Email ====
Emails are the primary form of communication in the workplace, used for both internal and external communication. They facilitate information exchange, idea exchange, and activity coordination.{{sfn|Lannon & Gurak |2020|p=335}} Emails should be brief, concise, readable, and targeted to specific audiences with specific subject lines.{{sfn|Lannon & Gurak |2020|p=348}}

==== Letters ====
Letters are a traditional form of communication most often used by employees to communicate with individuals outside of a company or organization. They are typically written on company letterhead. Today, letters are sent either by U.S. mail or electronically. {{sfn|Johnson-Sheehan |2018|p=139}}

==== Memos ====
A memo (short for memorandum) is an official communication, usually a message from the company, a manager or director, or another person or group acting in an official capacity, used to communicate with others within the same organization. {{sfn|Lannon & Gurak |2020|p=353}}

==== 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.<ref>[https://learn.g2.com/how-to-write-a-press-release Pradhan 2021.] </ref>

==== Proposals ====
A proposal is a document that identifies an existing problem or opportunity and outlines a comprehensive strategy for addressing it. Organizations create ''internal'' proposals to describe programs and projects that meet specific operational needs, such as a plan to replace an outdated software system. Companies develop ''external'' proposals for potential customers or clients. These documents detail new products, services, or initiatives that a company will implement to address a specific customer concern.{{sfn|Johnson-Sheehan |2018|p=245}}

==== Reports ====
A report is a concise, easily understandable document that presents technical information in a clear, organized format, allowing readers to access varying levels of information. Reports are categorized as informal, such as briefs, and formal, such as research, scientific, and completion reports. {{sfn|Johnson-Sheehan |2018|p=Chap 10 & 11}}

===== Informal Reports =====
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. Brief reports are categorized into three subcategories:

* Progress reports inform management about the progress or status of a project.
* White papers educate management or clients about important issues.

===== Formal Reports =====
A formal report is a factual and data-driven response to a research question.
* Research reports present the findings of a study.
* Scientific research reports outline the process, progress, and results of technical or scientific research or the current state of a research problem.
* Completion reports assess the outcomes of a project or initiative and provide feedback to management or the client.

==== Resumes ====
Résumés 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 résumés demonstrate the sequence of education and employment history and detail a person’s tasks, responsibilities, and achievements in each successive role. Skills résumés 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|p=411-412}}

==== User guides ====

== Features of Technical Communication ==
Technical communication involves conveying complex information to a specific audience. Key features include accuracy, attention to detail, visuals, and clear and concise organization to enhance user understanding. {{sfn|Smirti|2022}}

=== Accuracy ===

==== Standards Compliant ====
Many technical fields have industry-specific regulations and guidelines which are determined by governing bodies and that also have an impact on their technical communication. Furthermore, many organizations may have a style guide that outlines preferred language usage, tone, and formatting. {{sfn|Smirti|2022}}

==== Detailed ====
Accurate information that is delivered with precision and specificity is essential to providing communication that is unambiguous and free of discrepancies. {{sfn|Smirti|2022}} It is free of errors and inconsistencies.

==== Objective ====
Objective communication is presented in an unbiased and impartial manner and is free of personal opinions. It relies upon facts and evidence and avoids an overly emotional tone. This approach is particularly important in fields where accuracy and impartiality are essential. {{sfn|Rachel Detweiler|2021}}

===== Clear and Concise =====
Clear language is organized logically, is not unnecessarily involved, and is easily understood by the target audience. It will avoid needless jargon and complexity. Good technical communication expresses meaning in a way that is straightforward and that avoids redundant words or excessive explanations. It is easy to both absorb and process. {{sfn|Smirti|2022}} {{sfn|Proofed Editors|2020}}

=== Soundness ===

==== Formatted and Organized ====
Technical documents should be formatted in a way that is consistent with the norms and standards of applicable professional fields. Additionally, formatting should adhere to guidelines which enhance usability. Information should be logically organized for easy reading comprehension. This may involve using headings, subheadings, bullet points, and numbered lists. Formatting detail should remain consistent throughout the document. {{sfn|Smirti|2022}} {{sfn|Proofed Editors|2020}}

==== Graphical ====
Technical communication utilizes visuals strategically to facilitate understanding of textual content. Visuals such as diagrams, charts, graphs or images can enhance understanding on a technical document. When presented properly, they can elucidate difficult concepts and make material accessible to a more diverse audience. {{sfn|AI and the LinkedIn Community|2023}}

=== Appropriateness ===

==== Audience-specific ====
Where possible, technical communication should be customized to align with the knowledge and needs of its audience. Communication style and tone should be tailored to match the audience's level of expertise and should take into consideration such factors as the the users' technical background, familiarity with the subject, and specific requirements. {{sfn|Viral Nation|2019}}

==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}} And 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}}

== Digital Technologies and Technical Writing==
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 thus, it can be accessed by anyone with access to the internet. Such a phenomenon can be exploited to increase the audience of a virtual document.

There are several web-based tools and techniques which allow digital documents to be more easily shared. Online word processors such as [https://www.google.com/docs/about/ Google Docs] and [https://www.microsoft.com/en-us/microsoft-365/sharepoint/collaboration SharePoint] allow documents to be readily disseminated. Comment capability allows audience members to interact about a document with one another as well as with the document author. Relationships created by such online interaction fosters an environment whereby online authors might choose to link the works of various others to their own personal websites. In all, technical documentation posted online can grow a considerable audience over time. However, many aspects of effective technical writing, such as clarity, conciseness, completeness, and correctness, still need to be applied to technical writing created for digital interfaces. {{sfn|Carroll|2010|p=24}}

==Personas in Digital Writing==
Personas in the context of digital writing refer to semi-fictional characters that encapsulate the characteristics, behaviors, and needs of target audience segments. They align closely with the principles of user-centered design (UCD).{{sfn|Lucas|2023a}}
There are myriad ways to integrate user-centered thinking into the creative process of UX design, and personas are one of the most effective ways to empathize with and analyze users.{{sfn|Goltz|2014}}

==Rhetorical Strategies in the Digital Age==
Rhetoric is a communication strategy whose primary goal is to persuade an audience. It is grounded in three foundational concepts first defined by the Greek philosopher Aristotle. These concepts are ''logos'', which engages with the reader’s sense of logic or reason; ''pathos'', which appeals to the reader’s emotions; and ''ethos'', which addresses the audience’s values and the writer’s credibility. Within this framework, writers utilize specific techniques or devices to influence and engage readers. Examples include appealing to an audience’s sense of logic by using factual examples to support a point or evoking emotion through descriptive visual language. {{sfn|Gagich|Zickel|n.d.|pp=34-37}}

In today’s digital age, writers can use digital technologies as rhetorical devices to influence the reader. Electronic images and informational graphics can be incorporated into digital and online documents to illustrate or reinforce points made in the text.{{sfn|Markel|Selber|2019}} Hyperlinks can be used to provide additional information that supports the author's ideas. Nevertheless, the writer's basic task of informing and persuading an audience is the same in digital communication as in other forms of writing.{{sfn|DeVoss|National Writing Project|Eidman-Aadahl|Hicks|2010|p=105}}

Rhetorical analysis involves analyzing the demographics and habits of an intended audience. The information gathered allows writers to craft messages that appeal to the target audience. In the digital age, websites and social media platforms convey rhetorical messages.{{sfn|Lawrence|2022|pp=6-14}}

==Search Engine Optimization (SEO)==
SEO refers to the practice of optimizing online content to enhance its visibility and ranking on search engine results pages (SERPs), making it a crucial skill for digital writers.{{sfn|Lucas|2023b}} To optimize content for SEO means to have the goal of SEO in mind at the time of designing, creating, and writing a web page for publication. Using keywords and alt-text are two examples of optimizing content for SEO. {{sfn|Barr|2010|loc=chpt. 17}}

=== Keywords ===
Keywords are the words that search engines crawl a website for and index as the page's most important words. Based on other pages using the same keywords, the website is added into the search engine results pages from best matches to worse matches. Depending on where the website falls in that scale based on the specific keywords being searched by a user, influences where the website pops up in the associated search results.{{sfn|Lucas|2023b}} To optimize a website's keywords, you should begin with researching keywords on your own website and ensure that you have an XML [https://en.wikipedia.org/wiki/Sitemaps sitemap] so search engine's such as [https://en.wikipedia.org/wiki/Google Google] can crawl your web pages for updated information. In addition to using keywords, updating a page's metadata information can also help with showing up on SERPs. Using title and header tags as well as meta descriptions for content also helps optimize a website's ratings in SERPs.{{sfn|Lucas|2023b}}

=== Alt-Text ===
Alt-Text (alternative text), or [https://en.wikipedia.org/wiki/Alt_attribute Alt Attributes], is a practice that increases the usability and accessibility of a web page for users. Alt-Text is often used for visual elements that cannot be displayed in a different format but still provides description of the element for screen readers or users that may have a disability. Alt-Text also improves a website's SEO as a form of content optimization.{{sfn|Lucas|2023b}}

=== Social Media Presence ===
Sharing content from a website across different social media platforms is another way to create SEO optimization. This technique can help with being seen as legitimate and improves visibility of the website overall. Additionally it can drive traffic and enables back-linking to occur when other websites have the ability to also link to the website.{{sfn|Lucas|2023b}}

=== Goals of Searching: The User's Perspective ===
A user of search engines formulates queries by using keywords or posing questions. One of the most important elements of building an SEO strategy for a website is developing a thorough understanding of the psychology of your target audience, and how they use words and concepts to obtain information about the services and/or products you provide. Once you understand how the average search engine user—and, more specifically, your target audience—utilizes query-based search engines, you can more effectively reach and keep those users. {{sfn|Enge|2022|p=9}}

==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}}

===Characteristics of Digital Documents===

==== Electronic Format ====
Digital documents exist in electronic formats, which means they are stored and transmitted as binary data. This format allows for efficient storage, retrieval, and transmission of information via electronic devices.{{sfn|Lucas|2023c}}

==== Non-Tangible ====
Unlike paper documents, digital documents lack physical presence. They are intangible and exist as electronic files, residing on devices or in the cloud.{{sfn|Lucas|2023c}}

====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}} 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====
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====
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}}

==== Ease of Reproduction and Distribution ====
Digital documents are easily copied and distributed. They can be duplicated without any loss of quality, making it simple to share information widely and at minimal cost.{{sfn|Lucas|2023c}}

====Hyperlinking====
Hyperlinking is a quick and efficient method for directing readers to relevant information in digital documents, facilitating seamless navigation between sections, references, and external resources.{{sfn|Carroll|2010|p=79}}

====Multimedia====
Digital documents can incorporate multimedia elements like images, audio, video, and interactive content, enhancing engagement through visual and auditory elements. Multiple media formats work best when sharing new, complicated ideas.{{sfn|Carroll|2010|p=36}} Increasing multimodality on a website improves engagement, usability, and accessibility. This can improve the impact of the website's standings in SERPs.{{sfn|Carroll|2010|p=280}}

====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}}

==== Remote Collaboration ====
One form of collaborative technical writing is a wiki, which is a "Web site developed collaboratively by a community of users, allowing any user to add and edit content.{{sfn|Lucas|2021}} One of the predominant elements of a wiki is that it is defined as being open source. As a result, anyone can modify it regardless of their geographic locations.

==== Security Measures ====
Digital documents can be protected with encryption, passwords, and access controls to safeguard sensitive information. These security measures enhance data protection and privacy.{{sfn|Lucas|2023c}}

==== Environmental Impact ====
Digital documents have a smaller environmental footprint compared to paper documents, as they reduce the need for paper production, printing, and transportation.{{sfn|Lucas|2023c}}

==== Dynamic Updates ====
Online digital documents can be updated dynamically, ensuring that users always have access to the most current information. This is particularly valuable in fast-changing fields.{{sfn|Lucas|2023c}}

==== Global Accessibility ====
Digital documents can be shared globally, transcending geographical boundaries and time zones. They support international collaboration and the dissemination of knowledge on a global scale.{{sfn|Lucas|2023c}}

==== Data Integration ====
In business and research settings, digital documents can integrate with databases and data analysis tools. This integration streamlines data collection, analysis, and reporting processes.{{sfn|Lucas|2023c}}

==== Data Analytics ====
Digital documents can be subjected to data analytics techniques, allowing organizations to extract valuable insights from large volumes of textual data, which can inform decision-making and strategy.{{sfn|Lucas|2023c}}

==Examples of Digital Documents==
In technical and professional writing, digital documentation takes various forms. These methods streamline the sharing of technical information, enhance collaboration, and ensure easy accessibility within professional settings, contributing to efficient communication and knowledge dissemination.

==== Infographics ====
Infographics, shared as digital documents, typically combine text, graphics, and illustrations to convey complex concepts or data in a concise and visually appealing format. Infographics are often used to simplify information, making it more accessible to a broader audience, and are found in presentations, reports, websites, and educational materials. {{sfn|Lannon|Gurak|2020|pp=292-293}}

==== Presentations ====
Presentations created with [https://en.wikipedia.org/wiki/Microsoft_PowerPoint PowerPoint] or [https://en.wikipedia.org/wiki/Google_Slides Google Slides] are vital for professional communication and knowledge sharing. They condense complex information into visually appealing slides for effective presentations by using photos, videos, graphics, charts, and graphs.{{sfn|Parkinson|2018|loc=chpt. 4}}

==== Blogs ====
A blog, short for "weblog," is an informational website organized into short articles called posts, typically chronologically ordered series of website updates, written and organized similar to a traditional diary.{{sfn|Bair|2014|p=7}} They are regularly updated, providing readers with insights on a specific topic or subject. Blogs serve various purposes, including sharing opinions, providing news, offering educational content, and documenting personal experiences.{{sfn|Rose & Garret|2012|p=2}}

==User Experience==
User experience is how a product works from the perspective of the user. Digital documents can be created with efficient user experiences by focusing on user-centered design. {{sfn|Garrett|2011|p=17}}

=== User-Centered Design ===
The approach of user-centered design (UCD) in technical writing consists of the following methodology{{sfn|Lucas|2023e}}:

==== User Research ====
User research is the act of conducting thorough research through surveys, interviews, and usability testing to gain a better understanding of user needs and experiences when using a digital document.

==== Ideation and Prototyping ====
Ideation and prototyping refers to the process of creating digital designs and prototypes to assist with exploring possible solutions to meet user needs.

==== Usability Testing ====
Usability testing refers to the act of having users interact with digital document designs and recording and adjusting the design based on user feedback.

==== Implementation ====
Implementation is the stage in which the design is implemented after making adjustments from prior testing.

==== Evaluation ====
Evaluation refers to the stage in which the digital document is assessed to ensure that it is meeting user needs.

==== Maintenance and Updates ====
Maintenance and updates are required in order to maintain a digital document based on user feedback and changing needs.

==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|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}}

Technical communicators also have to be careful to avoid plagiarism, or taking ideas, thoughts, or words from someone else and passing them off as one's own.{{sfn|Carroll|2010|p=280}}

Technical communicators have ethical standards to which they must abide. The standards are divided into three primary categories. They are the employer, the public, and the environment.{{sfn|Markel|2009}}

=== The Employer ===
Obligations to one's employer include competence and diligence, honesty and candor, confidentiality, and loyalty.{{sfn|Markel|2009}} The technical communicator must adhere to these obligations so that he/she does not harm the reputation or operation of the employer.

Technical communicators may occasionally work for an organization with strict privacy policies that prohibit them from using the documents they create outside of the organization. It is important for ethical communicators to follow the privacy policy for their organization because unauthorized release of information could lead to consequences up to and including termination.{{sfn|Balzotti|2022|p=83}}

=== The Public ===
Organizations are obligated to treat customers fairly. Technical communicators must convey that the products or services an organization sells are safe and effective.{{sfn|Markel|2009}}

=== The Environment ===
Technical communicators have an obligation to the environment. This obligation includes alerting their supervisors, managers, and executive leadership to products or processes that are detrimental to the environment. Protecting the environment can be costly, however, and organizations may consider ignoring legal guidelines to save money.{{sfn|Markel|2009}} Yet, failure to adhere to U.S. Environmental Protection Agency regulations also has financial implications. For example, the penalty for mishandling hazardous waste is five years and/or up to $50,000 for each day of the violation.{{sfn|EPA|2023}}

===Disinformation===
One major ethical concern in all forms of writing, but especially in digital writing, is the creation and spread of disinformation. Disinformation, often referred to as "[[w:Fake news|fake news]]," is information that is purposefully spread as false or misleading and is a sub-type of misinformation.{{sfn|Lawrence|2022|loc=section 3.7}} Modern communication technologies allow for the spread of information to occur at a fast pace. Social media is one area where the spread of disinformation occurs regularly. Some social media sites, such as Facebook, have begun to flag certain articles posted on the site as being questionable in their representation of facts or occurrences. Despite the widespread understanding and use of disinformation available today, digital writers need to be aware of their intent and the audience's needs and wants from their digital communication.{{sfn|Lucas|2023f}} Ethical considerations regarding citing sources, cross-referencing information, and using primary sources are good practices for maintaining ethical standing and credibility as a digital writer.

To help mitigate the problem of disinformation, technical writers should utilize gatekeepers. These individuals verify the accuracy of the information before it is distributed to primary readers. This helps protect the author from any ethical and/or legal issues.{{sfn|Balzotti|2022|p=83}}

==Pedagogical Approaches==
Barriers to teaching technical communications include the speed at which digital tools evolve and the complexity of software. {{sfn|Hovde|2017|pp=395-411}}

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. Others even used emoticons. Colleges and universities now must focus on educating students on the different forms of written communication and when best to employ them.{{sfn|Carroll|2010|p=280}}

==Future Trends and Challenges==
===Future Trends===
Between 2022 and 2032, the [https://en.wikipedia.org/wiki/Bureau_of_Labor_Statistics, United States Bureau of Labor Statistics] is projecting a 7% job growth for technical writers. {{sfn|United States Bureau of Labor Statistics|2023}} To be relevant as a technical writer in the digital age, one must possess the skills of conducting in-depth research, critical thinking, being detail oriented, design, and technical expertise. To succeed at communicating the complex to specific audiences, the technical writer must understand much of the subject in its complexity. This is accomplished through possessing the skills of communication, collaboration, and teamwork.<ref>{{cite web |url=https://technicalwriterhq.com/career/technical-writer/technical-writing-skills/ |title=Essential Technical Writing Skills |author=Josh Fechter |website=Technical Writer HQ |access-date=21 November 2023}}</ref>

===Challenges===
Among others, a prominent barrier to technical writers is the dependency on input information accuracy. Outdated, incorrect, or inconsistent data delays the publication, requires more reparative efforts, and decreases productivity.{{sfn|Ajose-Coker|2022}} Also, Technical writers often have to contend with complex, outdated or unsuitable tools. This can make their job more difficult and time-consuming, and can lead to frustration and errors.{{sfn|Ajose-Coker|2022}}

===Artificial Intelligence===
Artificial intelligence programs, utilizing natural language processing, are capable of producing technical writing and have advanced in recent years becoming more adept.{{sfn|Marr|2023}}

One such program is [https://en.wikipedia.org/wiki/ChatGPT ChatGPT], which uses machine learning to produce texts with human-like style and tone. {{sfn|University of Central Arkansas|2023}} Another leader in this area, Contentbot, uses a WordPress plugin which gives blog writers ideas to enhance their posts which are shared via email.{{sfn|Siddiqui|2022}}

===Plagiarism===
Because of the ability of chatbots to imitate human-like language, some education administrators have taken precautions to minimize the occurrence of students passing off artificially generated texts as their own. In some instances, educators have taken the view that material drawn from artificial intelligence software must be handled in the same way as sources from human authors. {{sfn|Klein|2023}} In such cases, students who incorporate artificially generated text into their work have been made to denote credit for the artificial intelligence program utilized.

===Credit===
The advent of chatbots has complicated the issue of credit where creative work is concerned. Because chatbots can simulate human speech, their ability to create cinematic dialogues and other types of creative writing have threatened the credits and financial condition of professional writers. According to an article by Aaron Mok and Jacob Zinkula on ''[https://www.businessinsider.com/ Business Insider]'', writing jobs are among the top 10 roles that AI is most likely to replace. {{sfn|Mok|2023}}

==References==
===Citations===
{{Reflist}}

===Bibliography ===
{{Refbegin|30em}} 
* {{cite web |url=https://www.linkedin.com/advice/0/how-can-you-create-effective-visual-aids-1c |title=How Can You Create Effective Visual Aids for Technical Writing? |last=AI and the LinkedIn Community |date=2023 |website=www.linkedin.com |publisher=LinkedIn |access-date=2023-11-05 |ref=harv}}
* {{cite web |url=https://componize.com/common-problems-in-technical-writing-and-how-to-resolve-them/ |title=Common Problems in Technical Writing and How to Solve Them |last=Ajose-Coker |first=Dipo |date=2022 |website=componize.com |publisher=Componize Software |access-date=2023-11-19 }}
* {{cite book |last=Bair|first=Amy Lupold |date=2014 |title=Blogging for Dummies|url=|location=Hoboken, NJ |publisher=Jon Wiley & Sons, Inc|pages=|isbn=|author-link= |ref=harv }}
* {{cite book |last=Balzotti |first=Jon|date=2022 |title=Technical Communication: A Design-Centric Approach |url= |location=New York |publisher=Routledge |page=83 }}
* {{cite book |last=Balzotti |first=Jon|date=2022 |title=Technical Communication: A Design-Centric Approach |url= |location=New York |publisher=Routledge |page=167 }}
* {{cite book |last=Barr |first=Chris |date=2010 |title=The Yahoo! Style Guide |url= |location=New York |publisher=St. Martin's }}
* {{cite book |last=Carroll |first=Brian |date=2010 |title=Writing for Digital Media |url= |location=New York |publisher=Routledge }}
* {{cite web |url=https://uca.edu/cetal/chat-gpt/ |title=Chat GPT: What is it? |last=University of Central Arkansas |first= |date= |website=uca.edu |publisher= University of Central Arkansas |access-date=2023-10-09 }}
* {{cite web |url=https://www.betonconsultingeng.com/objectivity-in-technical-writing/#:~:text=Pointers%20for%20objective%20technical%20writing%201%20If%20you,5%20Remember%20that%20correlation%20is%20not%20causality.%20 |title=Objectivity in Technical Writing |last=Detwiler |first=Rachel |date=2021 |website=www.betonconsultingeng.com |publisher=Beton Consulting Engineers L.L.C. |access-date=2023-11-05 |ref=harv}}
* {{cite book |last=DeVoss |first=Danielle |last2=National Writing Project |last3=Eidman-Aadahl |first3=Elyse |last4=Hicks |first4=Troy |date=2010 |title=Because Digital Writing Matters: Improving Student Writing in Online and Multimedia Environments |location=San Francisco |publisher=Jossey-Bass |pages=105 |isbn= |url=https://openlibrary.org/books/OL34593323M/Because_Digital_Writing_Matters }}
*{{cite book |last=Enge |first=Eric |last2=Spencer |first2=Stephan |last3=Stricchiola |first3=Jessie |date=2022 |title=The Art of SEO: Mastering Search Engine Optimization |url=https://archive.org/details/artofseomasterin0000enge |location=Sebastopol, CA |publisher=O'Reilly |pages=9 |ref=harv }}
* {{cite web |url=https://www.epa.gov/enforcement/criminal-provisions-resource-conservation-and-recovery-act-rcra |title=Criminal Provisions of the Resource Conservation and Recovery Act (RCRA) |date=2023 |publisher=United States Environmental Protection Agency }}
* {{cite book |last=Gagich |first=Melanie |last2=Zickel |first2=Emilie |date=n.d. |title=Writing Arguments in Stem |chapter=Rhetorical Appeals: Logos, Pathos, and Ethos Defined |publisher=Digital Commons |url=https://digitalcommons.calpoly.edu/cgi/viewcontent.cgi?article=1000&context=oercoursematerials#page=44 |location= |pages=34-37 }}
* {{cite book |last=Garrett |first=Jesse James |title=The Elements of User Experience: User-Centered Design for the Web and Beyond |publisher=New Riders |edition=2nd |date=2011 |location=Berkeley, CA |page=17 }}
* {{cite web |url=https://smashingmagazine.com/2014/08/a-closer-look-at-personas-part-2/ |title=A Closer Look at Personas: A Guide to Developing The Right Ones (Part 2) |last=Goltz | first=Shlomo |date=2014 |website=smashingmagazine.com |publisher=Smashing Media AG |access-date=2023-11-13 }}
* {{cite magazine |last=Grimstead |first=Deborah M. |date=1999 |title=Technical Writers are in Demand: Do You Have The Right Stuff? |magazine=Black Collegian |pages=128 }}
* {{cite web |url=https://www.idassoc.com/product-information-definition/data-sheet |title=Product Information Encyclopedia |last=IDA |first= |date=2020 |website=Industrial Data Associates |publisher= |access-date=2023-11-20 |quote= |ref=harv }}
* {{cite book |last=Johnson-Sheehan |first=Richard |title=Technical Communication Today |url= |edition=6 |chapter=Chapter 4: Managing Ethical Challenges |location=Boston, MA |publisher=Pearson |date=2018 |pages=71-98 }}
* {{cite news |last=Klein |first=Alyson |date=2023 |title=ChatGPT Cheating: What to Do When It Happens |url=https://www.edweek.org/technology/chatgpt-cheating-what-to-do-when-it-happens/ |work=Education Week |location=Bethesda, MD |access-date=2023-11-05 }}
* {{cite book |last=Krug |first=Steve |date=2014 |title=Don’t Make Me Think, Revisited|url= |location=Berkeley, CA |publisher=New Riders |pages= |isbn= |author-link= }}
* {{cite book |last=Lannon |first=John M. |last2=Gurak |first2=Laura J. |date=2020 |title=Technical Communication |edition=15 |url= |location= |publisher=Pearson Education |page= }}
* {{cite book |last=Last|first=Susan |date=2019 |title=Technical Writing Essentials|url=https://pressbooks.bccampus.ca/technicalwriting/chapter/communicatingprecision/|location= |publisher= Victoria, B.C. University of Victoria |pages= |isbn= |author-link= }}
* {{cite book |last=Lawrence |first=Dan |date=2022 |title=Digital Writing: A Guide to Writing for Social Media and the Web |location=Peterborough, Ontario, Canada |publisher=Broadview Press |page=85 }}
* {{cite web |url=https://grlucas.net/grl/Writing_on_a_Wiki |title=Writing on a Wiki |last=Lucas |first=Gerald| date=2021| website=grlucas.net| publisher=MediaWiki| access-date=2023-10-31 }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Personas |title= Using Personas in Digital Writing
|last=Lucas |first=Gerald |date=2023a| website=grlucas.net |publisher=MediaWiki |access-date=2023-11-07 }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/SEO |title=Search Engine Optimization: Strategies and Best Practices for Effective Online Visibility |last=Lucas |first=Gerald |date=2023b |website=grlucas.net |publisher=MediaWiki |access-date=2023-11-19 }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Documents|title=Exploring the Dichotomy: A Comparative Analysis of Digital and Paper Documents |last=Lucas |first=Gerald |date=2023c |website=grlucas.net |publisher=MediaWiki |access-date=2023-10-29 |quote= }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Design/Users |title=User-Centered Design in Digital Documents |last=Lucas |first=Gerald |date=2023d |website=grlucas.net |publisher=MediaWiki |access-date=2023-11-15 |quote= }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Style |title=Audience-Centric Style in Digital Writing |last=Lucas |first=Gerald |date=2023e |website=grlucas.net |publisher=MediaWiki |access-date=2023-10-22 |quote= }}
* {{cite web |url=https://www.indeed.com/career-advice/careers/what-does-a-technical-writer-do |title=What Does a Technical Writer Do? (Plus How To Become One) |last=Macari |first=Sabina |date=2023 |website=indeed.com |publisher=Indeed |access-date=2023-11-05 }}
* {{cite magazine |last=Malone |first=Ed |date=2008 |title=Joseph D. Chapline: Technical Communication's Mozart |url=https://web.mst.edu/~malonee/chapline.pdf |magazine=IEEE Professional Communication Society Newsletter |access-date=2023-10-31 }}
* {{cite journal |last=Malone |first=Edward |date=November 2011 |title=The First Wave (1953-1961) of the Professionalization Movement in Technical Communication |url=https://www.stc.org/techcomm/wp-content/uploads/sites/3/2016/08/november-2011-58-4.pdf |journal=Technical Communication |volume=58 |issue=4 |pages=285-306 |doi= |access-date=2023-10-11 }}
* {{cite book |last=Markel |first=Michael |title=Technical Communication |date=2009 |edition=9th |location=Boston |publisher=Bedford/St. Martin's |pages=22-25 }}
* {{cite book |last=Markel |first=Mike |last2=Selber |first2=Stuart A. |date=2019 |title=Practical Strategies of Technical Communication |edition=3rd |url= |location=Boston |publisher=Bedford/St. Martin’s |page= }}
* {{cite web |url=https://www.forbes.com/sites/bernardmarr/2023/01/23/how-chatgpt-and-natural-language-technology-might-affect-your-job-if-you-are-a-computer-programmer/?sh=6d9acf79174b |title=How ChatGPT And Natural Language Technology Might Affect Your Job If You Are A Computer Programmer |last=Marr |first=Bernard |date=2023 |website=Forbes.com |publisher=Forbes Media |access-date=2023-10-31 |quote= }}
* {{cite web |url=https://www.businessinsider.com/chatgpt-jobs-at-risk-replacement-artificial-intelligence-ai-labor-trends-2023-02 |title=ChatGPT may be coming for our jobs. Here are the 10 roles AI is most likely to replace |last=Mok |first=Aaron |date=2023 |website=Insider |publisher=Business Insider |access-date= 2023-11-05 }}
* {{cite book |last=Mussack |first=Brigitte |date=2021 |title=Introduction to Technical and Professional Communication |url=https://pressbooks.umn.edu/techwriting/front-matter/introduction/ |location= |publisher=Creative Commons Attribution NonCommercial |pages=n.p. |author-link= }}
* {{cite book| last=Parkinson |first=Mike |title=A Trainer’s Guide to PowerPoint: Best Practices for Master Presenters| location=United States| publisher=Association for Talent Development| chapter=Chapter 4. PowerPoint Tips, Tricks, and Secrets| date=2018 }}
* {{cite book |last=Perelman |first=Leslie |date=1998 |title=The Mayfield Handbook of Technical and Scientific Writing |url=https://www.mit.edu/course/21/21.guide/ |location=Mountain View |publisher=Mayfield Publishing Company |pages=n.p. |isbn= |author-link= }}
* {{cite web |url=https://proofed.com/writing-tips/a-beginners-guide-to-technical-writing/ |title=A Beginner’s Guide to Technical Writing |last=Proofed Editors |date=2020 |website=Proofed.com |publisher=Proofed |access-date=2023-11-05 |ref=harv}}
* {{cite journal |last=Rathbone |first=Robert |title=Growth of the technical writing profession |journal=STWE Review |volume=5 |issue=1 |date=1958 |pages=5-16 }}
* {{cite book |last=Rose|first=Darren |last2=Garret |first2=Chris|date=2012 |title=ProBlogger: Secrets for Blogging Your Way to a Six-Figure Income|url=|location=Indianapolis, IN |publisher=Jon Wiley & Sons, Inc|pages=|isbn=|author-link= |ref=harv }}
*{{cite book |last=Robbins |first=Jennifer Niederst |date=2018 |title=Learning Web Design: A Beginner’s Guide to HTML, CSS, JavaScript, and Web Graphics (5th ed.) |url= |location=Sebastopol, CA |publisher= O’Reilly Media, Inc. }}
* {{cite web |url=https://writingcooperative.com/intricacies-of-ai-tools-can-ai-tools-take-over-the-jobs-of-technical-writers-af36836f625c |last=Siddiqui |first=Zafar |title=Will Best Artificial Intelligence Take Over any Technical Content Writer? |date=2022 |website=writingcooperative.com |publisher=The Writing Cooperative |access-date=2023-11-19 }}
* {{cite web |url=https://www.managementnote.com/features-of-technical-communication/#google_vignette |title=Features of Technical Communication |last=Smirti |date=2022 |website=managementnote.com |publisher=Management Note |access-date= 2023-11-05 }}
* {{cite web |url=https://www.stc.org/about-stc/ |title=About STC |last=Society for Technical Communication |first= |date=2023a |website=stc.org |publisher= |access-date=2023-10-27 }}
* {{cite web |url=https://www.stc.org/about-stc/ethical-principles/ |title=Ethical Principles |last=Society for Technical Communication |first= |date=2023b |website=stc.org |publisher= |access-date=2023-10-27 }}
* {{cite web |url=https://www.bls.gov/ooh/media-and-communication/technical-writers.htm#tab-6 |title=Occupational Outlook Handbook |last=United States Bureau of Labor Statistics |first= |date=2023 |website=bls.gov |publisher=United States Department of Labor |access-date=2023-11-07 }}
* {{cite web |url=https://uca.edu/cetal/chat-gpt/ |title=Chat GPT: What is it? |last=University of Central Arkansas |first= |date= |website=uca.edu |publisher= University of Central Arkansas |access-date=2023-10-09 }}
* {{cite web |url=https://www.viralnation.com/blog/what-is-digital-content-creation-and-how-can-it-help-me-as-a-marketing-manager/#:~:text=A%20rule%20of%20thumb%20in%20digital%20content%20creation,turn%2C%20share%20it%20with%20others%20in%20their%20network. |title=What is Digital Content Creation? (and How Can It Help Me as a Marketing Manager) |last=Viral Nation |date=2019 |website=viralnation.com |publisher= Viral Nation |access-date=2023-11-05 |ref=harv}}
* {{cite web |url=https://www.w3.org/WAI/fundamentals/accessibility-intro/|title=Introduction to Web Accessibility |last=WAI |first=|date=2022 |website=W3.org|publisher= |access-date= 2023-10-26 |quote= }}
* {{cite web |url=https://wcag.com/legal/|title=Accessibility and the Law |last=WCAG |first= |date=2023 |website=wcag.com|publisher=eSSENTIAL Accessibility |access-date= 2023-10-26 |quote= }}
* {{cite book |last=Zeleznik |first=J. M. |last2=Burnett |first2=R. E. |last3=Benson |first3=P. J. |date=1999 |title=Technical Writing: What It Is and How to Do It |url= |location= |publisher=National Book Network |pages=107 |isbn= |author-link= }}
{{Refend}}

[[Category:Fall 2023]]
[[Category:ENGL 5106]]

Technical Writing in the Digital Age

2023-11-22T02:39:36Z

APitts: /* Press Releases */ Added information on topic.

'''Technical Writing in the Digital Age''' represents the dynamic and evolving discipline of creating written materials that convey complex information, instructions, and technical concepts in the context of contemporary digital technologies. Its purview encompasses the creation, dissemination, and management of technical documents and content within an expansive digital landscape.

Major considerations revolve around adapting traditional principles of rhetoric to digital platforms, ensuring effective communication in an era defined by rapid technological advancements. 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. The use of multi-modality and the interfacing of multiple media platforms and sources also plays a role in digital technical writing. In essence, technical writing in the digital age encapsulates the art and science of conveying technical information in a manner that is comprehensible and accessible to diverse audiences in our digitally driven society.

==Overview==

=== Aims of Technical Communication ===
As much as technical communication is a discipline in and of itself, it also exists within many other disciplines. Examples of technical communication communities can be found among such fields as varied as education, business, and science. Technical documentation within any domain typically embodies a similar aim: to help its audience act toward some sort of task or goal. {{sfn|Markel|Selber|2019}}

=== Characteristics of Technical Communication ===
Because technical communication is intended to guide an audience, it must be assembled in such a way that it is very 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.

== 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}}

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

==== Case Studies ====
Case studies are a form of empirical or observational research that consists of in-depth examination of distinct individuals, groups, events, or scenarios. This research can be used to generate qualitative or quantitative data. {{sfn|Johnson-Sheehan |2018|p=401-404}}

==== Data Sheets ====
A data sheet, also known as a technical datasheet, is a document used to describe and summarize the characteristics of a product, material, component, or technology. {{sfn|IDA|2020|p=}}

====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|p=443-453}}

*Product: provides detailed information about a specific item, including its features, specifications, and benefits.
*Process: provides step-by-step instructions on how to perform a particular task or achieve a specific outcome.

==== Documentation ====
Documentation comprises various texts that allow users to accomplish tasks or gain information. It generally falls into three categories, which can be defined as follows:
* Instructions: Text that describes how to complete a task, often offering numbered steps. Examples include how to download software or assemble a product.{{sfn|Balzotti |2022|p=167}}
* Specifications: Communications that deliver technical details on how a product is put together or a specific operation is executed. Also known as "specs," these texts may be written by engineers or technicians.{{sfn|Johnson-Sheehan |2018|p=205}}
* Procedures and Protocols: Guidelines to ensure consistency, quality, and safety in the workplace. For example, a hospital may provide staff with procedures on how to adapt operations during an emergency, such as a power outage.{{sfn|Johnson-Sheehan |2018|p=205}}

==== Email ====
Emails are the primary form of communication in the workplace, used for both internal and external communication. They facilitate information exchange, idea exchange, and activity coordination.{{sfn|Lannon & Gurak |2020|p=335}} Emails should be brief, concise, readable, and targeted to specific audiences with specific subject lines.{{sfn|Lannon & Gurak |2020|p=348}}

==== Letters ====
Letters are a traditional form of communication most often used by employees to communicate with individuals outside of a company or organization. They are typically written on company letterhead. Today, letters are sent either by U.S. mail or electronically. {{sfn|Johnson-Sheehan |2018|p=139}}

==== Memos ====
A memo (short for memorandum) is an official communication, usually a message from the company, a manager or director, or another person or group acting in an official capacity, used to communicate with others within the same organization. {{sfn|Lannon & Gurak |2020|p=353}}

==== 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.<ref>Pradhan, N. (2021). [https://learn.g2.com/how-to-write-a-press-release "How to Write a Press Release That Catches People's Attention."]

Retrieved 21 November 2023</ref>

==== Proposals ====
A proposal is a document that identifies an existing problem or opportunity and outlines a comprehensive strategy for addressing it. Organizations create ''internal'' proposals to describe programs and projects that meet specific operational needs, such as a plan to replace an outdated software system. Companies develop ''external'' proposals for potential customers or clients. These documents detail new products, services, or initiatives that a company will implement to address a specific customer concern.{{sfn|Johnson-Sheehan |2018|p=245}}

==== Reports ====
A report is a concise, easily understandable document that presents technical information in a clear, organized format, allowing readers to access varying levels of information. Reports are categorized as informal, such as briefs, and formal, such as research, scientific, and completion reports. {{sfn|Johnson-Sheehan |2018|p=Chap 10 & 11}}

===== Informal Reports =====
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. Brief reports are categorized into three subcategories:

* Progress reports inform management about the progress or status of a project.
* White papers educate management or clients about important issues.

===== Formal Reports =====
A formal report is a factual and data-driven response to a research question.
* Research reports present the findings of a study.
* Scientific research reports outline the process, progress, and results of technical or scientific research or the current state of a research problem.
* Completion reports assess the outcomes of a project or initiative and provide feedback to management or the client.

==== Resumes ====
Résumés 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 résumés demonstrate the sequence of education and employment history and detail a person’s tasks, responsibilities, and achievements in each successive role. Skills résumés 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|p=411-412}}

==== User guides ====

== Features of Technical Communication ==
Technical communication involves conveying complex information to a specific audience. Key features include accuracy, attention to detail, visuals, and clear and concise organization to enhance user understanding. {{sfn|Smirti|2022}}

=== Accuracy ===

==== Standards Compliant ====
Many technical fields have industry-specific regulations and guidelines which are determined by governing bodies and that also have an impact on their technical communication. Furthermore, many organizations may have a style guide that outlines preferred language usage, tone, and formatting. {{sfn|Smirti|2022}}

==== Detailed ====
Accurate information that is delivered with precision and specificity is essential to providing communication that is unambiguous and free of discrepancies. {{sfn|Smirti|2022}} It is free of errors and inconsistencies.

==== Objective ====
Objective communication is presented in an unbiased and impartial manner and is free of personal opinions. It relies upon facts and evidence and avoids an overly emotional tone. This approach is particularly important in fields where accuracy and impartiality are essential. {{sfn|Rachel Detweiler|2021}}

===== Clear and Concise =====
Clear language is organized logically, is not unnecessarily involved, and is easily understood by the target audience. It will avoid needless jargon and complexity. Good technical communication expresses meaning in a way that is straightforward and that avoids redundant words or excessive explanations. It is easy to both absorb and process. {{sfn|Smirti|2022}} {{sfn|Proofed Editors|2020}}

=== Soundness ===

==== Formatted and Organized ====
Technical documents should be formatted in a way that is consistent with the norms and standards of applicable professional fields. Additionally, formatting should adhere to guidelines which enhance usability. Information should be logically organized for easy reading comprehension. This may involve using headings, subheadings, bullet points, and numbered lists. Formatting detail should remain consistent throughout the document. {{sfn|Smirti|2022}} {{sfn|Proofed Editors|2020}}

==== Graphical ====
Technical communication utilizes visuals strategically to facilitate understanding of textual content. Visuals such as diagrams, charts, graphs or images can enhance understanding on a technical document. When presented properly, they can elucidate difficult concepts and make material accessible to a more diverse audience. {{sfn|AI and the LinkedIn Community|2023}}

=== Appropriateness ===

==== Audience-specific ====
Where possible, technical communication should be customized to align with the knowledge and needs of its audience. Communication style and tone should be tailored to match the audience's level of expertise and should take into consideration such factors as the the users' technical background, familiarity with the subject, and specific requirements. {{sfn|Viral Nation|2019}}

==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}} And 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}}

== Digital Technologies and Technical Writing==
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 thus, it can be accessed by anyone with access to the internet. Such a phenomenon can be exploited to increase the audience of a virtual document.

There are several web-based tools and techniques which allow digital documents to be more easily shared. Online word processors such as [https://www.google.com/docs/about/ Google Docs] and [https://www.microsoft.com/en-us/microsoft-365/sharepoint/collaboration SharePoint] allow documents to be readily disseminated. Comment capability allows audience members to interact about a document with one another as well as with the document author. Relationships created by such online interaction fosters an environment whereby online authors might choose to link the works of various others to their own personal websites. In all, technical documentation posted online can grow a considerable audience over time. However, many aspects of effective technical writing, such as clarity, conciseness, completeness, and correctness, still need to be applied to technical writing created for digital interfaces. {{sfn|Carroll|2010|p=24}}

==Personas in Digital Writing==
Personas in the context of digital writing refer to semi-fictional characters that encapsulate the characteristics, behaviors, and needs of target audience segments. They align closely with the principles of user-centered design (UCD).{{sfn|Lucas|2023a}}
There are myriad ways to integrate user-centered thinking into the creative process of UX design, and personas are one of the most effective ways to empathize with and analyze users.{{sfn|Goltz|2014}}

==Rhetorical Strategies in the Digital Age==
Rhetoric is a communication strategy whose primary goal is to persuade an audience. It is grounded in three foundational concepts first defined by the Greek philosopher Aristotle. These concepts are ''logos'', which engages with the reader’s sense of logic or reason; ''pathos'', which appeals to the reader’s emotions; and ''ethos'', which addresses the audience’s values and the writer’s credibility. Within this framework, writers utilize specific techniques or devices to influence and engage readers. Examples include appealing to an audience’s sense of logic by using factual examples to support a point or evoking emotion through descriptive visual language. {{sfn|Gagich|Zickel|n.d.|pp=34-37}}

In today’s digital age, writers can use digital technologies as rhetorical devices to influence the reader. Electronic images and informational graphics can be incorporated into digital and online documents to illustrate or reinforce points made in the text.{{sfn|Markel|Selber|2019}} Hyperlinks can be used to provide additional information that supports the author's ideas. Nevertheless, the writer's basic task of informing and persuading an audience is the same in digital communication as in other forms of writing.{{sfn|DeVoss|National Writing Project|Eidman-Aadahl|Hicks|2010|p=105}}

Rhetorical analysis involves analyzing the demographics and habits of an intended audience. The information gathered allows writers to craft messages that appeal to the target audience. In the digital age, websites and social media platforms convey rhetorical messages.{{sfn|Lawrence|2022|pp=6-14}}

==Search Engine Optimization (SEO)==
SEO refers to the practice of optimizing online content to enhance its visibility and ranking on search engine results pages (SERPs), making it a crucial skill for digital writers.{{sfn|Lucas|2023b}} To optimize content for SEO means to have the goal of SEO in mind at the time of designing, creating, and writing a web page for publication. Using keywords and alt-text are two examples of optimizing content for SEO. {{sfn|Barr|2010|loc=chpt. 17}}

=== Keywords ===
Keywords are the words that search engines crawl a website for and index as the page's most important words. Based on other pages using the same keywords, the website is added into the search engine results pages from best matches to worse matches. Depending on where the website falls in that scale based on the specific keywords being searched by a user, influences where the website pops up in the associated search results.{{sfn|Lucas|2023b}} To optimize a website's keywords, you should begin with researching keywords on your own website and ensure that you have an XML [https://en.wikipedia.org/wiki/Sitemaps sitemap] so search engine's such as [https://en.wikipedia.org/wiki/Google Google] can crawl your web pages for updated information. In addition to using keywords, updating a page's metadata information can also help with showing up on SERPs. Using title and header tags as well as meta descriptions for content also helps optimize a website's ratings in SERPs.{{sfn|Lucas|2023b}}

=== Alt-Text ===
Alt-Text (alternative text), or [https://en.wikipedia.org/wiki/Alt_attribute Alt Attributes], is a practice that increases the usability and accessibility of a web page for users. Alt-Text is often used for visual elements that cannot be displayed in a different format but still provides description of the element for screen readers or users that may have a disability. Alt-Text also improves a website's SEO as a form of content optimization.{{sfn|Lucas|2023b}}

=== Social Media Presence ===
Sharing content from a website across different social media platforms is another way to create SEO optimization. This technique can help with being seen as legitimate and improves visibility of the website overall. Additionally it can drive traffic and enables back-linking to occur when other websites have the ability to also link to the website.{{sfn|Lucas|2023b}}

=== Goals of Searching: The User's Perspective ===
A user of search engines formulates queries by using keywords or posing questions. One of the most important elements of building an SEO strategy for a website is developing a thorough understanding of the psychology of your target audience, and how they use words and concepts to obtain information about the services and/or products you provide. Once you understand how the average search engine user—and, more specifically, your target audience—utilizes query-based search engines, you can more effectively reach and keep those users. {{sfn|Enge|2022|p=9}}

==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}}

===Characteristics of Digital Documents===

==== Electronic Format ====
Digital documents exist in electronic formats, which means they are stored and transmitted as binary data. This format allows for efficient storage, retrieval, and transmission of information via electronic devices.{{sfn|Lucas|2023c}}

==== Non-Tangible ====
Unlike paper documents, digital documents lack physical presence. They are intangible and exist as electronic files, residing on devices or in the cloud.{{sfn|Lucas|2023c}}

====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}} 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====
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====
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}}

==== Ease of Reproduction and Distribution ====
Digital documents are easily copied and distributed. They can be duplicated without any loss of quality, making it simple to share information widely and at minimal cost.{{sfn|Lucas|2023c}}

====Hyperlinking====
Hyperlinking is a quick and efficient method for directing readers to relevant information in digital documents, facilitating seamless navigation between sections, references, and external resources.{{sfn|Carroll|2010|p=79}}

====Multimedia====
Digital documents can incorporate multimedia elements like images, audio, video, and interactive content, enhancing engagement through visual and auditory elements. Multiple media formats work best when sharing new, complicated ideas.{{sfn|Carroll|2010|p=36}} Increasing multimodality on a website improves engagement, usability, and accessibility. This can improve the impact of the website's standings in SERPs.{{sfn|Carroll|2010|p=280}}

====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}}

==== Remote Collaboration ====
One form of collaborative technical writing is a wiki, which is a "Web site developed collaboratively by a community of users, allowing any user to add and edit content.{{sfn|Lucas|2021}} One of the predominant elements of a wiki is that it is defined as being open source. As a result, anyone can modify it regardless of their geographic locations.

==== Security Measures ====
Digital documents can be protected with encryption, passwords, and access controls to safeguard sensitive information. These security measures enhance data protection and privacy.{{sfn|Lucas|2023c}}

==== Environmental Impact ====
Digital documents have a smaller environmental footprint compared to paper documents, as they reduce the need for paper production, printing, and transportation.{{sfn|Lucas|2023c}}

==== Dynamic Updates ====
Online digital documents can be updated dynamically, ensuring that users always have access to the most current information. This is particularly valuable in fast-changing fields.{{sfn|Lucas|2023c}}

==== Global Accessibility ====
Digital documents can be shared globally, transcending geographical boundaries and time zones. They support international collaboration and the dissemination of knowledge on a global scale.{{sfn|Lucas|2023c}}

==== Data Integration ====
In business and research settings, digital documents can integrate with databases and data analysis tools. This integration streamlines data collection, analysis, and reporting processes.{{sfn|Lucas|2023c}}

==== Data Analytics ====
Digital documents can be subjected to data analytics techniques, allowing organizations to extract valuable insights from large volumes of textual data, which can inform decision-making and strategy.{{sfn|Lucas|2023c}}

==Examples of Digital Documents==
In technical and professional writing, digital documentation takes various forms. These methods streamline the sharing of technical information, enhance collaboration, and ensure easy accessibility within professional settings, contributing to efficient communication and knowledge dissemination.

==== Infographics ====
Infographics, shared as digital documents, typically combine text, graphics, and illustrations to convey complex concepts or data in a concise and visually appealing format. Infographics are often used to simplify information, making it more accessible to a broader audience, and are found in presentations, reports, websites, and educational materials. {{sfn|Lannon|Gurak|2020|pp=292-293}}

==== Presentations ====
Presentations created with [https://en.wikipedia.org/wiki/Microsoft_PowerPoint PowerPoint] or [https://en.wikipedia.org/wiki/Google_Slides Google Slides] are vital for professional communication and knowledge sharing. They condense complex information into visually appealing slides for effective presentations by using photos, videos, graphics, charts, and graphs.{{sfn|Parkinson|2018|loc=chpt. 4}}

==== Blogs ====
A blog, short for "weblog," is an informational website organized into short articles called posts, typically chronologically ordered series of website updates, written and organized similar to a traditional diary.{{sfn|Bair|2014|p=7}} They are regularly updated, providing readers with insights on a specific topic or subject. Blogs serve various purposes, including sharing opinions, providing news, offering educational content, and documenting personal experiences.{{sfn|Rose & Garret|2012|p=2}}

==User Experience==
User experience is how a product works from the perspective of the user. Digital documents can be created with efficient user experiences by focusing on user-centered design. {{sfn|Garrett|2011|p=17}}

=== User-Centered Design ===
The approach of user-centered design (UCD) in technical writing consists of the following methodology{{sfn|Lucas|2023e}}:

==== User Research ====
User research is the act of conducting thorough research through surveys, interviews, and usability testing to gain a better understanding of user needs and experiences when using a digital document.

==== Ideation and Prototyping ====
Ideation and prototyping refers to the process of creating digital designs and prototypes to assist with exploring possible solutions to meet user needs.

==== Usability Testing ====
Usability testing refers to the act of having users interact with digital document designs and recording and adjusting the design based on user feedback.

==== Implementation ====
Implementation is the stage in which the design is implemented after making adjustments from prior testing.

==== Evaluation ====
Evaluation refers to the stage in which the digital document is assessed to ensure that it is meeting user needs.

==== Maintenance and Updates ====
Maintenance and updates are required in order to maintain a digital document based on user feedback and changing needs.

==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|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}}

Technical communicators also have to be careful to avoid plagiarism, or taking ideas, thoughts, or words from someone else and passing them off as one's own.{{sfn|Carroll|2010|p=280}}

Technical communicators have ethical standards to which they must abide. The standards are divided into three primary categories. They are the employer, the public, and the environment.{{sfn|Markel|2009}}

=== The Employer ===
Obligations to one's employer include competence and diligence, honesty and candor, confidentiality, and loyalty.{{sfn|Markel|2009}} The technical communicator must adhere to these obligations so that he/she does not harm the reputation or operation of the employer.

Technical communicators may occasionally work for an organization with strict privacy policies that prohibit them from using the documents they create outside of the organization. It is important for ethical communicators to follow the privacy policy for their organization because unauthorized release of information could lead to consequences up to and including termination.{{sfn|Balzotti|2022|p=83}}

=== The Public ===
Organizations are obligated to treat customers fairly. Technical communicators must convey that the products or services an organization sells are safe and effective.{{sfn|Markel|2009}}

=== The Environment ===
Technical communicators have an obligation to the environment. This obligation includes alerting their supervisors, managers, and executive leadership to products or processes that are detrimental to the environment. Protecting the environment can be costly, however, and organizations may consider ignoring legal guidelines to save money.{{sfn|Markel|2009}} Yet, failure to adhere to U.S. Environmental Protection Agency regulations also has financial implications. For example, the penalty for mishandling hazardous waste is five years and/or up to $50,000 for each day of the violation.{{sfn|EPA|2023}}

===Disinformation===
One major ethical concern in all forms of writing, but especially in digital writing, is the creation and spread of disinformation. Disinformation, often referred to as "[[w:Fake news|fake news]]," is information that is purposefully spread as false or misleading and is a sub-type of misinformation.{{sfn|Lawrence|2022|loc=section 3.7}} Modern communication technologies allow for the spread of information to occur at a fast pace. Social media is one area where the spread of disinformation occurs regularly. Some social media sites, such as Facebook, have begun to flag certain articles posted on the site as being questionable in their representation of facts or occurrences. Despite the widespread understanding and use of disinformation available today, digital writers need to be aware of their intent and the audience's needs and wants from their digital communication.{{sfn|Lucas|2023f}} Ethical considerations regarding citing sources, cross-referencing information, and using primary sources are good practices for maintaining ethical standing and credibility as a digital writer.

To help mitigate the problem of disinformation, technical writers should utilize gatekeepers. These individuals verify the accuracy of the information before it is distributed to primary readers. This helps protect the author from any ethical and/or legal issues.{{sfn|Balzotti|2022|p=83}}

==Pedagogical Approaches==
Barriers to teaching technical communications include the speed at which digital tools evolve and the complexity of software. {{sfn|Hovde|2017|pp=395-411}}

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. Others even used emoticons. Colleges and universities now must focus on educating students on the different forms of written communication and when best to employ them.{{sfn|Carroll|2010|p=280}}

==Future Trends and Challenges==
===Future Trends===
Between 2022 and 2032, the [https://en.wikipedia.org/wiki/Bureau_of_Labor_Statistics, United States Bureau of Labor Statistics] is projecting a 7% job growth for technical writers. {{sfn|United States Bureau of Labor Statistics|2023}} To be relevant as a technical writer in the digital age, one must possess the skills of conducting in-depth research, critical thinking, being detail oriented, design, and technical expertise. To succeed at communicating the complex to specific audiences, the technical writer must understand much of the subject in its complexity. This is accomplished through possessing the skills of communication, collaboration, and teamwork.<ref>{{cite web |url=https://technicalwriterhq.com/career/technical-writer/technical-writing-skills/ |title=Essential Technical Writing Skills |author=Josh Fechter |website=Technical Writer HQ |access-date=21 November 2023}}</ref>

===Challenges===
Among others, a prominent barrier to technical writers is the dependency on input information accuracy. Outdated, incorrect, or inconsistent data delays the publication, requires more reparative efforts, and decreases productivity.{{sfn|Ajose-Coker|2022}} Also, Technical writers often have to contend with complex, outdated or unsuitable tools. This can make their job more difficult and time-consuming, and can lead to frustration and errors.{{sfn|Ajose-Coker|2022}}

===Artificial Intelligence===
Artificial intelligence programs, utilizing natural language processing, are capable of producing technical writing and have advanced in recent years becoming more adept.{{sfn|Marr|2023}}

One such program is [https://en.wikipedia.org/wiki/ChatGPT ChatGPT], which uses machine learning to produce texts with human-like style and tone. {{sfn|University of Central Arkansas|2023}} Another leader in this area, Contentbot, uses a WordPress plugin which gives blog writers ideas to enhance their posts which are shared via email.{{sfn|Siddiqui|2022}}

===Plagiarism===
Because of the ability of chatbots to imitate human-like language, some education administrators have taken precautions to minimize the occurrence of students passing off artificially generated texts as their own. In some instances, educators have taken the view that material drawn from artificial intelligence software must be handled in the same way as sources from human authors. {{sfn|Klein|2023}} In such cases, students who incorporate artificially generated text into their work have been made to denote credit for the artificial intelligence program utilized.

===Credit===
The advent of chatbots has complicated the issue of credit where creative work is concerned. Because chatbots can simulate human speech, their ability to create cinematic dialogues and other types of creative writing have threatened the credits and financial condition of professional writers. According to an article by Aaron Mok and Jacob Zinkula on ''[https://www.businessinsider.com/ Business Insider]'', writing jobs are among the top 10 roles that AI is most likely to replace. {{sfn|Mok|2023}}

==References==
===Citations===
{{Reflist}}

===Bibliography ===
{{Refbegin|30em}} 
* {{cite web |url=https://www.linkedin.com/advice/0/how-can-you-create-effective-visual-aids-1c |title=How Can You Create Effective Visual Aids for Technical Writing? |last=AI and the LinkedIn Community |date=2023 |website=www.linkedin.com |publisher=LinkedIn |access-date=2023-11-05 |ref=harv}}
* {{cite web |url=https://componize.com/common-problems-in-technical-writing-and-how-to-resolve-them/ |title=Common Problems in Technical Writing and How to Solve Them |last=Ajose-Coker |first=Dipo |date=2022 |website=componize.com |publisher=Componize Software |access-date=2023-11-19 }}
* {{cite book |last=Bair|first=Amy Lupold |date=2014 |title=Blogging for Dummies|url=|location=Hoboken, NJ |publisher=Jon Wiley & Sons, Inc|pages=|isbn=|author-link= |ref=harv }}
* {{cite book |last=Balzotti |first=Jon|date=2022 |title=Technical Communication: A Design-Centric Approach |url= |location=New York |publisher=Routledge |page=83 }}
* {{cite book |last=Balzotti |first=Jon|date=2022 |title=Technical Communication: A Design-Centric Approach |url= |location=New York |publisher=Routledge |page=167 }}
* {{cite book |last=Barr |first=Chris |date=2010 |title=The Yahoo! Style Guide |url= |location=New York |publisher=St. Martin's }}
* {{cite book |last=Carroll |first=Brian |date=2010 |title=Writing for Digital Media |url= |location=New York |publisher=Routledge }}
* {{cite web |url=https://uca.edu/cetal/chat-gpt/ |title=Chat GPT: What is it? |last=University of Central Arkansas |first= |date= |website=uca.edu |publisher= University of Central Arkansas |access-date=2023-10-09 }}
* {{cite web |url=https://www.betonconsultingeng.com/objectivity-in-technical-writing/#:~:text=Pointers%20for%20objective%20technical%20writing%201%20If%20you,5%20Remember%20that%20correlation%20is%20not%20causality.%20 |title=Objectivity in Technical Writing |last=Detwiler |first=Rachel |date=2021 |website=www.betonconsultingeng.com |publisher=Beton Consulting Engineers L.L.C. |access-date=2023-11-05 |ref=harv}}
* {{cite book |last=DeVoss |first=Danielle |last2=National Writing Project |last3=Eidman-Aadahl |first3=Elyse |last4=Hicks |first4=Troy |date=2010 |title=Because Digital Writing Matters: Improving Student Writing in Online and Multimedia Environments |location=San Francisco |publisher=Jossey-Bass |pages=105 |isbn= |url=https://openlibrary.org/books/OL34593323M/Because_Digital_Writing_Matters }}
*{{cite book |last=Enge |first=Eric |last2=Spencer |first2=Stephan |last3=Stricchiola |first3=Jessie |date=2022 |title=The Art of SEO: Mastering Search Engine Optimization |url=https://archive.org/details/artofseomasterin0000enge |location=Sebastopol, CA |publisher=O'Reilly |pages=9 |ref=harv }}
* {{cite web |url=https://www.epa.gov/enforcement/criminal-provisions-resource-conservation-and-recovery-act-rcra |title=Criminal Provisions of the Resource Conservation and Recovery Act (RCRA) |date=2023 |publisher=United States Environmental Protection Agency }}
* {{cite book |last=Gagich |first=Melanie |last2=Zickel |first2=Emilie |date=n.d. |title=Writing Arguments in Stem |chapter=Rhetorical Appeals: Logos, Pathos, and Ethos Defined |publisher=Digital Commons |url=https://digitalcommons.calpoly.edu/cgi/viewcontent.cgi?article=1000&context=oercoursematerials#page=44 |location= |pages=34-37 }}
* {{cite book |last=Garrett |first=Jesse James |title=The Elements of User Experience: User-Centered Design for the Web and Beyond |publisher=New Riders |edition=2nd |date=2011 |location=Berkeley, CA |page=17 }}
* {{cite web |url=https://smashingmagazine.com/2014/08/a-closer-look-at-personas-part-2/ |title=A Closer Look at Personas: A Guide to Developing The Right Ones (Part 2) |last=Goltz | first=Shlomo |date=2014 |website=smashingmagazine.com |publisher=Smashing Media AG |access-date=2023-11-13 }}
* {{cite magazine |last=Grimstead |first=Deborah M. |date=1999 |title=Technical Writers are in Demand: Do You Have The Right Stuff? |magazine=Black Collegian |pages=128 }}
* {{cite web |url=https://www.idassoc.com/product-information-definition/data-sheet |title=Product Information Encyclopedia |last=IDA |first= |date=2020 |website=Industrial Data Associates |publisher= |access-date=2023-11-20 |quote= |ref=harv }}
* {{cite book |last=Johnson-Sheehan |first=Richard |title=Technical Communication Today |url= |edition=6 |chapter=Chapter 4: Managing Ethical Challenges |location=Boston, MA |publisher=Pearson |date=2018 |pages=71-98 }}
* {{cite news |last=Klein |first=Alyson |date=2023 |title=ChatGPT Cheating: What to Do When It Happens |url=https://www.edweek.org/technology/chatgpt-cheating-what-to-do-when-it-happens/ |work=Education Week |location=Bethesda, MD |access-date=2023-11-05 }}
* {{cite book |last=Krug |first=Steve |date=2014 |title=Don’t Make Me Think, Revisited|url= |location=Berkeley, CA |publisher=New Riders |pages= |isbn= |author-link= }}
* {{cite book |last=Lannon |first=John M. |last2=Gurak |first2=Laura J. |date=2020 |title=Technical Communication |edition=15 |url= |location= |publisher=Pearson Education |page= }}
* {{cite book |last=Last|first=Susan |date=2019 |title=Technical Writing Essentials|url=https://pressbooks.bccampus.ca/technicalwriting/chapter/communicatingprecision/|location= |publisher= Victoria, B.C. University of Victoria |pages= |isbn= |author-link= }}
* {{cite book |last=Lawrence |first=Dan |date=2022 |title=Digital Writing: A Guide to Writing for Social Media and the Web |location=Peterborough, Ontario, Canada |publisher=Broadview Press |page=85 }}
* {{cite web |url=https://grlucas.net/grl/Writing_on_a_Wiki |title=Writing on a Wiki |last=Lucas |first=Gerald| date=2021| website=grlucas.net| publisher=MediaWiki| access-date=2023-10-31 }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Personas |title= Using Personas in Digital Writing
|last=Lucas |first=Gerald |date=2023a| website=grlucas.net |publisher=MediaWiki |access-date=2023-11-07 }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/SEO |title=Search Engine Optimization: Strategies and Best Practices for Effective Online Visibility |last=Lucas |first=Gerald |date=2023b |website=grlucas.net |publisher=MediaWiki |access-date=2023-11-19 }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Documents|title=Exploring the Dichotomy: A Comparative Analysis of Digital and Paper Documents |last=Lucas |first=Gerald |date=2023c |website=grlucas.net |publisher=MediaWiki |access-date=2023-10-29 |quote= }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Design/Users |title=User-Centered Design in Digital Documents |last=Lucas |first=Gerald |date=2023d |website=grlucas.net |publisher=MediaWiki |access-date=2023-11-15 |quote= }}
* {{cite web |url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Style |title=Audience-Centric Style in Digital Writing |last=Lucas |first=Gerald |date=2023e |website=grlucas.net |publisher=MediaWiki |access-date=2023-10-22 |quote= }}
* {{cite web |url=https://www.indeed.com/career-advice/careers/what-does-a-technical-writer-do |title=What Does a Technical Writer Do? (Plus How To Become One) |last=Macari |first=Sabina |date=2023 |website=indeed.com |publisher=Indeed |access-date=2023-11-05 }}
* {{cite magazine |last=Malone |first=Ed |date=2008 |title=Joseph D. Chapline: Technical Communication's Mozart |url=https://web.mst.edu/~malonee/chapline.pdf |magazine=IEEE Professional Communication Society Newsletter |access-date=2023-10-31 }}
* {{cite journal |last=Malone |first=Edward |date=November 2011 |title=The First Wave (1953-1961) of the Professionalization Movement in Technical Communication |url=https://www.stc.org/techcomm/wp-content/uploads/sites/3/2016/08/november-2011-58-4.pdf |journal=Technical Communication |volume=58 |issue=4 |pages=285-306 |doi= |access-date=2023-10-11 }}
* {{cite book |last=Markel |first=Michael |title=Technical Communication |date=2009 |edition=9th |location=Boston |publisher=Bedford/St. Martin's |pages=22-25 }}
* {{cite book |last=Markel |first=Mike |last2=Selber |first2=Stuart A. |date=2019 |title=Practical Strategies of Technical Communication |edition=3rd |url= |location=Boston |publisher=Bedford/St. Martin’s |page= }}
* {{cite web |url=https://www.forbes.com/sites/bernardmarr/2023/01/23/how-chatgpt-and-natural-language-technology-might-affect-your-job-if-you-are-a-computer-programmer/?sh=6d9acf79174b |title=How ChatGPT And Natural Language Technology Might Affect Your Job If You Are A Computer Programmer |last=Marr |first=Bernard |date=2023 |website=Forbes.com |publisher=Forbes Media |access-date=2023-10-31 |quote= }}
* {{cite web |url=https://www.businessinsider.com/chatgpt-jobs-at-risk-replacement-artificial-intelligence-ai-labor-trends-2023-02 |title=ChatGPT may be coming for our jobs. Here are the 10 roles AI is most likely to replace |last=Mok |first=Aaron |date=2023 |website=Insider |publisher=Business Insider |access-date= 2023-11-05 }}
* {{cite book |last=Mussack |first=Brigitte |date=2021 |title=Introduction to Technical and Professional Communication |url=https://pressbooks.umn.edu/techwriting/front-matter/introduction/ |location= |publisher=Creative Commons Attribution NonCommercial |pages=n.p. |author-link= }}
* {{cite book| last=Parkinson |first=Mike |title=A Trainer’s Guide to PowerPoint: Best Practices for Master Presenters| location=United States| publisher=Association for Talent Development| chapter=Chapter 4. PowerPoint Tips, Tricks, and Secrets| date=2018 }}
* {{cite book |last=Perelman |first=Leslie |date=1998 |title=The Mayfield Handbook of Technical and Scientific Writing |url=https://www.mit.edu/course/21/21.guide/ |location=Mountain View |publisher=Mayfield Publishing Company |pages=n.p. |isbn= |author-link= }}
* {{cite web |url=https://proofed.com/writing-tips/a-beginners-guide-to-technical-writing/ |title=A Beginner’s Guide to Technical Writing |last=Proofed Editors |date=2020 |website=Proofed.com |publisher=Proofed |access-date=2023-11-05 |ref=harv}}
* {{cite journal |last=Rathbone |first=Robert |title=Growth of the technical writing profession |journal=STWE Review |volume=5 |issue=1 |date=1958 |pages=5-16 }}
* {{cite book |last=Rose|first=Darren |last2=Garret |first2=Chris|date=2012 |title=ProBlogger: Secrets for Blogging Your Way to a Six-Figure Income|url=|location=Indianapolis, IN |publisher=Jon Wiley & Sons, Inc|pages=|isbn=|author-link= |ref=harv }}
*{{cite book |last=Robbins |first=Jennifer Niederst |date=2018 |title=Learning Web Design: A Beginner’s Guide to HTML, CSS, JavaScript, and Web Graphics (5th ed.) |url= |location=Sebastopol, CA |publisher= O’Reilly Media, Inc. }}
* {{cite web |url=https://writingcooperative.com/intricacies-of-ai-tools-can-ai-tools-take-over-the-jobs-of-technical-writers-af36836f625c |last=Siddiqui |first=Zafar |title=Will Best Artificial Intelligence Take Over any Technical Content Writer? |date=2022 |website=writingcooperative.com |publisher=The Writing Cooperative |access-date=2023-11-19 }}
* {{cite web |url=https://www.managementnote.com/features-of-technical-communication/#google_vignette |title=Features of Technical Communication |last=Smirti |date=2022 |website=managementnote.com |publisher=Management Note |access-date= 2023-11-05 }}
* {{cite web |url=https://www.stc.org/about-stc/ |title=About STC |last=Society for Technical Communication |first= |date=2023a |website=stc.org |publisher= |access-date=2023-10-27 }}
* {{cite web |url=https://www.stc.org/about-stc/ethical-principles/ |title=Ethical Principles |last=Society for Technical Communication |first= |date=2023b |website=stc.org |publisher= |access-date=2023-10-27 }}
* {{cite web |url=https://www.bls.gov/ooh/media-and-communication/technical-writers.htm#tab-6 |title=Occupational Outlook Handbook |last=United States Bureau of Labor Statistics |first= |date=2023 |website=bls.gov |publisher=United States Department of Labor |access-date=2023-11-07 }}
* {{cite web |url=https://uca.edu/cetal/chat-gpt/ |title=Chat GPT: What is it? |last=University of Central Arkansas |first= |date= |website=uca.edu |publisher= University of Central Arkansas |access-date=2023-10-09 }}
* {{cite web |url=https://www.viralnation.com/blog/what-is-digital-content-creation-and-how-can-it-help-me-as-a-marketing-manager/#:~:text=A%20rule%20of%20thumb%20in%20digital%20content%20creation,turn%2C%20share%20it%20with%20others%20in%20their%20network. |title=What is Digital Content Creation? (and How Can It Help Me as a Marketing Manager) |last=Viral Nation |date=2019 |website=viralnation.com |publisher= Viral Nation |access-date=2023-11-05 |ref=harv}}
* {{cite web |url=https://www.w3.org/WAI/fundamentals/accessibility-intro/|title=Introduction to Web Accessibility |last=WAI |first=|date=2022 |website=W3.org|publisher= |access-date= 2023-10-26 |quote= }}
* {{cite web |url=https://wcag.com/legal/|title=Accessibility and the Law |last=WCAG |first= |date=2023 |website=wcag.com|publisher=eSSENTIAL Accessibility |access-date= 2023-10-26 |quote= }}
* {{cite book |last=Zeleznik |first=J. M. |last2=Burnett |first2=R. E. |last3=Benson |first3=P. J. |date=1999 |title=Technical Writing: What It Is and How to Do It |url= |location= |publisher=National Book Network |pages=107 |isbn= |author-link= }}
{{Refend}}

[[Category:Fall 2023]]
[[Category:ENGL 5106]]

Talk:Technical Writing in the Digital Age

2023-11-13T16:46:58Z

APitts: /* Paragraph Blocks */

Technical Writing in the Digital Age

2023-11-13T16:44:45Z

APitts: /* The Employer */ Reformatted the paragraph blocks to fit each category.

'''Technical Writing in the Digital Age''' represents the dynamic and evolving discipline of creating written materials that convey complex information, instructions, and technical concepts in the context of contemporary digital technologies.<ref name=":3">Markel, Mike, and Selber, Stuart. (2021). ''Technical Communication'' (13th ed). Boston/New York. Bedford/St. Martin's: 182-186. [https://openlibrary.org/books/OL36001026M/Technical_Communication ISBN: 978-1-319-30769-1]</ref> Its purview encompasses the creation, dissemination, and management of technical documents and content within an expansive digital landscape.

Major considerations within this domain revolve around adapting traditional principles of rhetoric to digital platforms, ensuring effective communication in an era defined by rapid technological advancements. Key factors include integrating multimedia elements, user-centered design principles, and ethical considerations like accessibility and inclusivity.<ref name=":1">Carroll, Brian, (2010). ''Writing for Digital Media.'' New York: Routledge. </ref> 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. The use of multi-modality and the interfacing of multiple media platforms and sources also plays a role in digital technical writing.<ref>{{cite web
| url = https://grlucas.net/grl/CompFAQ/Digital_Writing/Multimodal_Approach
| title = multimodal-approaches-in-technical-writing
| last = Lucas
| first= Gerald-R
| date= September 19, 2023
| website = Gerald-R-Lucas
| publisher = ghost
| access-date =October 30, 2023
| ref = harv
}}</ref> In essence, technical writing in the digital age encapsulates the art and science of conveying technical information in a manner that is comprehensible and accessible to diverse audiences in our digitally driven society. <ref>{{cite web
| url = https://grlucas.net/grl/CompFAQ/Technical_Writing
| title = Defining Technical Writing
| last = Lucas
| first= Gerald-R
| date= September 14, 2023
| website = Gerald-R-Lucas
| publisher = ghost
| access-date =November 7, 2023
| ref = harv
}}</ref>

==Overview==

===Types of Technical Communication===
Common types of technical communication include instructions, user guides, reports, proposals, memos, and procedures. <ref>{{cite book
| last1 = Lannon
| first1 = John
| last2 = Gurak
| first2 = Laura
| date = 2022
| title = Technical Communication
| edition = 15th
| publisher = Pearson Education Limited
| location = Essex, United Kingdom
| page = 30
| isbn = 1-292-36359-2
}}</ref>
<ref>Mussack, Brigitte. (2021). Introduction to Technical and Professional Communication: Technical Communication through a Social Justice Lens. Creative Commons Attribution NonCommercial, 2021. n.p.</ref>

=== Aims of Technical Communication ===
As much as technical communication is a discipline in and of itself, it also exists within many other disciplines. Examples of technical communication communities can be found among such fields as varied as education, business, and science. Technical documentation within any domain typically embodies a similar aim: to help its audience act toward some sort of task or goal. <ref>Markel, M (2007). Technical communication, 8th ed. Boston: Beford/St. Martin’s, p. 5.</ref>

=== Characteristics of Technical Communication ===
Because technical communication is intended to guide an audience, it must be assembled in such a way that it is very easily understood. Successful technical documentation is accurate, logically sound, and appropriate. <ref>Perelman, Leslie, et al. The Mayfield Handbook of Technical and Scientific Writing. 1998, ci.nii.ac.jp/ncid/BA73264379?l=en.</ref> 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.

== Features of Technical Communication ==
There are many features of technical communication which lead to it being accurate, sound, and appropriate. <ref>smirti. “Features of Technical Communication.” Management Note, 27 Feb. 2022, www.managementnote.com/features-of-technical-communication. Accessed 3 Nov. 2023.</ref>

=== '''Accuracy''' ===

==== Standards Compliant ====
Many technical fields have industry specific regulations and guidelines which are determined by governing bodies and that also have an impact on their technical communication.

==== Detailed ====
Accurate information that is delivered with precision and specificity is essential to providing communication that is unambiguous and free of inconsistencies.

==== Objective ====
Objective communication is presented in an unbiased and impartial manner and is free of personal opinions. It relies upon facts and evidence and avoids an overly emotional tone.

===== Concise =====
Good technical communication expresses meaning in a way that is straightforward and that avoids redundant words or excessive explanations. It is easy to both absorb and process.

==== Clear ====
Clear language is organized logically, is not unnecessarily involved, and is easily understood by the target audience. It will avoid needless jargon and complexity.

=== '''Soundness''' ===

==== Format ====
Technical documents should be formatted in a way that is consistent with the norms and standards of applicable professional fields. Additionally, formatting should adhere to guidelines which enhance usability.

==== Visuals ====
Technical communication utilizes visuals strategically to facilitate understanding of textual content. When presented properly, they can elucidate difficult concepts and make material accessible to a more diverse audience.

=== '''Appropriateness''' ===

==== Audience-specific ====
Where possible, technical communication should be customized to align with the knowledge and needs of its 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.<ref>{{cite magazine |last=Malone |first=Ed |date=2008 |title=Joseph D. Chapline: Technical Communication's Mozart |url=https://web.mst.edu/~malonee/chapline.pdf |magazine=IEEE Professional Communication Society Newsletter |access-date=October 31, 2023 }}.</ref> 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.<ref>{{cite journal |last1=Edward |first1=Malone |date=November 2011 |title=The First Wave (1953–1961) of the Professionalization Movement in Technical Communication |url=https://www.stc.org/techcomm/wp-content/uploads/sites/3/2016/08/november-2011-58-4.pdf |journal=Technical Communication |volume=58 |issue=4 |pages=285 - 306 |doi= |access-date=October 11, 2023}}</ref>

== Digital Technologies and Technical Writing==
With the rise of digital technology, technical writing has had to adapt to the needs of a digital era. The predominant impact of this revolution was that it made technical communication more accessible by increasing the breadth of its viewers. The world-wide web is public, and thus, it can be accessed by anyone with access to the internet.

Online word processors such as [https://www.google.com/docs/about/ Google Docs] and [https://www.microsoft.com/en-us/microsoft-365/sharepoint/collaboration SharePoint] allow documents to be easily disseminated. Comment capability allows audience members to interact with one another as well as with the document author. Hypertext permits online authors to link the works of various others to their personal websites and vice versa. In all, technical documentation posted online can grow a considerable audience over time. However, many aspects of effective technical writing, such as clarity, conciseness, completeness, and correctness, still need to be applied to technical writing created for digital interfaces. {{sfn|Carroll|2010|p=24}}
==Personas in Digital Writing==
Personas in the context of digital writing refer to semi-fictional characters that encapsulate the characteristics, behaviors, and needs of target audience segments.<ref>https://grlucas.net/grl/CompFAQ/Digital_Writing/Personas</ref>

==Rhetorical Strategies in the Digital Age==
Rhetoric is a communication strategy whose primary goal is to persuade an audience. It is grounded in three foundational concepts first defined by the Greek philosopher Aristotle. These concepts are ''logos'', which engages with the reader’s sense of logic or reason; ''pathos'', which appeals to the reader’s emotions; and ''ethos'', which addresses the audience’s values and the writer’s credibility. Within this framework, writers utilize specific techniques or devices to influence and engage readers. Examples include appealing to an audience’s sense of logic by using factual examples to support a point or evoking emotion through descriptive visual language. <ref>{{cite book |last=Gagich |first=Melanie |title=Writing Arguments in Stem |publisher=Digital Commons |date=n.d. |chapter=Rhetorical Appeals: Logos, Pathos, and Ethos Defined |url=https://digitalcommons.calpoly.edu/cgi/viewcontent.cgi?article=1000&context=oercoursematerials#page=44 |pages=34-37 }}</ref>

In today’s digital age, writers can use digital technologies as rhetorical devices to influence the reader. Electronic images and informational graphics can be incorporated into digital and online documents to illustrate or reinforce points made in the text.<ref name=":3" /> Hyperlinks can be used to provide additional information that supports the author's ideas. Nevertheless, the writer's basic task of informing and persuading an audience is the same in digital communication as in other forms of writing.<ref>{{cite book |last=Devos |first=Danielle |date=2010 |title=Because Digital Writing Matters: Improving Student Writing in Online and Multimedia Environments |location=San Francisco |publisher=Jossey-Bass |pages=105 |isbn=9780470892237 |url=https://openlibrary.org/books/OL34593323M/Because_Digital_Writing_Matters }}</ref>

Rhetorical analysis involves analyzing the demographics and habits of an intended audience. The information gathered allows writers to craft messages that appeal to the target audience. In the digital age, websites and social media platforms convey rhetorical messages. <ref>{{cite book
| last =Lawrence
| first =Dan
| date =2022
| title =Digital Writing
| location =Peterborough, Ontario, Canada
| publisher =Broadview Press
| page = 6-14
| isbn =9781770488229
}}</ref>

==Search Engine Optimization (SEO) and Technical Writing in the Digital Age==
SEO refers to the practice of optimizing online content to enhance its visibility and ranking on search engine results pages (SERPs), making it a crucial skill for digital writers.<ref>https://grlucas.net/grl/CompFAQ/Digital_Writing/SEO</ref>

==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| }}

===Characteristics of Digital Documents===

====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| }} It is a legal requirement to include accessibility features in website design.{{sfn|WAI || }} 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|p=103-104}}

====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.<ref>Zeleznik, J. M., Burnett, R. E., & Benson, P. J. (1999). ''Technical Writing : What It Is and How to Do It''. National Book Network. p. 207.</ref> The other four Cs are coherent, concrete, correct and complete.<ref>Last, Suzan (2019). ''Technical Writing Essentials.'' Victoria, B.C. University of Victoria. ISBN: 9781550586657 https://pressbooks.bccampus.ca/technicalwriting/chapter/communicatingprecision/</ref>

====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}}

====Hyperlinking====
Hyperlinking is a quick and efficient method for directing readers to relevant information in digital documents, facilitating seamless navigation between sections, references, and external resources.{{sfn|Carroll|2010|p=79}}

====Multimedia====
Digital documents can incorporate multimedia elements like images, audio, video, and interactive content, enhancing engagement through visual and auditory elements. Multiple media formats work best when sharing new, complicated ideas.{{sfn|Carroll|2010|p=36}}

==Examples of Digital Documents==
In technical and professional writing, digital documentation takes various forms. These methods streamline the sharing of technical information, enhance collaboration, and ensure easy accessibility within professional settings, contributing to efficient communication and knowledge dissemination.

====Infographics====
Infographics, shared as digital documents, typically combine text, graphics, and illustrations to convey complex concepts or data in a concise and visually appealing format. Infographics are often used to simplify information, making it more accessible to a broader audience, and are found in presentations, reports, websites, and educational materials. <ref>{{cite book
| last1 = Lannon | first1 = John M.
| first2 = Laura J. | last2 = Gurak
| title = ''Technical Communication Fifteenth Edition''
| location = United States
| publisher = Pearson
| pages = 292–293
| date = 2020
| isbn = 978-0-13-520322-4}}</ref>

====Presentations====
Presentations created with [https://en.wikipedia.org/wiki/Microsoft_PowerPoint PowerPoint] or [https://en.wikipedia.org/wiki/Google_Slides Google Slides] are vital for professional communication and knowledge sharing. They condense complex information into visually appealing slides for effective presentations by using photos, videos, graphics, charts, and graphs.
<ref>{{cite book
| last1 = Parkinson | first1 = Mike
| title = A Trainer’s Guide to PowerPoint: Best Practices for Master Presenters
| location = United States
| publisher = Association for Talent Development
| pages = Chapter 4. PowerPoint Tips, Tricks, and Secrets
| date = 2018}}</ref>

==User Experience==
User experience is how a product works from the perspective of the user. Digital documents can be created with efficient user experiences by focusing on user-centered design and designing the document with the user in mind. <ref> {{cite book | last = Garrett | first = Jesse James | title = The Elements of User Experience: User-Centered Design for the Web and Beyond | publisher = New Riders | edition = 2nd | date = 2011 | location = Berkeley, CA | page = 17}} </ref>

==Collaboration and Version Control==

===Collaboration===
One form of collaborative technical writing is a wiki, which is a "Web site developed collaboratively by a community of users, allowing any user to add and edit content."<ref>{{cite web
| url = https://grlucas.net/grl/Writing_on_a_Wiki
| title = writing on a wiki
| last = Lucas
| first= Gerald
| date= May 18, 2021
| website = Gerald-R-Lucas
| publisher = MediaWiki
| access-date =October 31, 2023
| quote = Web site developed collaboratively by a community of users, allowing any user to add and edit content.
| ref = harv
}}</ref>

One of the predominant elements of a wiki is that it is defined as being open source. As a result, anyone can modify it.

===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.<ref name=":2" />

==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<ref>Johnson-Sheehan, Richard. “Managing Ethical Challenges.” ''Technical Communication Today'', 6th ed., Pearson, Boston, MA, 2018, pp. 71–84.</ref>.

The Society for Technical Communication (STC) is the world's oldest professional association dedicated to advancing the field of technical communication.<ref>“About STC.” ''Society for Technical Communication'', 19 May 2021, [https://www.stc.org/about-stc/ www.stc.org/about-stc/] Retrieved October 27, 2023.</ref> The STC promotes adherence to a list of ethical principles. They are legality, honesty, confidentiality, quality, fairness, and professionalism.<ref>“Ethical Principles.” ''Society for Technical Communication'', 20 May 2021, [https://www.stc.org/about-stc/ethical-principles/ www.stc.org/about-stc/ethical-principles/] Retrieved October 27, 2023.</ref>

Technical communicators also have to be careful to avoid plagiarism, or taking ideas, thoughts, or words from someone else and passing them off as ones own.<ref name=":5" />

Technical communicators have ethical standards to which they must abide. The standards are divided into three primary categories. They are the employer, the public, and the environment.<ref name=":0">Markel, Mike. ''Technical Communication''. 9th ed., Bedford/St. Martin’s, Boston, 2009. p.22-25.</ref>

=== The Employer ===
Obligations to one's employer include competence and diligence, honesty and candor, confidentiality, and loyalty.<ref name=":0" /> The technical communicator must adhere to these obligations so that he/she does not harm the reputation or operation of the employer.

Technical communicators may occasionally work for an organization with strict privacy policies that prohibit they from using the documents they create outside of the organization. It is important for ethical communicators to follow the privacy policy for their organization because unauthorized release of information could lead to consequences up to an including termination.<ref name=":4" />

=== The Public ===
Organizations are obligated to treat customers fairly. Technical communicators must convey that the products or services an organization sells are safe and effective.<ref name=":0" />

=== The Environment ===
Technical communicators have an obligation to the environment. This obligation includes alerting their supervisors, managers, and executive leadership to products or processes that are detrimental to the environment. Disposal of hazardous waste is far more costly than dumping it. Organizations could be tempted to skirt the legal procedures.<ref name=":0" /> One would hope that the penalty of 5 years and/or up to $50,000 per day for knowingly disposing of hazardous waste in a way contrary to U.S. Environmental Protection Agency's regulations would be a sufficient deterrent.<ref>{{Citation |url=https://www.epa.gov/enforcement/criminal-provisions-resource-conservation-and-recovery-act-rcra
|title=Criminal Provisions of the Resource Conservation and Recovery Act
|website=United States Environmental Protection Agency
|access-date=November 6, 2023}}</ref>
===Disinformation===
One major ethical concern in all forms of writing, but especially in digital writing, is the creation and spread of disinformation. Disinformation, often referred to as "[[w:Fake news|fake news]]," is information that is purposefully spread as false or misleading and is a sub-type of misinformation.<ref>Lawrence, Dan. (2022). ''Digital Writing: A Guide to Writing for Social Media and the Web.'' Broadview Press. </ref> Modern communication technologies allow for the spread of information to occur at a fast pace. Social media is one area where the spread of disinformation occurs regularly. Some social media sites, such as Facebook, have begun to flag certain articles posted on the site as being questionable in their representation of facts or occurrences. Despite the widespread understanding and use of disinformation available today, digital writers need to be aware of their intent and the audience's needs and wants from their digital communication.<ref>Lucas, Gerald. (September 13, 2023). "Audience-Centric Style in Digital Writing" in ''From Reading to Writing: A Composition FAQ Textbook.'' Retrieved October 22, 2023. https://grlucas.net/grl/CompFAQ/Digital_Writing/Style</ref> Ethical considerations regarding citing sources, cross-referencing information, and using primary sources are good practices for maintaining ethical standing and credibility as a digital writer.

To help mitigate the problem of disinformation, technical writers should utilize gatekeepers. These individuals verify the accuracy of the information before it is distributed to primary readers. This helps protect the author from any ethical and/or legal issues.<ref name=":4">"Ethics" Balzotti, Jon (2022). ''Technical Communication: A Design-Centric Approach''. New York. Routledge. p. 83. ISBN 978-1-003-00606-0</ref>

==Pedagogical Approaches==
Barriers to teaching technical communications include the speed at which digital tools evolve and the complexity of software. <ref>{{cite journal |last1=Hovde |first1=Marjorie |last2=Renguette |first2=Corinne |date=2017 |title=Technological Literacy: A Framework for Teaching Technical Communication Software Tools |journal=Technical Communication Quarterly |volume=26 |pages=395-411 |doi=10.1080/10572252.2017.1385998}}</ref>

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. Others even used emoticons. Colleges and universities now must focus on educating students on the different forms of written communication and when best to employ them.<ref name=":5">Carroll, Brian. ''Writing for Digital Media''. Routledge, New York, 2010. p. 280.</ref>

==Future Trends and Challenges==
===Future Trends===
Between 2022 and 2032, the [https://en.wikipedia.org/wiki/Bureau_of_Labor_Statistics, United States Bureau of Labor Statistics] is projecting a 7% job growth for technical writers. <ref>{{cite web
| url = https://www.bls.gov/ooh/media-and-communication/technical-writers.htm#tab-6
| title = Occupational Outlook Handbook
| last =
| first=
| date= September 6, 2023
| website = Bureau of Labor Statistics
| publisher =
| access-date = November 7, 2023
|ref=harv
}}</ref>

===Challenges===
Among others, a prominent barrier to technical writers is the dependency on input information accuracy. Outdated, incorrect, or inconsistent data delays the publication, requires more reparative efforts, and decreases productivity. <ref>Common problems in technical writing and how to resolve them (componize.com)</ref> Also, Technical writers often have to contend with complex, outdated or unsuitable tools. This can make their job more difficult and time-consuming, and can lead to frustration and errors.<ref>[https://componize.com/common-problems-in-technical-writing-and-how-to-resolve-them/#:~:text=Technical%20writers%20often%20have%20to,longer%20supported%20by%20the%20vendor]</ref>

===Artificial Intelligence===
Artificial intelligence programs, utilizing natural language processing, are capable of producing technical writing and have advanced in recent years becoming more adept.<ref>{{cite web
| url = https://www.forbes.com/sites/bernardmarr/2023/01/23/how-chatgpt-and-natural-language-technology-might-affect-your-job-if-you-are-a-computer-programmer/?sh=6d9acf79174b
| title = How ChatGPT And Natural Language Technology Might Affect Your Job If You Are A Computer Programmer
| last = Marr
| first= Bernard
| date= January 23, 2023
| website = Forbes
| publisher =
| access-date =October 31, 2023
|quote=
|ref=harv
}}</ref>
One such program is [https://en.wikipedia.org/wiki/ChatGPT ChatGPT], which uses machine learning to produce texts with human-like style and tone. <ref>{{cite web | url =https://uca.edu/cetal/chat-gpt/ | title =Chat GPT: What is it? | last = | first = | date = | website =University of Central Arkansas | publisher = | access-date =October 9, 2023 }}</ref> Another leader in this area, Contentbot, uses a WordPress plugin which gives blog writers ideas to enhance their posts which are shared via email. <ref>Siddiqui, Zafar (January 2022). "Will Best Artificial Intelligence Take Over any Technical Content Writer?" The Writing Cooperative. https://writingcooperative.com/intricacies-of-ai-tools-can-ai-tools-take-over-the-jobs-of-technical-writers-af36836f625c</ref>

===Plagiarism===
Because of the ability of chatbots to imitate human-like language, some education administrators have taken precautions to minimize the occurrence of students passing off artificially generated texts as their own. In some instances, educators have taken the view that material drawn from artificial intelligence software must be handled in the same way as sources from human authors. <ref>Klein, Alyson. “ChatGPT Cheating: What to Do When It Happens.” Education Week (Bethesda, MD), 21 Feb. 2023. EBSCOhost, search.ebscohost.com/login.aspx?direct=true&AuthType=ip,shib&db=pwh&AN=2W64116997758&site=eds-live&scope=site.</ref> In such cases, students who incorporate artificially generated text into their work have been made to denote credit for the artificial intelligence program utilized.

===Credit===
The advent of chatbots has complicated the issue of credit where creative work is concerned. Because chatbots can simulate human speech, their ability to create cinematic dialogues and other types of creative writing have threatened the credits and financial condition of professional writers. According to an article by Aaron Mok and Jacob Zinkula on ''[https://www.businessinsider.com/ Business Insider]'', writing jobs are among the top 10 roles that AI is most likely to replace. <ref>Mok, Aaron, and Jacob Zinkula. “ChatGPT May Be Coming for Our Jobs. Here Are the 10 Roles That AI Is Most Likely to Replace.” Business Insider, 4 Sept. 2023, www.businessinsider.com/chatgpt-jobs-at-risk-replacement-artificial-intelligence-ai-labor-trends-2023-02.</ref>

==References==
===Citations===
{{Reflist}}

===Bibliography ===
{{Refbegin|30em}} 
*{{cite book |last=Carroll |first=Brian |date=2010 |title=Writing for Digital Media |url= |location=New York |publisher=Routledge }}
*{{cite book |last=Barr |first=Chris |date=2010 |title=Yahoo! Style Guide |url= |location=New York |publisher=St. Martin's }}
* {{cite book |last=Krug |first=Steve |date=2014 |title=Don’t Make Me Think, Revisited|url= |location=Berkeley, CA |publisher=New Riders |pages= |isbn= |author-link= |ref=harv }}
* {{cite web|url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Documents|title=Exploring the Dichotomy: A Comparative Analysis of Digital and Paper Documents |last=Lucas |first=Gerald |date=2023 |website=grlucas.net |publisher= |access-date=2023-10-29 |quote= |ref=harv }}
*{{cite book |last=Robbins |first=Jennifer Niederst |date=2018 |title=Learning Web Design: A Beginner’s Guide to HTML, CSS, JavaScript, and Web Graphics (5th ed.) |url= |location=Sebastopol, CA |publisher= O’Reilly Media, Inc. }}
* {{cite web|url=https://www.w3.org/WAI/fundamentals/accessibility-intro/|title=Introduction to Web Accessibility|last=WAI |first=|date=2022 |website=W3.org|publisher= |access-date= 2023-10-26 |quote= |ref=harv }}
* {{cite web|url=https://wcag.com/legal/|title=Accessibility and the Law|last=WAI |first=|date= |website=W3.org|publisher= |access-date= 2023-10-26 |quote= |ref=harv }}
{{Refend}}

[[Category:Fall 2023]]
[[Category:ENGL 5106]]

Technical Writing in the Digital Age

2023-11-13T16:42:51Z

APitts: /* Ethical Considerations */ Added Subheadings

'''Technical Writing in the Digital Age''' represents the dynamic and evolving discipline of creating written materials that convey complex information, instructions, and technical concepts in the context of contemporary digital technologies.<ref name=":3">Markel, Mike, and Selber, Stuart. (2021). ''Technical Communication'' (13th ed). Boston/New York. Bedford/St. Martin's: 182-186. [https://openlibrary.org/books/OL36001026M/Technical_Communication ISBN: 978-1-319-30769-1]</ref> Its purview encompasses the creation, dissemination, and management of technical documents and content within an expansive digital landscape.

Major considerations within this domain revolve around adapting traditional principles of rhetoric to digital platforms, ensuring effective communication in an era defined by rapid technological advancements. Key factors include integrating multimedia elements, user-centered design principles, and ethical considerations like accessibility and inclusivity.<ref name=":1">Carroll, Brian, (2010). ''Writing for Digital Media.'' New York: Routledge. </ref> 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. The use of multi-modality and the interfacing of multiple media platforms and sources also plays a role in digital technical writing.<ref>{{cite web
| url = https://grlucas.net/grl/CompFAQ/Digital_Writing/Multimodal_Approach
| title = multimodal-approaches-in-technical-writing
| last = Lucas
| first= Gerald-R
| date= September 19, 2023
| website = Gerald-R-Lucas
| publisher = ghost
| access-date =October 30, 2023
| ref = harv
}}</ref> In essence, technical writing in the digital age encapsulates the art and science of conveying technical information in a manner that is comprehensible and accessible to diverse audiences in our digitally driven society. <ref>{{cite web
| url = https://grlucas.net/grl/CompFAQ/Technical_Writing
| title = Defining Technical Writing
| last = Lucas
| first= Gerald-R
| date= September 14, 2023
| website = Gerald-R-Lucas
| publisher = ghost
| access-date =November 7, 2023
| ref = harv
}}</ref>

==Overview==

===Types of Technical Communication===
Common types of technical communication include instructions, user guides, reports, proposals, memos, and procedures. <ref>{{cite book
| last1 = Lannon
| first1 = John
| last2 = Gurak
| first2 = Laura
| date = 2022
| title = Technical Communication
| edition = 15th
| publisher = Pearson Education Limited
| location = Essex, United Kingdom
| page = 30
| isbn = 1-292-36359-2
}}</ref>
<ref>Mussack, Brigitte. (2021). Introduction to Technical and Professional Communication: Technical Communication through a Social Justice Lens. Creative Commons Attribution NonCommercial, 2021. n.p.</ref>

=== Aims of Technical Communication ===
As much as technical communication is a discipline in and of itself, it also exists within many other disciplines. Examples of technical communication communities can be found among such fields as varied as education, business, and science. Technical documentation within any domain typically embodies a similar aim: to help its audience act toward some sort of task or goal. <ref>Markel, M (2007). Technical communication, 8th ed. Boston: Beford/St. Martin’s, p. 5.</ref>

=== Characteristics of Technical Communication ===
Because technical communication is intended to guide an audience, it must be assembled in such a way that it is very easily understood. Successful technical documentation is accurate, logically sound, and appropriate. <ref>Perelman, Leslie, et al. The Mayfield Handbook of Technical and Scientific Writing. 1998, ci.nii.ac.jp/ncid/BA73264379?l=en.</ref> 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.

== Features of Technical Communication ==
There are many features of technical communication which lead to it being accurate, sound, and appropriate. <ref>smirti. “Features of Technical Communication.” Management Note, 27 Feb. 2022, www.managementnote.com/features-of-technical-communication. Accessed 3 Nov. 2023.</ref>

=== '''Accuracy''' ===

==== Standards Compliant ====
Many technical fields have industry specific regulations and guidelines which are determined by governing bodies and that also have an impact on their technical communication.

==== Detailed ====
Accurate information that is delivered with precision and specificity is essential to providing communication that is unambiguous and free of inconsistencies.

==== Objective ====
Objective communication is presented in an unbiased and impartial manner and is free of personal opinions. It relies upon facts and evidence and avoids an overly emotional tone.

===== Concise =====
Good technical communication expresses meaning in a way that is straightforward and that avoids redundant words or excessive explanations. It is easy to both absorb and process.

==== Clear ====
Clear language is organized logically, is not unnecessarily involved, and is easily understood by the target audience. It will avoid needless jargon and complexity.

=== '''Soundness''' ===

==== Format ====
Technical documents should be formatted in a way that is consistent with the norms and standards of applicable professional fields. Additionally, formatting should adhere to guidelines which enhance usability.

==== Visuals ====
Technical communication utilizes visuals strategically to facilitate understanding of textual content. When presented properly, they can elucidate difficult concepts and make material accessible to a more diverse audience.

=== '''Appropriateness''' ===

==== Audience-specific ====
Where possible, technical communication should be customized to align with the knowledge and needs of its 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.<ref>{{cite magazine |last=Malone |first=Ed |date=2008 |title=Joseph D. Chapline: Technical Communication's Mozart |url=https://web.mst.edu/~malonee/chapline.pdf |magazine=IEEE Professional Communication Society Newsletter |access-date=October 31, 2023 }}.</ref> 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.<ref>{{cite journal |last1=Edward |first1=Malone |date=November 2011 |title=The First Wave (1953–1961) of the Professionalization Movement in Technical Communication |url=https://www.stc.org/techcomm/wp-content/uploads/sites/3/2016/08/november-2011-58-4.pdf |journal=Technical Communication |volume=58 |issue=4 |pages=285 - 306 |doi= |access-date=October 11, 2023}}</ref>

== Digital Technologies and Technical Writing==
With the rise of digital technology, technical writing has had to adapt to the needs of a digital era. The predominant impact of this revolution was that it made technical communication more accessible by increasing the breadth of its viewers. The world-wide web is public, and thus, it can be accessed by anyone with access to the internet.

Online word processors such as [https://www.google.com/docs/about/ Google Docs] and [https://www.microsoft.com/en-us/microsoft-365/sharepoint/collaboration SharePoint] allow documents to be easily disseminated. Comment capability allows audience members to interact with one another as well as with the document author. Hypertext permits online authors to link the works of various others to their personal websites and vice versa. In all, technical documentation posted online can grow a considerable audience over time. However, many aspects of effective technical writing, such as clarity, conciseness, completeness, and correctness, still need to be applied to technical writing created for digital interfaces. {{sfn|Carroll|2010|p=24}}
==Personas in Digital Writing==
Personas in the context of digital writing refer to semi-fictional characters that encapsulate the characteristics, behaviors, and needs of target audience segments.<ref>https://grlucas.net/grl/CompFAQ/Digital_Writing/Personas</ref>

==Rhetorical Strategies in the Digital Age==
Rhetoric is a communication strategy whose primary goal is to persuade an audience. It is grounded in three foundational concepts first defined by the Greek philosopher Aristotle. These concepts are ''logos'', which engages with the reader’s sense of logic or reason; ''pathos'', which appeals to the reader’s emotions; and ''ethos'', which addresses the audience’s values and the writer’s credibility. Within this framework, writers utilize specific techniques or devices to influence and engage readers. Examples include appealing to an audience’s sense of logic by using factual examples to support a point or evoking emotion through descriptive visual language. <ref>{{cite book |last=Gagich |first=Melanie |title=Writing Arguments in Stem |publisher=Digital Commons |date=n.d. |chapter=Rhetorical Appeals: Logos, Pathos, and Ethos Defined |url=https://digitalcommons.calpoly.edu/cgi/viewcontent.cgi?article=1000&context=oercoursematerials#page=44 |pages=34-37 }}</ref>

In today’s digital age, writers can use digital technologies as rhetorical devices to influence the reader. Electronic images and informational graphics can be incorporated into digital and online documents to illustrate or reinforce points made in the text.<ref name=":3" /> Hyperlinks can be used to provide additional information that supports the author's ideas. Nevertheless, the writer's basic task of informing and persuading an audience is the same in digital communication as in other forms of writing.<ref>{{cite book |last=Devos |first=Danielle |date=2010 |title=Because Digital Writing Matters: Improving Student Writing in Online and Multimedia Environments |location=San Francisco |publisher=Jossey-Bass |pages=105 |isbn=9780470892237 |url=https://openlibrary.org/books/OL34593323M/Because_Digital_Writing_Matters }}</ref>

Rhetorical analysis involves analyzing the demographics and habits of an intended audience. The information gathered allows writers to craft messages that appeal to the target audience. In the digital age, websites and social media platforms convey rhetorical messages. <ref>{{cite book
| last =Lawrence
| first =Dan
| date =2022
| title =Digital Writing
| location =Peterborough, Ontario, Canada
| publisher =Broadview Press
| page = 6-14
| isbn =9781770488229
}}</ref>

==Search Engine Optimization (SEO) and Technical Writing in the Digital Age==
SEO refers to the practice of optimizing online content to enhance its visibility and ranking on search engine results pages (SERPs), making it a crucial skill for digital writers.<ref>https://grlucas.net/grl/CompFAQ/Digital_Writing/SEO</ref>

==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| }}

===Characteristics of Digital Documents===

====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| }} It is a legal requirement to include accessibility features in website design.{{sfn|WAI || }} 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|p=103-104}}

====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.<ref>Zeleznik, J. M., Burnett, R. E., & Benson, P. J. (1999). ''Technical Writing : What It Is and How to Do It''. National Book Network. p. 207.</ref> The other four Cs are coherent, concrete, correct and complete.<ref>Last, Suzan (2019). ''Technical Writing Essentials.'' Victoria, B.C. University of Victoria. ISBN: 9781550586657 https://pressbooks.bccampus.ca/technicalwriting/chapter/communicatingprecision/</ref>

====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}}

====Hyperlinking====
Hyperlinking is a quick and efficient method for directing readers to relevant information in digital documents, facilitating seamless navigation between sections, references, and external resources.{{sfn|Carroll|2010|p=79}}

====Multimedia====
Digital documents can incorporate multimedia elements like images, audio, video, and interactive content, enhancing engagement through visual and auditory elements. Multiple media formats work best when sharing new, complicated ideas.{{sfn|Carroll|2010|p=36}}

==Examples of Digital Documents==
In technical and professional writing, digital documentation takes various forms. These methods streamline the sharing of technical information, enhance collaboration, and ensure easy accessibility within professional settings, contributing to efficient communication and knowledge dissemination.

====Infographics====
Infographics, shared as digital documents, typically combine text, graphics, and illustrations to convey complex concepts or data in a concise and visually appealing format. Infographics are often used to simplify information, making it more accessible to a broader audience, and are found in presentations, reports, websites, and educational materials. <ref>{{cite book
| last1 = Lannon | first1 = John M.
| first2 = Laura J. | last2 = Gurak
| title = ''Technical Communication Fifteenth Edition''
| location = United States
| publisher = Pearson
| pages = 292–293
| date = 2020
| isbn = 978-0-13-520322-4}}</ref>

====Presentations====
Presentations created with [https://en.wikipedia.org/wiki/Microsoft_PowerPoint PowerPoint] or [https://en.wikipedia.org/wiki/Google_Slides Google Slides] are vital for professional communication and knowledge sharing. They condense complex information into visually appealing slides for effective presentations by using photos, videos, graphics, charts, and graphs.
<ref>{{cite book
| last1 = Parkinson | first1 = Mike
| title = A Trainer’s Guide to PowerPoint: Best Practices for Master Presenters
| location = United States
| publisher = Association for Talent Development
| pages = Chapter 4. PowerPoint Tips, Tricks, and Secrets
| date = 2018}}</ref>

==User Experience==
User experience is how a product works from the perspective of the user. Digital documents can be created with efficient user experiences by focusing on user-centered design and designing the document with the user in mind. <ref> {{cite book | last = Garrett | first = Jesse James | title = The Elements of User Experience: User-Centered Design for the Web and Beyond | publisher = New Riders | edition = 2nd | date = 2011 | location = Berkeley, CA | page = 17}} </ref>

==Collaboration and Version Control==

===Collaboration===
One form of collaborative technical writing is a wiki, which is a "Web site developed collaboratively by a community of users, allowing any user to add and edit content."<ref>{{cite web
| url = https://grlucas.net/grl/Writing_on_a_Wiki
| title = writing on a wiki
| last = Lucas
| first= Gerald
| date= May 18, 2021
| website = Gerald-R-Lucas
| publisher = MediaWiki
| access-date =October 31, 2023
| quote = Web site developed collaboratively by a community of users, allowing any user to add and edit content.
| ref = harv
}}</ref>

One of the predominant elements of a wiki is that it is defined as being open source. As a result, anyone can modify it.

===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.<ref name=":2" />

==Ethical Considerations==
Technical communicators have ethical standards to which they must abide. The standards are divided into three primary categories. They are the employer, the public, and the environment.<ref name=":0">Markel, Mike. ''Technical Communication''. 9th ed., Bedford/St. Martin’s, Boston, 2009. p.22-25.</ref>

=== The Employer ===
Obligations to one's employer include competence and diligence, honesty and candor, confidentiality, and loyalty.<ref name=":0" /> The technical communicator must adhere to these obligations so that he/she does not harm the reputation or operation of the employer.

Technical communicators may occasionally work for an organization with strict privacy policies that prohibit they from using the documents they create outside of the organization. It is important for ethical communicators to follow the privacy policy for their organization because unauthorized release of information could lead to consequences up to an including termination.<ref name=":4" />

=== The Public ===
Organizations are obligated to treat customers fairly. Technical communicators must convey that the products or services an organization sells are safe and effective.<ref name=":0" />

=== The Environment ===
Technical communicators have an obligation to the environment. This obligation includes alerting their supervisors, managers, and executive leadership to products or processes that are detrimental to the environment. Disposal of hazardous waste is far more costly than dumping it. Organizations could be tempted to skirt the legal procedures.<ref name=":0" /> One would hope that the penalty of 5 years and/or up to $50,000 per day for knowingly disposing of hazardous waste in a way contrary to U.S. Environmental Protection Agency's regulations would be a sufficient deterrent.<ref>{{Citation |url=https://www.epa.gov/enforcement/criminal-provisions-resource-conservation-and-recovery-act-rcra
|title=Criminal Provisions of the Resource Conservation and Recovery Act
|website=United States Environmental Protection Agency
|access-date=November 6, 2023}}</ref>

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<ref>Johnson-Sheehan, Richard. “Managing Ethical Challenges.” ''Technical Communication Today'', 6th ed., Pearson, Boston, MA, 2018, pp. 71–84.</ref>.

The Society for Technical Communication (STC) is the world's oldest professional association dedicated to advancing the field of technical communication.<ref>“About STC.” ''Society for Technical Communication'', 19 May 2021, [https://www.stc.org/about-stc/ www.stc.org/about-stc/] Retrieved October 27, 2023.</ref> The STC promotes adherence to a list of ethical principles. They are legality, honesty, confidentiality, quality, fairness, and professionalism.<ref>“Ethical Principles.” ''Society for Technical Communication'', 20 May 2021, [https://www.stc.org/about-stc/ethical-principles/ www.stc.org/about-stc/ethical-principles/] Retrieved October 27, 2023.</ref>

Technical communicators also have to be careful to avoid plagiarism, or taking ideas, thoughts, or words from someone else and passing them off as ones own.<ref name=":5" />

===Disinformation===
One major ethical concern in all forms of writing, but especially in digital writing, is the creation and spread of disinformation. Disinformation, often referred to as "[[w:Fake news|fake news]]," is information that is purposefully spread as false or misleading and is a sub-type of misinformation.<ref>Lawrence, Dan. (2022). ''Digital Writing: A Guide to Writing for Social Media and the Web.'' Broadview Press. </ref> Modern communication technologies allow for the spread of information to occur at a fast pace. Social media is one area where the spread of disinformation occurs regularly. Some social media sites, such as Facebook, have begun to flag certain articles posted on the site as being questionable in their representation of facts or occurrences. Despite the widespread understanding and use of disinformation available today, digital writers need to be aware of their intent and the audience's needs and wants from their digital communication.<ref>Lucas, Gerald. (September 13, 2023). "Audience-Centric Style in Digital Writing" in ''From Reading to Writing: A Composition FAQ Textbook.'' Retrieved October 22, 2023. https://grlucas.net/grl/CompFAQ/Digital_Writing/Style</ref> Ethical considerations regarding citing sources, cross-referencing information, and using primary sources are good practices for maintaining ethical standing and credibility as a digital writer.

To help mitigate the problem of disinformation, technical writers should utilize gatekeepers. These individuals verify the accuracy of the information before it is distributed to primary readers. This helps protect the author from any ethical and/or legal issues.<ref name=":4">"Ethics" Balzotti, Jon (2022). ''Technical Communication: A Design-Centric Approach''. New York. Routledge. p. 83. ISBN 978-1-003-00606-0</ref>

==Pedagogical Approaches==
Barriers to teaching technical communications include the speed at which digital tools evolve and the complexity of software. <ref>{{cite journal |last1=Hovde |first1=Marjorie |last2=Renguette |first2=Corinne |date=2017 |title=Technological Literacy: A Framework for Teaching Technical Communication Software Tools |journal=Technical Communication Quarterly |volume=26 |pages=395-411 |doi=10.1080/10572252.2017.1385998}}</ref>

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. Others even used emoticons. Colleges and universities now must focus on educating students on the different forms of written communication and when best to employ them.<ref name=":5">Carroll, Brian. ''Writing for Digital Media''. Routledge, New York, 2010. p. 280.</ref>

==Future Trends and Challenges==
===Future Trends===
Between 2022 and 2032, the [https://en.wikipedia.org/wiki/Bureau_of_Labor_Statistics, United States Bureau of Labor Statistics] is projecting a 7% job growth for technical writers. <ref>{{cite web
| url = https://www.bls.gov/ooh/media-and-communication/technical-writers.htm#tab-6
| title = Occupational Outlook Handbook
| last =
| first=
| date= September 6, 2023
| website = Bureau of Labor Statistics
| publisher =
| access-date = November 7, 2023
|ref=harv
}}</ref>

===Challenges===
Among others, a prominent barrier to technical writers is the dependency on input information accuracy. Outdated, incorrect, or inconsistent data delays the publication, requires more reparative efforts, and decreases productivity. <ref>Common problems in technical writing and how to resolve them (componize.com)</ref> Also, Technical writers often have to contend with complex, outdated or unsuitable tools. This can make their job more difficult and time-consuming, and can lead to frustration and errors.<ref>[https://componize.com/common-problems-in-technical-writing-and-how-to-resolve-them/#:~:text=Technical%20writers%20often%20have%20to,longer%20supported%20by%20the%20vendor]</ref>

===Artificial Intelligence===
Artificial intelligence programs, utilizing natural language processing, are capable of producing technical writing and have advanced in recent years becoming more adept.<ref>{{cite web
| url = https://www.forbes.com/sites/bernardmarr/2023/01/23/how-chatgpt-and-natural-language-technology-might-affect-your-job-if-you-are-a-computer-programmer/?sh=6d9acf79174b
| title = How ChatGPT And Natural Language Technology Might Affect Your Job If You Are A Computer Programmer
| last = Marr
| first= Bernard
| date= January 23, 2023
| website = Forbes
| publisher =
| access-date =October 31, 2023
|quote=
|ref=harv
}}</ref>
One such program is [https://en.wikipedia.org/wiki/ChatGPT ChatGPT], which uses machine learning to produce texts with human-like style and tone. <ref>{{cite web | url =https://uca.edu/cetal/chat-gpt/ | title =Chat GPT: What is it? | last = | first = | date = | website =University of Central Arkansas | publisher = | access-date =October 9, 2023 }}</ref> Another leader in this area, Contentbot, uses a WordPress plugin which gives blog writers ideas to enhance their posts which are shared via email. <ref>Siddiqui, Zafar (January 2022). "Will Best Artificial Intelligence Take Over any Technical Content Writer?" The Writing Cooperative. https://writingcooperative.com/intricacies-of-ai-tools-can-ai-tools-take-over-the-jobs-of-technical-writers-af36836f625c</ref>

===Plagiarism===
Because of the ability of chatbots to imitate human-like language, some education administrators have taken precautions to minimize the occurrence of students passing off artificially generated texts as their own. In some instances, educators have taken the view that material drawn from artificial intelligence software must be handled in the same way as sources from human authors. <ref>Klein, Alyson. “ChatGPT Cheating: What to Do When It Happens.” Education Week (Bethesda, MD), 21 Feb. 2023. EBSCOhost, search.ebscohost.com/login.aspx?direct=true&AuthType=ip,shib&db=pwh&AN=2W64116997758&site=eds-live&scope=site.</ref> In such cases, students who incorporate artificially generated text into their work have been made to denote credit for the artificial intelligence program utilized.

===Credit===
The advent of chatbots has complicated the issue of credit where creative work is concerned. Because chatbots can simulate human speech, their ability to create cinematic dialogues and other types of creative writing have threatened the credits and financial condition of professional writers. According to an article by Aaron Mok and Jacob Zinkula on ''[https://www.businessinsider.com/ Business Insider]'', writing jobs are among the top 10 roles that AI is most likely to replace. <ref>Mok, Aaron, and Jacob Zinkula. “ChatGPT May Be Coming for Our Jobs. Here Are the 10 Roles That AI Is Most Likely to Replace.” Business Insider, 4 Sept. 2023, www.businessinsider.com/chatgpt-jobs-at-risk-replacement-artificial-intelligence-ai-labor-trends-2023-02.</ref>

==References==
===Citations===
{{Reflist}}

===Bibliography ===
{{Refbegin|30em}} 
*{{cite book |last=Carroll |first=Brian |date=2010 |title=Writing for Digital Media |url= |location=New York |publisher=Routledge }}
*{{cite book |last=Barr |first=Chris |date=2010 |title=Yahoo! Style Guide |url= |location=New York |publisher=St. Martin's }}
* {{cite book |last=Krug |first=Steve |date=2014 |title=Don’t Make Me Think, Revisited|url= |location=Berkeley, CA |publisher=New Riders |pages= |isbn= |author-link= |ref=harv }}
* {{cite web|url=https://grlucas.net/grl/CompFAQ/Digital_Writing/Documents|title=Exploring the Dichotomy: A Comparative Analysis of Digital and Paper Documents |last=Lucas |first=Gerald |date=2023 |website=grlucas.net |publisher= |access-date=2023-10-29 |quote= |ref=harv }}
*{{cite book |last=Robbins |first=Jennifer Niederst |date=2018 |title=Learning Web Design: A Beginner’s Guide to HTML, CSS, JavaScript, and Web Graphics (5th ed.) |url= |location=Sebastopol, CA |publisher= O’Reilly Media, Inc. }}
* {{cite web|url=https://www.w3.org/WAI/fundamentals/accessibility-intro/|title=Introduction to Web Accessibility|last=WAI |first=|date=2022 |website=W3.org|publisher= |access-date= 2023-10-26 |quote= |ref=harv }}
* {{cite web|url=https://wcag.com/legal/|title=Accessibility and the Law|last=WAI |first=|date= |website=W3.org|publisher= |access-date= 2023-10-26 |quote= |ref=harv }}
{{Refend}}

[[Category:Fall 2023]]
[[Category:ENGL 5106]]

Talk:Technical Writing in the Digital Age

2023-11-12T02:49:12Z

APitts: /* Paragraph Blocks */

2023-10-07T19:00:17Z

APitts: Created page with "Azizza is a licensed mental health counselor who is pursuing a Master of Arts in Technical and Professional Writing."

Azizza is a licensed mental health counselor who is pursuing a Master of Arts in Technical and Professional Writing.