Technical Writing Blog

Hundreds of tips can be found on the Internet on creating appealing resumes. There are some general guidelines and standards to follow regardless of the profession of choice. But, if you want to really impress your interviewer, you might want Continue reading »

Hi, I’m Kesi Parker, a technical writer. I like to chat with technical writers on Facebook to get acquainted with new people and get new experience. And know what? In some companies, technical writers use MS Word or Google Docs Continue reading »

Migrating to a new tool is a pain for anyone. Even when a new messenger is implemented in your company, there’s still this transition period. Yes, with sending messages being the primary function of an app, you still need time Continue reading »

Technical writing requires tools for measurement and analysis like any other work process. Although, it is quite difficult to decide what metrics to use considering specifics of this field. We began discussing this topic a while ago and figured out Continue reading »

Punctuation in English is considered by many somewhat optional. But quotation marks are an exception here - you can’t skip them in such cases like a direct quote, for example. Quotation marks usage is often found confusing as British English Continue reading »

An API without a good user manual is next to useless. Developers would like a clear view of an API, code examples, detailed explanation of calls and parameters. And, they are not the only people visiting an API documentation portal Continue reading »

What is a perfect help topic? It is a topic that delivers a solution to its readers in the most efficient manner. Creating such topics means paying attention to their every element and analyzing them. Further, you will find practical Continue reading »

Creating user manuals is a difficult task on its own. Making them good is even more difficult. If while reading these first two sentences you thought to yourself, ‘Well, my technical documentation is quite good, actually’ - you might be Continue reading »

User documentation is the face your company shows to the world. Having quality manuals is just as important as having a great support team. Remember, a lot of issues get deflected without actual involvement of support if documentation is okay Continue reading »

This post has been created in order to help technical writers find useful resources for professional growth. Here you will find resources for both experienced tech writers and those who have just started their professional journey. Top Online Technical Writing Continue reading »