90
edits
Technical Writing in the Digital Age: Difference between revisions
Technical Writing in the Digital Age (view source)
Revision as of 15:12, 30 October 2023
, 1 year agoI reformatted the Online Documentation and UX section to accommodate a list format for the characteristics of digital documents. Added "scannable" with citation.
Apjones428 (talk | contribs) m (→References) |
Debbiebwolfe (talk | contribs) (I reformatted the Online Documentation and UX section to accommodate a list format for the characteristics of digital documents. Added "scannable" with citation.) |
||
| Line 44: | Line 44: | ||
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.<ref>Lucas, Gerald (September 1, 2023). “Exploring the Dichotomy: A Comparative Analysis of Digital and Paper Documents.” Retrieved Oct 29, 2023. https://grlucas.net/grl/CompFAQ/Digital_Writing/Documents</ref> | 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.<ref>Lucas, Gerald (September 1, 2023). “Exploring the Dichotomy: A Comparative Analysis of Digital and Paper Documents.” Retrieved Oct 29, 2023. https://grlucas.net/grl/CompFAQ/Digital_Writing/Documents</ref> | ||
=== Accessibility === | === 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.<ref>{{cite web |url=https://www.w3.org/WAI/fundamentals/accessibility-intro/ |title=Introduction to Web Accessibility |author=<!--Not stated--> |website=Web Accessibility Initiative |access-date=October 26, 2023 }}</ref> It is a legal requirement to include accessibility features in website design.<ref>{{cite web |url=https://wcag.com/legal/ |title=Accessibility and the Web |author=<!--Not stated--> |website=WCAG |access-date=October 26, 2023 }}</ref> | 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.<ref>{{cite web |url=https://www.w3.org/WAI/fundamentals/accessibility-intro/ |title=Introduction to Web Accessibility |author=<!--Not stated--> |website=Web Accessibility Initiative |access-date=October 26, 2023 }}</ref> It is a legal requirement to include accessibility features in website design.<ref>{{cite web |url=https://wcag.com/legal/ |title=Accessibility and the Web |author=<!--Not stated--> |website=WCAG |access-date=October 26, 2023 }}</ref> | ||
==== 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> | 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> | ||
==== Scannable ==== | |||
Readers quickly scan the main sections of a page to understand its content. The most effective web content is concise and simple to scan, making it easy for users to find the important information.<ref>Barr, Chris (2010). Yahoo! Style Guide. New York: St. Martin's.</ref> | |||
==Collaboration and Version Control== | ==Collaboration and Version Control== | ||