Technical Writing Blog

Last time, we talked about screen emulation tools to help you test your web content on different devices. In this post, we will make the next step and take a look at the tools helping you detect any UI issues specific to mobile device browsers. Note: Although we consider responsive markup in the context of…

It’s not a secret for anyone that mobile Internet can be quite slow. The page loading speed is very important for mobile-oriented pages. And it’s not a secret either that Google is using the site speed as a SEO factor. Also, it is well-known that people tend to leave a web site if it does…

Creating documentation for online publishing can be tricky not only for novice technical writers, but also for those focused on printable outputs. There are important conceptual differences between HTML and PDF (or other printable formats). One of the most obvious challenges is

Have you ever thought of what your online documentation looks like when viewed on a 1920×1080 monitor or opened from an iPhone? Well, today you definitely should. It is not a secret for anyone that mobile browsers usage grows rapidly and having a mobile website becomes a must for every online business. But did you…

Many online documentation formats are related to HTML in one way or another. At that, many online documentation topics are using the same visual layout – a header container with information and quick links; and the topic body in a scrollable container. Looks simple and typical. But have you ever tried to implement this layout…

When technical writers are working in a Team, they organize the teamwork in a certain manner. This means that there is some workflow they are using – either formally, or not. Let’s see how our technical writing tool assists technical writer Teams with this.

Typically, each web site has directories and pages that should not be indexed by search engines. For example, printed versions of web site pages, pages of the security system (registration, authentication). There may also be directories like administrator resources folder, various technical folders. In addition, webmasters may want to give additional information about indexing to…

The order of words in a text is used by search engines in ranking. It is a known fact, which should be paid attention to. First of all, the beginning of text is very important for search engines. Therefore, this part of any text must contain keywords and basic information about the content.

When readers are browsing online documentation, they click cross-topic links a lot, and use the Table of Contents navigation quite often. With these use cases, if the entire page re-loads on every navigation, this may harm the documentation usability. To improve online documentation responsiveness, technical writers often use AJAX navigation. The idea is simple –…

This is a continuation of a blog post series on the SEO aspect of technical writing. And now we want to talk briefly about Google Analytics – the powerful and free statistical tool by Google.