Think of an apartment building and a mall. They both are architectural structures but they are quite different from one another. One is built for residential purposes while the other is built for commercial activities. Each building has its own users, such as residents, shop-owners, and shoppers. Each type of user has different needs and
Technical writing is a collaborative process that involves several experts such as developers, quality assurance engineers, and product managers. These experts are often organized in scrum teams. Many technical writers either are part of a scrum team or closely work with scrum teams. If you are such a technical writer, adapting your writing process to
The process of creating technical documents can differ from company to company or even from one writer to another. However, all variations of the technical documentation process usually involve seven steps: Research Draft Review Revision Repeat 1-4 Prepare for publication Document sign-off Let’s see each step in more detail. 1. Research Any writing process begins
Scrum is a popular project management methodology used by tech companies to manage their product development. The term scrum comes from Rugby where it refers to an ordered formation of players. Similarly, in the workplace, scrum refers to a cross-functional team coming together to achieve a common product goal. Scrum is an agile process, meaning
Software documentation is a specialized branch of technical communication that focuses on telling its users how to use a particular software. Documentation is an essential part of a software product. It is often made available online but it can also be available in a book format. The most familiar form of software documentation is a
This is Part III of a summary of the Federal Plain Language Guidelines (May 2011). Objective of this article is to provide a quick overview of the topics discussed in the Guidelines handbook. The handbook is available for download for free at plainlanguage.gov in PDF and Word formats. See Part I and Part II. Write
This is Part II of a summary of the Federal Plain Language Guidelines (May 2011). Objective of this article is to provide a quick overview of the topics discussed in the Guidelines handbook. The handbook is available for download for free at plainlanguage.gov in PDF and Word formats. See Part I. Document Writing Sentences Write
This is a summary of the Federal Plain Language Guidelines (May 2011). Objective of this article is to provide a quick overview of the topics discussed in the Guidelines handbook. The handbook is available for download for free at plainlanguage.gov in PDF and Word formats. Audience Writing in plain language means writing for your audience
Plain English or plain language means communicating your thoughts and ideas to your audience in a language they can easily understand. Writing in plain language is a law in the US. What is plain English? As the Plain Writing Act of 2010 defines, plain language is “Writing that is clear, concise, well-organized, and follows other
DITA is a well-known concept in the technical communication world. It is a form of computer language used to develop technical content with a focus on reusability. What is DITA? DITA stands for Darwin Information Typing Architecture. It is named after Charles Darwin, the father of the theory of evolution. Evolution plays an important role