Technical Writing Blog

Software development is such a process that differs from other kinds of engineering procedures. It requires the attention of a mobile and flexible team that is willing to respond quickly to changes. This is when Agile methodology steps in. Agile methodology is a set of routines oriented toward the efficiency improvement of software development specialists….

What Is a Technical Report? A technical report is a document written by a researcher; it describes how the research was conveyed: its phases, steps, results, peculiarities, etc., and may include deeper details like experimental data and outcome. It is a published document that clearly guides readers through the course of your work. Who Needs…

Imagine that every day you see dozens of mismatched PDFs that are produced and uploaded to some documentation site that doesn’t have navigation. Fellow tech writers are wasting loads of valuable hours fixing one thing across masses of documents when they could be creating new content instead. Seems like it’s the place to implement structure….

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 create one? Imagine this: your team spends several months building a software product, only to…

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 are quickly and efficiently distributed through emails, phones, and chat or conferencing tools that let…

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 a systematic process of document creation that has a cyclic order. Technical writers and content…

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 proverb says: To learn a language is to have one more window from which to…

Technical writing is an occupation that requires new skills and knowledge update all the time. Sometimes, such simple things as sharing experiences or answering questions from colleagues can help to solve a lot of problems. That’s why professional communities for tech writers are still highly popular. We’ve already posted an article that tells about professional…

We are excited to present to you the ClickHelp Rainbow update! We have considerably broadened the possibilities of our documentation platform through a brand new translation module and powerful features that are ready to fascinate you. One of the most exciting and popularizing qualities of technology is its ability to reach people around the globe…

Hello everyone! This is Vasilisa, the editor-in-chief of ClickHelp Technical Writing Blog. Nice to meet you, our dear readers! In fact, our editors were preparing another blog for today, but… I’d like to share some awesome news with you. The beginning of June was great for our editorial: we discovered that our Telegram channel hit…