ClickHelp Technical Writing Bloghttp://clickhelp.com/clickhelp-technical-writing-blog/What's new at TechComm? Find answers and ideas in blog posts by authors of ClickHelp - online technical writing and documentation tool.© 2020 ClickHelp. All rights reserved.Tue, 24 Nov 2020 12:33:10 ZTechnical WritingOnline Helphttps://clickhelp.com/clickhelp-technical-writing-blog/can-a-robot-write-technical-documentation/Anastasia/Images/Feeds/Blog/AuthorAvatars/Anastasia.jpgTechnical WritingCan a Robot Write Technical Documentation?<table><tr><td><img src='https://clickhelp.com/images/feeds/blog/2020.11/robots-using-gadgets-icon.jpg'/></td><td style='vertical-align:top'>Robots are often described as some kind of intruders in fiction books, movies, and games. They are soulless creatures that were invented by humans with the best intentions in mind, but it rarely ends well. If there’s no apocalypse, then</td></tr></table>Wed, 18 Nov 2020 09:33:07 Z2020-11-24T12:33:10Z© 2020 ClickHelp. All rights reserved.Robots are often described as some kind of intruders in fiction books, movies, and games. They are soulless creatures that were invented by humans with the best intentions in mind, but it rarely ends well. If there’s no apocalypse, thenhttps://clickhelp.com/clickhelp-technical-writing-blog/software-documentation-in-the-saas-world/Anastasia/Images/Feeds/Blog/AuthorAvatars/Anastasia.jpgTechnical WritingSoftware Documentation in the SaaS World<table><tr><td><img src='https://clickhelp.com/images/feeds/blog/2020.11/code-on-the-laptop-screen-icon.jpg'/></td><td style='vertical-align:top'>This is the era of SaaS. The idea of software has changed a lot for the past I&#39;d say ten years. Sure, we still install software on our PC&#39;s and laptops, but we tend to use services much more: Google</td></tr></table>Wed, 11 Nov 2020 09:35:59 Z2020-11-19T15:30:30Z© 2020 ClickHelp. All rights reserved.This is the era of SaaS. The idea of software has changed a lot for the past I&#39;d say ten years. Sure, we still install software on our PC&#39;s and laptops, but we tend to use services much more: Googlehttps://clickhelp.com/clickhelp-technical-writing-blog/technical-documentation-in-the-era-of-it-security/Anastasia/Images/Feeds/Blog/AuthorAvatars/Anastasia.jpgTechnical WritingTechnical Documentation in the Era of IT Security<table><tr><td><img src='https://clickhelp.com/images/feeds/blog/2020.11/hands-on-laptop-icon.jpg'/></td><td style='vertical-align:top'>Cybersecurity was a hot topic for many movies in the 1990s. Hackers were always lurking on the Internet to steal the top secrets. Although it was displayed incorrectly, for the most part, the danger was really there. Before the Internet</td></tr></table>Tue, 03 Nov 2020 09:05:46 Z2020-11-19T15:30:30Z© 2020 ClickHelp. All rights reserved.Cybersecurity was a hot topic for many movies in the 1990s. Hackers were always lurking on the Internet to steal the top secrets. Although it was displayed incorrectly, for the most part, the danger was really there. Before the Internethttps://clickhelp.com/clickhelp-technical-writing-blog/guidelines-for-naming-files/Anastasia/Images/Feeds/Blog/AuthorAvatars/Anastasia.jpgTechnical WritingGuidelines for Naming Files<table><tr><td><img src='https://clickhelp.com/images/feeds/blog/2020.10/coffee-notebook-laptop-icon.jpg'/></td><td style='vertical-align:top'>Giving names to images/sections/help topics is something tech writers do a lot. To find just the right name is important - this is what defines an object. Understandably, certain guidelines exist for the file naming process. When you work on</td></tr></table>Wed, 28 Oct 2020 11:23:53 Z2020-11-19T15:30:30Z© 2020 ClickHelp. All rights reserved.Giving names to images/sections/help topics is something tech writers do a lot. To find just the right name is important - this is what defines an object. Understandably, certain guidelines exist for the file naming process. When you work onhttps://clickhelp.com/clickhelp-technical-writing-blog/what-is-rfp-writing/Anastasia/Images/Feeds/Blog/AuthorAvatars/Anastasia.jpgTechnical WritingWhat is RFP Writing?<table><tr><td><img src='https://clickhelp.com/images/feeds/blog/2020.10/a-business-newspaper-icon.jpg'/></td><td style='vertical-align:top'>Technical writers can help with many business-related things to make a company successful. For one, they create internal documentation, like process documentation, that keeps everything together. They can write whitepapers, memos, develop educational materials, etc. Today we are going to</td></tr></table>Wed, 21 Oct 2020 10:15:16 Z2020-11-19T15:30:30Z© 2020 ClickHelp. All rights reserved.Technical writers can help with many business-related things to make a company successful. For one, they create internal documentation, like process documentation, that keeps everything together. They can write whitepapers, memos, develop educational materials, etc. Today we are going tohttps://clickhelp.com/clickhelp-technical-writing-blog/how-to-overcome-anxiety-over-mistakes-at-work/Anastasia/Images/Feeds/Blog/AuthorAvatars/Anastasia.jpgSelf-DevelopmentHow to Overcome Anxiety Over Mistakes at Work<table><tr><td><img src='https://clickhelp.com/images/feeds/blog/2020.10/screaming-guy-icon.jpg'/></td><td style='vertical-align:top'>Technical writers are the people behind orchestrating a flawless user experience alongside other teams. Where will a user go if they have questions? They could go to Support, of course, but technical documentation is step one. Users will most likely</td></tr></table>Wed, 14 Oct 2020 12:14:26 Z2020-11-19T15:30:30Z© 2020 ClickHelp. All rights reserved.Technical writers are the people behind orchestrating a flawless user experience alongside other teams. Where will a user go if they have questions? They could go to Support, of course, but technical documentation is step one. Users will most likelyhttps://clickhelp.com/clickhelp-technical-writing-blog/tips-to-write-software-manuals/Anastasia/Images/Feeds/Blog/AuthorAvatars/Anastasia.jpgTechnical WritingTips to Write Software Manuals<table><tr><td><img src='https://clickhelp.com/images/feeds/blog/2020.10/meeting-with-4-people-icon.jpg'/></td><td style='vertical-align:top'>There’s always something to improve in any given help writing process. This post will help you learn how to improve software manuals creation. Software documentation is similar to many other help writing projects, but it has its unique features. Take</td></tr></table>Wed, 07 Oct 2020 09:59:08 Z2020-11-19T15:30:30Z© 2020 ClickHelp. All rights reserved.There’s always something to improve in any given help writing process. This post will help you learn how to improve software manuals creation. Software documentation is similar to many other help writing projects, but it has its unique features. Takehttps://clickhelp.com/clickhelp-technical-writing-blog/technical-specs-practical-guide/Anastasia/Images/Feeds/Blog/AuthorAvatars/Anastasia.jpgTechnical WritingTechnical Specs: Practical Guide<table><tr><td><img src='https://clickhelp.com/images/feeds/blog/2020.09/tablet-phone-laptop-book-icon.jpg'/></td><td style='vertical-align:top'>How can one make sure that their project, a software project, for instance, is going to be a success? No one will give you a recipe that works 100% of the time, but there are ways to increase the chances</td></tr></table>Wed, 30 Sep 2020 09:25:00 Z2020-11-19T15:30:30Z© 2020 ClickHelp. All rights reserved.How can one make sure that their project, a software project, for instance, is going to be a success? No one will give you a recipe that works 100% of the time, but there are ways to increase the chanceshttps://clickhelp.com/clickhelp-technical-writing-blog/burnout-recovery-strategies-for-technical-writers/Anastasia/Images/Feeds/Blog/AuthorAvatars/Anastasia.jpgTechComm Career PathBurnout Recovery Strategies for Technical Writers<table><tr><td><img src='https://clickhelp.com/images/feeds/blog/2020.09/a-stressed-woman-icon.jpg'/></td><td style='vertical-align:top'>If you are reading this, there’s a high chance you are a technical writer experiencing signs of burnout and willing to do something about it. Let’s first define what burnout is by singling out some of the red flags you</td></tr></table>Wed, 23 Sep 2020 06:25:20 Z2020-11-19T15:30:30Z© 2020 ClickHelp. All rights reserved.If you are reading this, there’s a high chance you are a technical writer experiencing signs of burnout and willing to do something about it. Let’s first define what burnout is by singling out some of the red flags youhttps://clickhelp.com/clickhelp-technical-writing-blog/where-should-i-host-a-technical-writing-portfolio/Anastasia/Images/Feeds/Blog/AuthorAvatars/Anastasia.jpgTechComm Career PathWhere Should I Host a Technical Writing Portfolio?<table><tr><td><img src='https://clickhelp.com/images/feeds/blog/2020.09/girl-with-coffee-and-laptop-icon.jpg'/></td><td style='vertical-align:top'>I recently wrote an article on how to compose a tech writing portfolio. The next logical step is actually making it available for future employers. Several things need to be considered: Ease of set up How much knowledge and skills you</td></tr></table>Wed, 16 Sep 2020 09:24:04 Z2020-11-19T15:30:30Z© 2020 ClickHelp. All rights reserved.I recently wrote an article on how to compose a tech writing portfolio. The next logical step is actually making it available for future employers. Several things need to be considered: Ease of set up How much knowledge and skills youhttps://clickhelp.com/clickhelp-technical-writing-blog/user-guide-template/Anastasia/Images/Feeds/Blog/AuthorAvatars/Anastasia.jpgTechnical WritingUser Guide Template<table><tr><td><img src='https://clickhelp.com/images/feeds/blog/2020.09/man-creating-user-manuals-icon.jpg'/></td><td style='vertical-align:top'>When you are starting a new documentation project, you might be looking for guidance. So, in this post, you will find a user manual template that works best for software documentation. The provided guidelines can be applied to other types</td></tr></table>Wed, 09 Sep 2020 10:52:10 Z2020-11-19T15:30:30Z© 2020 ClickHelp. All rights reserved.When you are starting a new documentation project, you might be looking for guidance. So, in this post, you will find a user manual template that works best for software documentation. The provided guidelines can be applied to other typeshttps://clickhelp.com/clickhelp-technical-writing-blog/using-numbers-in-technical-documents/Anastasia/Images/Feeds/Blog/AuthorAvatars/Anastasia.jpgTechnical WritingUsing Numbers in Technical Documents<table><tr><td><img src='https://clickhelp.com/images/feeds/blog/2020.09/graph-with-numbers-icon.jpg'/></td><td style='vertical-align:top'>Technical documents can contain different data, and numbers can be often spotted there. Especially when we are talking about reports and scientific articles. Since every detail in technical writing is important, understanding the ground rules of using numbers in user</td></tr></table>Wed, 02 Sep 2020 09:53:56 Z2020-11-19T15:30:30Z© 2020 ClickHelp. All rights reserved.Technical documents can contain different data, and numbers can be often spotted there. Especially when we are talking about reports and scientific articles. Since every detail in technical writing is important, understanding the ground rules of using numbers in userhttps://clickhelp.com/clickhelp-technical-writing-blog/how-to-improve-your-proofreading-skills/Anastasia/Images/Feeds/Blog/AuthorAvatars/Anastasia.jpgSelf-DevelopmentHow to Improve Your Proofreading Skills<table><tr><td><img src='https://clickhelp.com/images/feeds/blog/2020.08/man-reading-a-book-in-front-of-pc-icon.png'/></td><td style='vertical-align:top'>What makes people cringe when reading technical articles? Typos would be the most common answer, I think, along with any small inconsistencies that make a text look unprofessional and untrustworthy. Proofreading is supposed to filter out such things. However, we</td></tr></table>Wed, 26 Aug 2020 09:05:26 Z2020-11-19T15:30:30Z© 2020 ClickHelp. All rights reserved.What makes people cringe when reading technical articles? Typos would be the most common answer, I think, along with any small inconsistencies that make a text look unprofessional and untrustworthy. Proofreading is supposed to filter out such things. However, wehttps://clickhelp.com/clickhelp-technical-writing-blog/what-is-faq/Anastasia/Images/Feeds/Blog/AuthorAvatars/Anastasia.jpgClickHelp FeaturesWhat is FAQ?<table><tr><td><img src='https://clickhelp.com/images/feeds/blog/2020.08/girl-holding-question-mark-icon.jpg'/></td><td style='vertical-align:top'>An FAQ is a list of frequently asked questions about a product or a service. They can be found on websites, occupy special forum sections, or be part of an online documentation portal. Fun fact - an FAQ section doesn’t</td></tr></table>Wed, 19 Aug 2020 11:59:18 Z2020-11-19T15:30:30Z© 2020 ClickHelp. All rights reserved.An FAQ is a list of frequently asked questions about a product or a service. They can be found on websites, occupy special forum sections, or be part of an online documentation portal. Fun fact - an FAQ section doesn’thttps://clickhelp.com/clickhelp-technical-writing-blog/how-to-choose-samples-for-your-technical-writing-portfolio/Anastasia/Images/Feeds/Blog/AuthorAvatars/Anastasia.jpgTechnical WritingHow to Choose Samples for Your Technical Writing Portfolio<table><tr><td><img src='https://clickhelp.com/images/feeds/blog/2020.08/man-pc-coffee-notebook-icon.jpg'/></td><td style='vertical-align:top'>Can you land a job in technical writing providing no writing samples at all? I believe so, yes. But this will likely be an entry-level role. Hiring you for something more serious, your potential employers would like to see some</td></tr></table>Wed, 12 Aug 2020 11:41:14 Z2020-11-19T15:30:30Z© 2020 ClickHelp. All rights reserved.Can you land a job in technical writing providing no writing samples at all? I believe so, yes. But this will likely be an entry-level role. Hiring you for something more serious, your potential employers would like to see somehttps://clickhelp.com/clickhelp-technical-writing-blog/how-to-manage-a-technical-writing-team/Anastasia/Images/Feeds/Blog/AuthorAvatars/Anastasia.jpgTechnical WritingHow to Manage a Technical Writing Team<table><tr><td><img src='https://clickhelp.com/images/feeds/blog/2020.08/laughing-businesswoman-working-in-office-with-laptop-icon.jpg'/></td><td style='vertical-align:top'>At first glance, this blog post is more fitted for people currently fulfilling the position of a manager in a documentation team. However, if you are a technical writer now, you might as well get a promotion one day to</td></tr></table>Wed, 05 Aug 2020 09:06:27 Z2020-11-19T15:30:30Z© 2020 ClickHelp. All rights reserved.At first glance, this blog post is more fitted for people currently fulfilling the position of a manager in a documentation team. However, if you are a technical writer now, you might as well get a promotion one day tohttps://clickhelp.com/clickhelp-technical-writing-blog/technical-writer-as-an-information-architect/Anastasia/Images/Feeds/Blog/AuthorAvatars/Anastasia.jpgTechnical WritingTechnical Writer as an Information Architect<table><tr><td><img src='https://clickhelp.com/images/feeds/blog/2020.07/person-holding-white-stylus-using-a-tablet-computer-icon.jpg'/></td><td style='vertical-align:top'>Technical writing is a complex process that requires proper orchestration. We can see how it is evolving with time, too. Technical writing is now more integrated into user experience than ever before. The thing about integration - you can’t do</td></tr></table>Thu, 30 Jul 2020 12:02:09 Z2020-11-19T15:30:30Z© 2020 ClickHelp. All rights reserved.Technical writing is a complex process that requires proper orchestration. We can see how it is evolving with time, too. Technical writing is now more integrated into user experience than ever before. The thing about integration - you can’t dohttps://clickhelp.com/clickhelp-technical-writing-blog/tips-to-start-a-tech-writing-business/Anastasia/Images/Feeds/Blog/AuthorAvatars/Anastasia.jpgTechnical WritingTips to Start a Tech Writing Business<table><tr><td><img src='https://clickhelp.com/images/feeds/blog/2020.07/man-wearing-black-suit-jacket-and-pants-icon.jpg'/></td><td style='vertical-align:top'>Would you like to start your own tech writing agency? This is a big decision and a lot of thinking needs to happen. Understandably, this is not a solution for everyone and this is completely fine. However, if you are</td></tr></table>Tue, 28 Jul 2020 07:14:10 Z2020-11-19T15:30:30Z© 2020 ClickHelp. All rights reserved.Would you like to start your own tech writing agency? This is a big decision and a lot of thinking needs to happen. Understandably, this is not a solution for everyone and this is completely fine. However, if you arehttps://clickhelp.com/clickhelp-technical-writing-blog/clickhelp-july-2020-release-overview-gecko/Anastasia/Images/Feeds/Blog/AuthorAvatars/Anastasia.jpgClickHelp NewsClickHelp July 2020 Release Overview - Gecko<table><tr><td><img src='https://clickhelp.com/images/feeds/blog/2020.07/Gecko-on-stone-icon.jpg'/></td><td style='vertical-align:top'>We have awesome news! A new ClickHelp release is here! This blog post will take you on a journey to get to know ClickHelp Gecko better - I am sure you are going to love it. We know we are</td></tr></table>Tue, 21 Jul 2020 10:25:19 Z2020-11-19T15:30:30Z© 2020 ClickHelp. All rights reserved.We have awesome news! A new ClickHelp release is here! This blog post will take you on a journey to get to know ClickHelp Gecko better - I am sure you are going to love it. We know we arehttps://clickhelp.com/clickhelp-technical-writing-blog/mistakes-to-avoid-in-help-authoring-use-clickhelp-efficiently/Anastasia/Images/Feeds/Blog/AuthorAvatars/Anastasia.jpgClickHelp FeaturesMistakes to Avoid in Help Authoring - Use ClickHelp Efficiently<table><tr><td><img src='https://clickhelp.com/images/feeds/blog/2020.07/happy-clickhelp-user-icon.jpg'/></td><td style='vertical-align:top'>ClickHelp is a tool for technical writers that offers enormous possibilities. We would like for each user to be able to use our software to its full potential. To help with that, I’ve come up with a list of mistakes</td></tr></table>Wed, 15 Jul 2020 06:55:10 Z2020-11-19T15:30:30Z© 2020 ClickHelp. All rights reserved.ClickHelp is a tool for technical writers that offers enormous possibilities. We would like for each user to be able to use our software to its full potential. To help with that, I’ve come up with a list of mistakeshttps://clickhelp.com/clickhelp-technical-writing-blog/what-value-technical-writers-bring-to-business/Anastasia/Images/Feeds/Blog/AuthorAvatars/Anastasia.jpgTechnical WritingWhat Value Technical Writers Bring to Business?<table><tr><td><img src='https://clickhelp.com/images/feeds/blog/2020.07/money-calculating-icon.jpg'/></td><td style='vertical-align:top'>Technical documentation is viewed as something handy and nobody would ever doubt that it is necessary to have one. On the other hand, technical writers are faced with the reality of people underestimating what they are doing. We’ve painted a</td></tr></table>Wed, 08 Jul 2020 07:03:02 Z2020-11-19T15:30:30Z© 2020 ClickHelp. All rights reserved.Technical documentation is viewed as something handy and nobody would ever doubt that it is necessary to have one. On the other hand, technical writers are faced with the reality of people underestimating what they are doing. We’ve painted ahttps://clickhelp.com/clickhelp-technical-writing-blog/tricky-grammar-in-user-guides/Anastasia/Images/Feeds/Blog/AuthorAvatars/Anastasia.jpgTechnical WritingTricky Grammar in User Guides<table><tr><td><img src='https://clickhelp.com/images/feeds/blog/2020.07/man-with-crumpled-paper-icon.jpg'/></td><td style='vertical-align:top'>All technical writers are famous for being meticulous about grammar, style, and punctuation. Reviewers and editors are even more scrupulous. If we count the time wasted on checking grammar in user guides, it will probably drive us to the conclusion</td></tr></table>Wed, 01 Jul 2020 05:02:14 Z2020-11-19T15:30:30Z© 2020 ClickHelp. All rights reserved.All technical writers are famous for being meticulous about grammar, style, and punctuation. Reviewers and editors are even more scrupulous. If we count the time wasted on checking grammar in user guides, it will probably drive us to the conclusionhttps://clickhelp.com/clickhelp-technical-writing-blog/versioning-of-technical-documents-the-single-sourcing-approach/Anastasia/Images/Feeds/Blog/AuthorAvatars/Anastasia.jpgClickHelp FeaturesVersioning of Technical Documents - the Single-Sourcing Approach<table><tr><td><img src='https://clickhelp.com/images/feeds/blog/2020.06/wooden-table-and-laptop-icon.jpg'/></td><td style='vertical-align:top'>Let’s talk about versioning user manuals today. This concept has far more use cases than one might think. We will name some of the most popular ones and talk about the means ClickHelp, a cloud solution for help writing, offers</td></tr></table>Wed, 24 Jun 2020 04:40:27 Z2020-11-19T15:30:30Z© 2020 ClickHelp. All rights reserved.Let’s talk about versioning user manuals today. This concept has far more use cases than one might think. We will name some of the most popular ones and talk about the means ClickHelp, a cloud solution for help writing, offershttps://clickhelp.com/clickhelp-technical-writing-blog/google-chrome-will-start-blocking-non-secure-content/Anastasia/Images/Feeds/Blog/AuthorAvatars/Anastasia.jpgTechnologyGoogle Chrome will Start Blocking Non-secure Content<table><tr><td><img src='https://clickhelp.com/images/feeds/blog/2020.06/google-banner-icon.jpg'/></td><td style='vertical-align:top'>The Threat While the entire world is moving in the direction of secure Internet connections and using HTTPS for almost all web sites, people may become less cautious believing that they are secured. This introduces attackers with easier ways to</td></tr></table>Fri, 19 Jun 2020 14:06:12 Z2020-11-19T15:30:30Z© 2020 ClickHelp. All rights reserved.The Threat While the entire world is moving in the direction of secure Internet connections and using HTTPS for almost all web sites, people may become less cautious believing that they are secured. This introduces attackers with easier ways tohttps://clickhelp.com/clickhelp-technical-writing-blog/top-5-books-for-technical-writers/Anastasia/Images/Feeds/Blog/AuthorAvatars/Anastasia.jpgEducationTop 5 Books for Technical Writers<table><tr><td><img src='https://clickhelp.com/images/feeds/blog/2020.06/man-sitting-on-a-bench-with-kindle-icon.jpg'/></td><td style='vertical-align:top'>Do you enjoy reading as much as I do? The best part about books is that you can find one for any cause. Our today’s cause is technical writing. And, there are a lot of great books directly about tech</td></tr></table>Wed, 17 Jun 2020 09:17:45 Z2020-11-19T15:30:30Z© 2020 ClickHelp. All rights reserved.Do you enjoy reading as much as I do? The best part about books is that you can find one for any cause. Our today’s cause is technical writing. And, there are a lot of great books directly about tech
https://clickhelp.com/news-feed/getFeed/?type=blog&format=rss
clickhelp.com
crawl=CC-MAIN-2020-50
33156
application/http; msgtype=response
sha1:FU5HOWFSKJPXIJY6ORALJGRKWRJU64BB
<urn:uuid:7e4af328-c47d-4ce7-b9e2-e4827fb7f23d>
2020-11-25T07:58:39Z
3.21.239.2
application/xml
sha1:KRFDQAF2LIOSNYWZ54JTIRLMIXD3XQ7G
<urn:uuid:4a97fc08-5de4-4aba-b67e-b8f823d2a605>
https://clickhelp.com/news-feed/getFeed/?type=blog&format=rss
response
<urn:uuid:f7284b99-8562-4b9f-afc8-196f1af97f19>
isPartOf: CC-MAIN-2020-50
publisher: Common Crawl
description: Wide crawl of the web for November/December 2020
operator: Common Crawl Admin (info@commoncrawl.org)
hostname: ip-10-67-67-96.ec2.internal
software: Apache Nutch 1.17 (modified, https://github.com/commoncrawl/nutch/)
robots: checked via crawler-commons 1.2-SNAPSHOT (https://github.com/crawler-commons/crawler-commons)
format: WARC File Format 1.1
conformsTo: http://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/