Guide to Technical Document Components and Design

manual

A document that provides instructions or guidelines.

troubleshooting guide

A document that helps identify and resolve problems.

glossary

A list of terms and their definitions.

appendix

Supplementary material at the end of a document.

index

An alphabetical list of topics with page references.

description

A detailed account of something.

object description

A specific explanation of an object.

object

A tangible or intangible item.

mechanism

A system of parts working together.

process description

An explanation of a sequence of actions.

process

A series of actions or steps taken to achieve a particular end.

social media

Platforms for social interaction and content sharing.

copy

Text written for publication.

keyword

A significant word or phrase used in search.

search engine optimization (SEO)

The practice of increasing the quantity and quality of traffic to a website.

blog

A regularly updated website or web page.

hashtag

A word or phrase preceded by a hash sign used to categorize content.

report

A structured document presenting information.

formal report

A report that follows a specific structure and style.

informal report

A less structured report that may not follow formal guidelines.

data

Facts and statistics collected for analysis.

qualitative data

Non-numerical information that describes qualities.

quantitative data

Numerical information that can be measured.

primary research

Research conducted firsthand for a specific purpose.

focus group

A diverse group of people assembled to provide feedback.

survey

A method of gathering information from individuals.

representative sampling

A sampling method that accurately reflects the population.

secondary research

Research that involves summarizing existing data.

table of contents

A list of the sections and pages in a document.

executive summary

A brief overview of a document's main points.

conclusion

The final part of a document summarizing findings.

recommendation

A suggested course of action based on findings.

citation

A reference to a source of information.

heading

A title or subtitle in a document.

periodic report

A report that is produced at regular intervals.

progress report

A report detailing the progress of a project.

informal study report

A report that presents findings in a less formal manner.

visual

An image or graphic representation.

visual literacy

The ability to interpret and create visual messages.

table

A structured arrangement of data in rows and columns.

legend

An explanation of symbols used in a visual.

figure

A graphic representation such as a chart or diagram.

infographic

A visual representation of information or data.

illustration

A visual representation that explains or decorates text.

caption

A brief explanation accompanying an illustration.

figure number

A label assigned to a figure for reference.

desktop publishing

The creation of documents using computer software.

visual design

The art of combining text and images effectively.

contrast

The difference between two or more elements.

alignment

The arrangement of elements in relation to each other.

repetition

The use of similar elements throughout a design.

proximity

The closeness of elements in a design.

balance

The distribution of visual weight in a design.

emphasis

The importance placed on certain elements in a design.

harmony

The pleasing arrangement of elements in a design.

variety

The use of different elements to create interest.

proportion

The relationship between elements in terms of size.

symmetry

A balanced and proportionate arrangement of elements.

typography

The art and technique of arranging type.

typeface

A particular design of type.

font

A specific size and style of typeface.

kerning

The adjustment of space between characters in a word.

leading

The vertical space between lines of text.

master page

A template that defines the layout for pages.

style sheet

A set of rules for the appearance of a document.

widow

A single word or short line at the end of a paragraph.

orphan

A single word or short line at the beginning of a paragraph.

technical document

Document that informs or instructs the reader how to use mechanical, technological, or scientific information.