ClickHelp Technical Writing Blog

A Software Design Document (SDD) is known by different names; it is often called a software design specification, a software requirement document, or technical specs. This is a detailed description of the overall architecture of a piece of software. Why Continue reading »

Many working environments demand collaborative writing and editing of documents. Nowadays, such collaborations are simplified. The participants don’t need to be co-located and work from the same office; they are free to reside in different geographic locations. In addition, documents Continue reading »

When you write documentation every day, you can’t help noticing that this process has phases and cycles that, in the majority of cases, are the same. They are called Document Development Life Cycle (DDLC). Document Development Life Cycle (DDLC) is Continue reading »

For a coon’s age, people dreamed of something like a babel fish from The Hitchhiker's Guide to the Galaxy. That fish is placed in someone's ear so that a person could hear any language translated into their language. A Chinese Continue reading »

If you talk to a man in a language he understands, that goes to his head. If you talk to him in his language, that goes to his heart. Nelson Mandela Every technical writer knows the single-sourcing method that emerged Continue reading »

Imagine a situation: you are to master a piece of software but you don’t know what to begin with. And you find a user guide for your product. You start looking it through and see that it contains information in Continue reading »

Facile pen, subject knowledge, and ability to transform technical subtleties into clarities for the end-users - these are must-have talents for a technical writer. Indeed, there’s more to it - we have already written about the skills of a good Continue reading »

New words and phrases tend to somehow miraculously seep into our everyday life. This is regular for the world of modern technology. And as a person working closely with words and technology, have you ever wondered how these words are Continue reading »

Technical drawing today is an essential part of technical documentation. Such industries as civil engineering, architecture, shipbuilding, aerospace engineering, astronautics, or medical engineering can’t help using technical drawings. Those technical writers who work on documentation like that, are to be Continue reading »

Standard operating procedures, or SOPs, are documents that contain a set of instructions on how to perform a task in a correct and safe way according to all the regulations. This type of technical documentation is equally important not only Continue reading »