{"id":4277,"date":"2018-03-26T10:31:46","date_gmt":"2018-03-26T14:31:46","guid":{"rendered":"https:\/\/contentwriters.com\/blog\/?p=4277"},"modified":"2023-10-23T11:30:23","modified_gmt":"2023-10-23T15:30:23","slug":"make-technical-writing-more-accessible","status":"publish","type":"post","link":"https:\/\/contentwriters.com\/blog\/make-technical-writing-more-accessible\/","title":{"rendered":"How to Take Technical Writing and Make It More Accessible"},"content":{"rendered":"<p>In technical writing, accessibility refers to the ability for users to search, acquire, download, and understand complex communications. There are a variety of ways to do this, and technical writers have been discussing <a href=\"https:\/\/contentwriters.com\/\">best practices<\/a> for quite some time. From employing standard <a href=\"https:\/\/www.makeuseof.com\/tag\/not-just-for-coders-top-version-control-systems-for-writers\/\">version control<\/a> and consistent titles or doc numbers to utilizing Content Management Systems (CMS) or searchable databases for users \u2014 accessibility is a vital aspect of technical writing and complex documentation.<\/p>\n<p><img decoding=\"async\" class=\"aligncenter\" src=\"https:\/\/cdn.pixabay.com\/photo\/2016\/11\/13\/04\/52\/statistic-1820320_960_720.png\" alt=\"Statistic, WordPress, Web, Data, Information, Cms\" \/><\/p>\n<h2>Version Control<\/h2>\n<p>No matter if you are a CMS administrator or the technical writer in charge of formatting and delivering technical communication \u2014 version control <em>must<\/em> be employed in order to ensure users are getting the latest and greatest version of your technical documentation. Whether the data is found in the filename, the CMS, or in the properties of the document \u2014 a robust version control regime should be developed in organizations that rely on maintaining update communication, and especially if said organization is dealing with hundreds of thousands of documents.<\/p>\n<h2>Searchable Databases<\/h2>\n<p>Users must be able to access documentation through search queries conducted via web or in an organization\u2019s intranet. There are a variety of CMS programs and database development software that can help mitigate the influx and development of many documents, and can be a life-saver if there are many users attempting to search through a vast collection of technical documents. Employing such software also frees up time from CMS administrators or <a href=\"https:\/\/www.instructionalsolutions.com\/blog\/technical-writing-tips\">technical writers<\/a> from responding to several requests to obtain or access specific documents from a user population.<\/p>\n<h2>What\u2019s In a Filename?<\/h2>\n<p>Some organizations make the mistake of including as much information in a filename as possible. In companies that make this mistake, it may not be uncommon to come across a document that is named \u201cOrganizational_chart_current_March52018_ver2.pdf\u201d It can make even those most laid-back of <a href=\"https:\/\/contentwriters.com\/blog\/technical-writing-done-right\/\">technical writers<\/a> or CMS administrators cringe. Short, concise filenames should be used; version control and dates should be maintained in the document properties and meta data. Be strategic with filenames \u2014 the shorter and more relevant is the aim here.<\/p>\n<p><img decoding=\"async\" class=\"aligncenter\" src=\"https:\/\/blog.dundee.ac.uk\/web\/files\/2018\/01\/accessibility-venn.png\" alt=\"Image result for accessibility usability\" \/><\/p>\n<h2>Core Principles<\/h2>\n<p>One technical writer on <a href=\"https:\/\/medium.com\/technical-writing\/creating-accessible-documents-in-ms-word-ffe4e2eb3923\">Medium<\/a> notes that structured content is just as important as learning how to manage meta data and obtaining a space to store the documents. Using headings, lists, alt-text for images, and tables wisely will not only make for stronger documentation, it may help search queries return with more relevant documentation for users. This will help reduce support calls to find specific documents and thus increasing the amount of time technical writers and CMS administrators can spend on making searchable databases more robust and efficient.<\/p>\n<p>Employing these simple principles into your technical writing strategy will go a long way when it comes to user accessibility. Users will cease calling the help desk to find otherwise easily-searchable documentation stored within CMS dashboards or other databases.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>In technical writing, accessibility refers to the ability for users to search, acquire, download, and understand complex communications. There are &#8230;<\/p>\n","protected":false},"author":35,"featured_media":4279,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[195],"tags":[1338,1340,1339,1261,547],"class_list":["post-4277","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-content-creation","tag-accessibility","tag-cms","tag-content-accessibility","tag-technical-writing","tag-written-content"],"acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v27.8 - https:\/\/yoast.com\/product\/yoast-seo-wordpress\/ -->\n<title>How to Take Technical Writing and Make It More Accessible<\/title>\n<meta name=\"description\" content=\"In technical writing, accessibility refers to the ability for users to search, acquire, download, and understand complex communications.\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/contentwriters.com\/blog\/make-technical-writing-more-accessible\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"How to Take Technical Writing and Make It More Accessible\" \/>\n<meta property=\"og:description\" content=\"In technical writing, accessibility refers to the ability for users to search, acquire, download, and understand complex communications.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/contentwriters.com\/blog\/make-technical-writing-more-accessible\/\" \/>\n<meta property=\"og:site_name\" content=\"ContentWriters Blog\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/FindContentWriters\" \/>\n<meta property=\"article:published_time\" content=\"2018-03-26T14:31:46+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2023-10-23T15:30:23+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/contentwriters.com\/blog\/wp-content\/uploads\/shutterstock_640907125-min.jpg\" \/>\n\t<meta property=\"og:image:width\" content=\"5608\" \/>\n\t<meta property=\"og:image:height\" content=\"3744\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/jpeg\" \/>\n<meta name=\"author\" content=\"Jody R.\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@_ContentWriters\" \/>\n<meta name=\"twitter:site\" content=\"@_ContentWriters\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Jody R.\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"2 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\\\/\\\/contentwriters.com\\\/blog\\\/make-technical-writing-more-accessible\\\/#article\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/contentwriters.com\\\/blog\\\/make-technical-writing-more-accessible\\\/\"},\"author\":{\"name\":\"Jody R.\",\"@id\":\"https:\\\/\\\/contentwriters.com\\\/blog\\\/#\\\/schema\\\/person\\\/33cf22329bdefd17fcc944ef8108292f\"},\"headline\":\"How to Take Technical Writing and Make It More Accessible\",\"datePublished\":\"2018-03-26T14:31:46+00:00\",\"dateModified\":\"2023-10-23T15:30:23+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\\\/\\\/contentwriters.com\\\/blog\\\/make-technical-writing-more-accessible\\\/\"},\"wordCount\":483,\"publisher\":{\"@id\":\"https:\\\/\\\/contentwriters.com\\\/blog\\\/#organization\"},\"image\":{\"@id\":\"https:\\\/\\\/contentwriters.com\\\/blog\\\/make-technical-writing-more-accessible\\\/#primaryimage\"},\"thumbnailUrl\":\"https:\\\/\\\/contentwriters.com\\\/blog\\\/wp-content\\\/uploads\\\/shutterstock_640907125-min.jpg\",\"keywords\":[\"accessibility\",\"CMS\",\"content accessibility\",\"technical writing\",\"Written Content\"],\"articleSection\":[\"Content Creation\"],\"inLanguage\":\"en-US\"},{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/contentwriters.com\\\/blog\\\/make-technical-writing-more-accessible\\\/\",\"url\":\"https:\\\/\\\/contentwriters.com\\\/blog\\\/make-technical-writing-more-accessible\\\/\",\"name\":\"How to Take Technical Writing and Make It More Accessible\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/contentwriters.com\\\/blog\\\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\\\/\\\/contentwriters.com\\\/blog\\\/make-technical-writing-more-accessible\\\/#primaryimage\"},\"image\":{\"@id\":\"https:\\\/\\\/contentwriters.com\\\/blog\\\/make-technical-writing-more-accessible\\\/#primaryimage\"},\"thumbnailUrl\":\"https:\\\/\\\/contentwriters.com\\\/blog\\\/wp-content\\\/uploads\\\/shutterstock_640907125-min.jpg\",\"datePublished\":\"2018-03-26T14:31:46+00:00\",\"dateModified\":\"2023-10-23T15:30:23+00:00\",\"description\":\"In technical writing, accessibility refers to the ability for users to search, acquire, download, and understand complex communications.\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/contentwriters.com\\\/blog\\\/make-technical-writing-more-accessible\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/contentwriters.com\\\/blog\\\/make-technical-writing-more-accessible\\\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/contentwriters.com\\\/blog\\\/make-technical-writing-more-accessible\\\/#primaryimage\",\"url\":\"https:\\\/\\\/contentwriters.com\\\/blog\\\/wp-content\\\/uploads\\\/shutterstock_640907125-min.jpg\",\"contentUrl\":\"https:\\\/\\\/contentwriters.com\\\/blog\\\/wp-content\\\/uploads\\\/shutterstock_640907125-min.jpg\",\"width\":5608,\"height\":3744,\"caption\":\"shutterstock 640907125 min\"},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/contentwriters.com\\\/blog\\\/make-technical-writing-more-accessible\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/contentwriters.com\\\/blog\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"How to Take Technical Writing and Make It More Accessible\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/contentwriters.com\\\/blog\\\/#website\",\"url\":\"https:\\\/\\\/contentwriters.com\\\/blog\\\/\",\"name\":\"ContentWriters Blog\",\"description\":\"\",\"publisher\":{\"@id\":\"https:\\\/\\\/contentwriters.com\\\/blog\\\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/contentwriters.com\\\/blog\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\\\/\\\/contentwriters.com\\\/blog\\\/#organization\",\"name\":\"ContentWriters\",\"url\":\"https:\\\/\\\/contentwriters.com\\\/blog\\\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/contentwriters.com\\\/blog\\\/#\\\/schema\\\/logo\\\/image\\\/\",\"url\":\"https:\\\/\\\/contentwriters.com\\\/blog\\\/wp-content\\\/uploads\\\/2023\\\/05\\\/logomark-blue.png\",\"contentUrl\":\"https:\\\/\\\/contentwriters.com\\\/blog\\\/wp-content\\\/uploads\\\/2023\\\/05\\\/logomark-blue.png\",\"width\":2592,\"height\":2514,\"caption\":\"ContentWriters\"},\"image\":{\"@id\":\"https:\\\/\\\/contentwriters.com\\\/blog\\\/#\\\/schema\\\/logo\\\/image\\\/\"},\"sameAs\":[\"https:\\\/\\\/www.facebook.com\\\/FindContentWriters\",\"https:\\\/\\\/x.com\\\/_ContentWriters\",\"https:\\\/\\\/www.linkedin.com\\\/company\\\/content-writers\\\/\"]},{\"@type\":\"Person\",\"@id\":\"https:\\\/\\\/contentwriters.com\\\/blog\\\/#\\\/schema\\\/person\\\/33cf22329bdefd17fcc944ef8108292f\",\"name\":\"Jody R.\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/contentwriters.com\\\/blog\\\/wp-content\\\/uploads\\\/2019\\\/03\\\/favicon-01-96x96.png\",\"url\":\"https:\\\/\\\/contentwriters.com\\\/blog\\\/wp-content\\\/uploads\\\/2019\\\/03\\\/favicon-01-96x96.png\",\"contentUrl\":\"https:\\\/\\\/contentwriters.com\\\/blog\\\/wp-content\\\/uploads\\\/2019\\\/03\\\/favicon-01-96x96.png\",\"caption\":\"Jody R.\"},\"description\":\"Jody R. is a writer based in New Orleans, LA. He has developed marketing and technical writing documentation for a variety of clients worldwide. On his spare time, he enjoys travel, guitar, and a quality whiskey.\",\"url\":\"https:\\\/\\\/contentwriters.com\\\/blog\\\/author\\\/jody-r\\\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"How to Take Technical Writing and Make It More Accessible","description":"In technical writing, accessibility refers to the ability for users to search, acquire, download, and understand complex communications.","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/contentwriters.com\/blog\/make-technical-writing-more-accessible\/","og_locale":"en_US","og_type":"article","og_title":"How to Take Technical Writing and Make It More Accessible","og_description":"In technical writing, accessibility refers to the ability for users to search, acquire, download, and understand complex communications.","og_url":"https:\/\/contentwriters.com\/blog\/make-technical-writing-more-accessible\/","og_site_name":"ContentWriters Blog","article_publisher":"https:\/\/www.facebook.com\/FindContentWriters","article_published_time":"2018-03-26T14:31:46+00:00","article_modified_time":"2023-10-23T15:30:23+00:00","og_image":[{"width":5608,"height":3744,"url":"https:\/\/contentwriters.com\/blog\/wp-content\/uploads\/shutterstock_640907125-min.jpg","type":"image\/jpeg"}],"author":"Jody R.","twitter_card":"summary_large_image","twitter_creator":"@_ContentWriters","twitter_site":"@_ContentWriters","twitter_misc":{"Written by":"Jody R.","Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/contentwriters.com\/blog\/make-technical-writing-more-accessible\/#article","isPartOf":{"@id":"https:\/\/contentwriters.com\/blog\/make-technical-writing-more-accessible\/"},"author":{"name":"Jody R.","@id":"https:\/\/contentwriters.com\/blog\/#\/schema\/person\/33cf22329bdefd17fcc944ef8108292f"},"headline":"How to Take Technical Writing and Make It More Accessible","datePublished":"2018-03-26T14:31:46+00:00","dateModified":"2023-10-23T15:30:23+00:00","mainEntityOfPage":{"@id":"https:\/\/contentwriters.com\/blog\/make-technical-writing-more-accessible\/"},"wordCount":483,"publisher":{"@id":"https:\/\/contentwriters.com\/blog\/#organization"},"image":{"@id":"https:\/\/contentwriters.com\/blog\/make-technical-writing-more-accessible\/#primaryimage"},"thumbnailUrl":"https:\/\/contentwriters.com\/blog\/wp-content\/uploads\/shutterstock_640907125-min.jpg","keywords":["accessibility","CMS","content accessibility","technical writing","Written Content"],"articleSection":["Content Creation"],"inLanguage":"en-US"},{"@type":"WebPage","@id":"https:\/\/contentwriters.com\/blog\/make-technical-writing-more-accessible\/","url":"https:\/\/contentwriters.com\/blog\/make-technical-writing-more-accessible\/","name":"How to Take Technical Writing and Make It More Accessible","isPartOf":{"@id":"https:\/\/contentwriters.com\/blog\/#website"},"primaryImageOfPage":{"@id":"https:\/\/contentwriters.com\/blog\/make-technical-writing-more-accessible\/#primaryimage"},"image":{"@id":"https:\/\/contentwriters.com\/blog\/make-technical-writing-more-accessible\/#primaryimage"},"thumbnailUrl":"https:\/\/contentwriters.com\/blog\/wp-content\/uploads\/shutterstock_640907125-min.jpg","datePublished":"2018-03-26T14:31:46+00:00","dateModified":"2023-10-23T15:30:23+00:00","description":"In technical writing, accessibility refers to the ability for users to search, acquire, download, and understand complex communications.","breadcrumb":{"@id":"https:\/\/contentwriters.com\/blog\/make-technical-writing-more-accessible\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/contentwriters.com\/blog\/make-technical-writing-more-accessible\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/contentwriters.com\/blog\/make-technical-writing-more-accessible\/#primaryimage","url":"https:\/\/contentwriters.com\/blog\/wp-content\/uploads\/shutterstock_640907125-min.jpg","contentUrl":"https:\/\/contentwriters.com\/blog\/wp-content\/uploads\/shutterstock_640907125-min.jpg","width":5608,"height":3744,"caption":"shutterstock 640907125 min"},{"@type":"BreadcrumbList","@id":"https:\/\/contentwriters.com\/blog\/make-technical-writing-more-accessible\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/contentwriters.com\/blog\/"},{"@type":"ListItem","position":2,"name":"How to Take Technical Writing and Make It More Accessible"}]},{"@type":"WebSite","@id":"https:\/\/contentwriters.com\/blog\/#website","url":"https:\/\/contentwriters.com\/blog\/","name":"ContentWriters Blog","description":"","publisher":{"@id":"https:\/\/contentwriters.com\/blog\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/contentwriters.com\/blog\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/contentwriters.com\/blog\/#organization","name":"ContentWriters","url":"https:\/\/contentwriters.com\/blog\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/contentwriters.com\/blog\/#\/schema\/logo\/image\/","url":"https:\/\/contentwriters.com\/blog\/wp-content\/uploads\/2023\/05\/logomark-blue.png","contentUrl":"https:\/\/contentwriters.com\/blog\/wp-content\/uploads\/2023\/05\/logomark-blue.png","width":2592,"height":2514,"caption":"ContentWriters"},"image":{"@id":"https:\/\/contentwriters.com\/blog\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.facebook.com\/FindContentWriters","https:\/\/x.com\/_ContentWriters","https:\/\/www.linkedin.com\/company\/content-writers\/"]},{"@type":"Person","@id":"https:\/\/contentwriters.com\/blog\/#\/schema\/person\/33cf22329bdefd17fcc944ef8108292f","name":"Jody R.","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/contentwriters.com\/blog\/wp-content\/uploads\/2019\/03\/favicon-01-96x96.png","url":"https:\/\/contentwriters.com\/blog\/wp-content\/uploads\/2019\/03\/favicon-01-96x96.png","contentUrl":"https:\/\/contentwriters.com\/blog\/wp-content\/uploads\/2019\/03\/favicon-01-96x96.png","caption":"Jody R."},"description":"Jody R. is a writer based in New Orleans, LA. He has developed marketing and technical writing documentation for a variety of clients worldwide. On his spare time, he enjoys travel, guitar, and a quality whiskey.","url":"https:\/\/contentwriters.com\/blog\/author\/jody-r\/"}]}},"_links":{"self":[{"href":"https:\/\/contentwriters.com\/blog\/wp-json\/wp\/v2\/posts\/4277","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/contentwriters.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/contentwriters.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/contentwriters.com\/blog\/wp-json\/wp\/v2\/users\/35"}],"replies":[{"embeddable":true,"href":"https:\/\/contentwriters.com\/blog\/wp-json\/wp\/v2\/comments?post=4277"}],"version-history":[{"count":2,"href":"https:\/\/contentwriters.com\/blog\/wp-json\/wp\/v2\/posts\/4277\/revisions"}],"predecessor-version":[{"id":6386,"href":"https:\/\/contentwriters.com\/blog\/wp-json\/wp\/v2\/posts\/4277\/revisions\/6386"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/contentwriters.com\/blog\/wp-json\/wp\/v2\/media\/4279"}],"wp:attachment":[{"href":"https:\/\/contentwriters.com\/blog\/wp-json\/wp\/v2\/media?parent=4277"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/contentwriters.com\/blog\/wp-json\/wp\/v2\/categories?post=4277"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/contentwriters.com\/blog\/wp-json\/wp\/v2\/tags?post=4277"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}