Ad
related to: technical writing definition and description for kids examples
Search results
Results From The WOW.Com Content Network
Technical writing is most commonly performed by a trained technical writer and the content they produce is the result of a well-defined process. Technical writers follow strict guidelines so the technical information they share appears in a single, popularly used and standardized format and style (e.g., DITA, markdown format, AP Stylebook, Chicago Manual of Style).
A technical writer may apply their skills in the production of non-technical content, for example, writing high-level consumer information. Usually, a technical writer is not a subject-matter expert (SME), but interviews SMEs and conducts the research necessary to write and compile technically accurate content.
Technical communication (or Tech Comm) is communication of technical subject matter such as engineering, science, or technology content. The largest part of it tends to be technical writing, though importantly it often requires aspects of visual communication (which in turn sometimes entails technical drawing, requiring more specialized training).
Topic-based authoring is popular in the technical publications and documentation arenas, as it is especially suitable for technical documentation. Tools supporting this approach typically store content in XHTML or other XML formats and support content reuse , management , and the dynamic assembly of personalized information.
Consider the examples presented below. There are three basic markups used to make technical terms stand out; these are italic (in typography also termed oblique with regard to sans-serif fonts), bold, and bold italic. The following uses of these styles are recommended for technical articles: Italic (edited as ''italic'') is used for:
Often, summarizing highly technical details can improve the readability of the text for general readers and experts alike. For example, a long-winded mathematical proof is unlikely to be read by either a general reader or an expert, but a short summary of the proof can inform a general reader without reducing the usefulness to an expert reader.
A technical definition is a definition in technical communication describing or explaining technical terminology. Technical definitions are used to introduce the vocabulary which makes communication in a particular field succinct and unambiguous. For example, the iliac crest from medical terminology is the top ridge of the hip bone (see ).
Concept information is more objective, containing definitions, rules, and guidelines. A Reference topic is for topics that describe command syntax, programming instructions, and other reference material, and usually contains detailed, factual material. A Glossary Entry topic is used for defining a single sense of a given term. In addition to ...