Here we provide definitions of terms which are used in writing for the web.
Common Definitions Within the Technical Communication Field
Alignment - Is a design principle which negate arbitrary placement. Every element should have some visual connection with another element on the page. This creates a clean and sophisticated look to the document.
Bleeds- any text or graphic which extends to the border of the page it is printed on. Bleeds are most commonly used to create tabs in bound documents as they remain slightly visible when the pages are closed.
Bullet- a heavy dot, box, circle, or triangle that calls attention to important point within a document.
Callout- is text and a line that points to an area on a graphic.
Contrast - Contrast is the difference between adjacent densities. (i.e: black and white is high contrast). Technical writer's use this design principle to enhance the visual appeal of a graphic. Text which has high contrast such a white text with a black background would be more visually appealing than text with low contrast such as purple text and green background.
Cautions and Warnings- these are typically inserted within a document to highlight areas where the user needs to exercise caution to avoid damaging a product, losing data, or compromising the performance of of the system.
Columns- In document design columns are vertical areas reserved for text. Most document carry anywhere from 1-3 columns.
Cuing system- refers to a pattern used by the editor to signal a specific type of information. For, example an author could use bold face text for numbered sequences or menu commands. When you see a word in bold you know it is a numbered sequence or menu command.
Footer- similiar to headers, but are on the bottom of the body text, footer text is separate from the document text and typically indicates a title, heading, or page number depending on the selected style (MLA, CHS, APA).
Gutter- a space between columns; also, the page mark on the inside binding edge.
Hypertext- a method of organization in which objects, text, or programs can be linked to one another. When you select an object you can see all others associated with the original hypertext.
Headers- In document design headers are one or more lines of text that appear at the top of the page before the body text. This text is separate from the document text and typically indicates a title or heading depending on the selected style (MLA, CHS, APA).
HTML-short for "hyper text mark-up language" is part of the the design of a webpage in which the structure is designed according to layout patterns such as,
<HTML><HEAD>(enter here what document is about)<BODY>.
Icon- a small picture designed to represent a object or program. Icons also represent specific functions available within a program. For example, the trash icon seen on most desktops indicates a place for discarding objects.
Margins- In text documents margins are the white space surrounding the text of a document. Many word-processors allow you to control these width and heights according to your design purposes.
Pagination- refers to numbering pages in a document. Most word processors automatically paginate documents in accordance with your page settings.
Proximity - Is a design principle which focuses on placing like items in groups. Placing several items in close proximity to each other creates one cohesive unit rather than a few separate units.
Repetition - Is a design principle used by technical writers that enforces the repetition of colors, shapes, textures, spatial relationships, line thickness, fonts, sizes, graphic concepts, etc.
Rules- In document design rules are lines of varying width and length that are designed to separate columns of text, page information, or illustrations.
Reference level documentation- a specific type of documentation designed to provide the user with a piece of information needed to perform a certain task. The main purpose of this type of documentation is to provide the necessary data the user needs to perform a task.
Screen Shot- These are a type of image created by the editor which shows the actual user interface. These type of images are very useful in describing specific processes, they also provide benchmarks for the user to evaluate their progress within the documentation.
Tables- tables are typically inserted into documentation to allow the presentation of large amounts of data in and organized and efficient manner. Tables are also used for quick reference or statistical analysis.
Tags- are words or phrases inserted into a computer program that relate to specific help topics. When the user calls for help within the program, the program reads the tags and presents the appropriate topic to the user as a help screen.
Teaching level documentation- a specific type of documentation designed to instill knowledge of how to perform a certain process or modality. After the user completes this type of documentation they should be able to repeat the task from memory.
Technical Writer - Is an individual who writes, documents, or record technical data from various field such as medical, engineering, aviation, science, and technology. The primary job of the technical writer is to present the final document in a manner which is not only technically accurate, but also visually appealing.
Notes and Tips- these are inserted into document's to provide alternatives, work arounds, or helpful applications to the users process.
Notational conventions- are a method by which authors communicate to the user. These conventions relate to how terms, commands, menus, and often interface elements appear in a manual. For example, manuals often use italics to denote for command functions within the document.
Wiki - Is a website developed collaboratively by a community of users. Anyone using the Wiki can openly edit and comment on posts, discussion threads, and topics.
Characteristics of Effective Technical Writing
Clarity- easily understood by audience Accuracy- factual, correct, free from bias Comprehensiveness- all necessary information included Accessibility- headings, indexes, table of contents Conciseness- clear without excess verbiage Correctness- grammatical and follows conventions
Technical writing is taking technical information and making it understandable to non technical people.
Types of Technical writing:
Legal
Medical
Scientific
Mechanical
Business
Expository
Most common uses of technical communication are to create:
Definitions
Here we provide definitions of terms which are used in writing for the web.Common Definitions Within the Technical Communication Field
Alignment - Is a design principle which negate arbitrary placement. Every element should have some visual connection with another element on the page. This creates a clean and sophisticated look to the document.
Bleeds- any text or graphic which extends to the border of the page it is printed on. Bleeds are most commonly used to create tabs in bound documents as they remain slightly visible when the pages are closed.
Bullet- a heavy dot, box, circle, or triangle that calls attention to important point within a document.
Callout- is text and a line that points to an area on a graphic.
Contrast - Contrast is the difference between adjacent densities. (i.e: black and white is high contrast). Technical writer's use this design principle to enhance the visual appeal of a graphic. Text which has high contrast such a white text with a black background would be more visually appealing than text with low contrast such as purple text and green background.
Cautions and Warnings- these are typically inserted within a document to highlight areas where the user needs to exercise caution to avoid damaging a product, losing data, or compromising the performance of of the system.
Columns- In document design columns are vertical areas reserved for text. Most document carry anywhere from 1-3 columns.
Cuing system- refers to a pattern used by the editor to signal a specific type of information. For, example an author could use bold face text for numbered sequences or menu commands. When you see a word in bold you know it is a numbered sequence or menu command.
Footer- similiar to headers, but are on the bottom of the body text, footer text is separate from the document text and typically indicates a title, heading, or page number depending on the selected style (MLA, CHS, APA).
Gutter- a space between columns; also, the page mark on the inside binding edge.
Hypertext- a method of organization in which objects, text, or programs can be linked to one another. When you select an object you can see all others associated with the original hypertext.
Headers- In document design headers are one or more lines of text that appear at the top of the page before the body text. This text is separate from the document text and typically indicates a title or heading depending on the selected style (MLA, CHS, APA).
HTML-short for "hyper text mark-up language" is part of the the design of a webpage in which the structure is designed according to layout patterns such as,
<HTML><HEAD>(enter here what document is about)<BODY>.
Icon- a small picture designed to represent a object or program. Icons also represent specific functions available within a program. For example, the trash icon seen on most desktops indicates a place for discarding objects.
Margins- In text documents margins are the white space surrounding the text of a document. Many word-processors allow you to control these width and heights according to your design purposes.
Pagination- refers to numbering pages in a document. Most word processors automatically paginate documents in accordance with your page settings.
Proximity - Is a design principle which focuses on placing like items in groups. Placing several items in close proximity to each other creates one cohesive unit rather than a few separate units.
Repetition - Is a design principle used by technical writers that enforces the repetition of colors, shapes, textures, spatial relationships, line thickness, fonts, sizes, graphic concepts, etc.
Rules- In document design rules are lines of varying width and length that are designed to separate columns of text, page information, or illustrations.
Reference level documentation- a specific type of documentation designed to provide the user with a piece of information needed to perform a certain task. The main purpose of this type of documentation is to provide the necessary data the user needs to perform a task.
Screen Shot- These are a type of image created by the editor which shows the actual user interface. These type of images are very useful in describing specific processes, they also provide benchmarks for the user to evaluate their progress within the documentation.
Tables- tables are typically inserted into documentation to allow the presentation of large amounts of data in and organized and efficient manner. Tables are also used for quick reference or statistical analysis.
Tags- are words or phrases inserted into a computer program that relate to specific help topics. When the user calls for help within the program, the program reads the tags and presents the appropriate topic to the user as a help screen.
Teaching level documentation- a specific type of documentation designed to instill knowledge of how to perform a certain process or modality. After the user completes this type of documentation they should be able to repeat the task from memory.
Technical Writer - Is an individual who writes, documents, or record technical data from various field such as medical, engineering, aviation, science, and technology. The primary job of the technical writer is to present the final document in a manner which is not only technically accurate, but also visually appealing.
Notes and Tips- these are inserted into document's to provide alternatives, work arounds, or helpful applications to the users process.
Notational conventions- are a method by which authors communicate to the user. These conventions relate to how terms, commands, menus, and often interface elements appear in a manual. For example, manuals often use italics to denote for command functions within the document.
Wiki - Is a website developed collaboratively by a community of users. Anyone using the Wiki can openly edit and comment on posts, discussion threads, and topics.
Characteristics of Effective Technical Writing
Clarity- easily understood by audience
Accuracy- factual, correct, free from bias
Comprehensiveness- all necessary information included
Accessibility- headings, indexes, table of contents
Conciseness- clear without excess verbiage
Correctness- grammatical and follows conventions
Technical writing is taking technical information and making it understandable to non technical people.
Types of Technical writing:
Most common uses of technical communication are to create:
For more information: A Write Writing