Technical Writing in the Digital Age: Difference between revisions

m (→‎Digital Technologies Tools: Fixed citation error)
Line 55: Line 55:
Informal or brief reports provide an objective overview of an organization's current state, past events, and future plans, ensuring that readers are well-informed about the organization's operations. Some examples include{{sfn|Johnson-Sheehan|2018|pp=285-288}}:
Informal or brief reports provide an objective overview of an organization's current state, past events, and future plans, ensuring that readers are well-informed about the organization's operations. Some examples include{{sfn|Johnson-Sheehan|2018|pp=285-288}}:


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


===== Formal Reports =====
===== Formal Reports =====
Line 67: Line 67:


==== Resumes ====
==== 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}}
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 ====
==== User guides ====
Line 106: Line 110:


==Digital Technologies Tools==
==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, thus, can be accessed by anyone with access to the Internet. Such a phenomenon can be exploited to increase the audience of a virtual document.  
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.
Technical writers can use various tools to author and present their documents.


====Content Management Systems (CMS)====
====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 SEO optimization to enhance the overall website management experience. {{sfn|Carroll|2006|p=129}}
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].
Some popular examples of CMS include [https://wordpress.com/ WordPress], [https://www.wix.com/ Wix], and [https://www.blogger.com/about/?bpli=1 Blogger].