From The Art and Popular Culture Encyclopedia

Revision as of 14:57, 2 February 2013 Jahsonic (Talk | contribs) ← Previous diff		Current revision Jahsonic (Talk | contribs)
Line 1:		Line 1:
-	{{Template}}	+	#redirect[[Technical writer]]
-	'''Technical writing''' is a form of [[technical communication]] used in a variety of technical and occupational fields, such as [[computer hardware]] and [[software]], [[engineering]], [[chemistry]], [[aeronautics]] and [[astronautics]], [[robotics]], [[finance]], [[consumer electronics]], and [[biotechnology]].	+
-		+
-	The [[Society for Technical Communication]] (STC) defines technical writing as a broad field including any form of communication that exhibits one or more of the following characteristics: (1) communicating about technical or specialized topics, such as computer applications, medical procedures, or environmental regulations; (2) communicating through technology, such as web pages, help files, or [[social media]] sites; or (3) providing instructions about [[How-to|how to do something]], regardless of the task's technical nature.	+
-		+
-	==Overview==	+
-	Technical writing involves the creation of useful documents that can be clearly understood by readers. Good technical writing clarifies [[jargon]], presenting useful information that is clear and easy to understand for the intended audience; poor technical writing may increase confusion by creating unnecessary jargon or failing to explain it.	+
-		+
-	Technical writing is performed by [[technical writer]]s, who may be [[professional]]s or [[amateur]]s. These writers usually begin such work by learning the purpose of the document that they will create, gathering information from existing documentation and from [[subject-matter expert]]s; technical writers need not be subject-matter experts themselves. A good technical writer needs strong language and teaching skills and must understand how to communicate with technology. Advanced technical writers often move into specialized areas such as [[API writer|API writing]], [[document architecture]], or [[information management]].	+
-		+
-	Technical writing is often associated with [[online help]] and [[User guide|user manuals]]. It also includes product [[release notes]], product [[troubleshooting]] guides, tutorials, installation guides, [[marketing]] documentation, [[e-learning]] modules, web content, legal [[disclaimer]]s, [[proposal (business)|business proposals]], and [[white paper]]s.	+
-		+
-	==History==	+
-	While the origins of technical writing can be traced back to [[Classical antiquity|antiquity]], [[Geoffrey Chaucer]]'s ''[[Treatise on the Astrolabe]]'' has been called the first piece of technical writing in English.	+
-		+
-	Technical writing began to be seen as a discipline in and of itself around the time of [[World War I]], growing out of the need for technology-based documentation in the [[military]], manufacturing, electronics, and aerospace industries. In 1953, two organizations concerned with improving the practice of technical communication were founded in the [[United States]]: the Society of Technical Writers, and the Association of Technical Writers and Editors. These organizations merged in 1957 to form the Society of Technical Writers and Editors, a predecessor of the current [[Society for Technical Communication]].	+
-		+
-	==Techniques==	+
-	Technical writing involves analysis of a document's intended audience in order to translate complex technical concepts and instructions into a series of comprehensible steps that enable users to perform a specific task in a specific way. To present appropriate information, writers must understand the audience and their goals. For example, an audience of highly trained scientists will require less explanation of technical terms than a help guide intended for general audiences.	+
-		+
-	The writing also seeks to present an attractive layout for easy reading and comprehension. A writer must understand the medium typically used to view the final product. An [[HTML]] document, such as a [[web page]], frequently has a different layout than a print document. The use of elements such as [[hyperlink]]s and animation will affect the content and form of the writing.	+
-		+
-	==Technical documents==	+
-	Broadly speaking, technical documentation can be categorized into three types, depending on the style of writing, the level of knowledge transferred, and the target audience:	+
-	#'''End-user assistance''' documents help a user understand a software or hardware product. This includes [[User guide|user manuals]] for computer programs, household products, medical equipment, [[mobile phone]]s, and other consumer electronics.	+
-	#'''Traditional technical documentation''' communicates to a specialized audience. Such documentation includes maintenance guides, repair manuals, engineering specifications, research papers, reference works, annual reports, and articles for technical journals.	+
-	#'''Marketing communication''' such as product catalogs, brochures, [[Advertising|advertisements]], introductory pages for web sites, and [[press release]]s are sometimes created by technical writers.	+
-		+
-	==Associations==	+
-	Professional associations for technical writing include:	+
-	*[[Association for Business Communication]]	+
-	*[[CSVTK|Czech Society for Technical Communication]]	+
-	*[[IEEE Professional Communication Society]]	+
-	*[[Institute of Scientific and Technical Communicators]]	+
-	*[[SIGDOC]] Special Interest Group on Design of Communication	+
-	*[[Society for Technical Communication]]	+
-	*[[Tekom]]	+
-		+
-	==See also==	+
-	*[[Creative nonfiction]]	+
-	*[[Editing]]	+
-	*[[Instructional design]]	+
-		+
-		+
-	{{GFDL}}	+

---

Current revision

1. redirectTechnical writer