SlideShare a Scribd company logo
1 of 18
Visual FormsVisual Forms
Best practices for usingBest practices for using
visuals in technicalvisuals in technical
writingwriting
Visual FormsVisual Forms
More specific than textMore specific than text
Processed moreProcessed more
easily/quickly than texteasily/quickly than text
Help readers learnHelp readers learn
Visuals ImproveVisuals Improve
Reception/UnderstandingReception/Understanding
Presenter seems prepared,Presenter seems prepared,
credible, persuasivecredible, persuasive
Increase reader interestIncrease reader interest
Help condense informationHelp condense information
Emphasize critical dataEmphasize critical data
Simplify, improve readersSimplify, improve readers
efforts to understand documentefforts to understand document
EthicsEthics
Be careful not to undulyBe careful not to unduly
influence reader’s reactioninfluence reader’s reaction
VERBAL/VISUALVERBAL/VISUAL
COMBINATIONSCOMBINATIONS
Know whenKnow when
Each shouldEach should
make sense onmake sense on
its own but alsoits own but also
to:to:
• illustrateillustrate
• explainexplain
• demonstratedemonstrate
• verifyverify
• supportsupport
Use verbal
and
visual
combinations
Verbal/Visual Combo forVerbal/Visual Combo for
Technical ManualTechnical Manual
Use a verbal table to showUse a verbal table to show
problems with analyses &problems with analyses &
solutions forsolutions for
trouble-shooting sectiontrouble-shooting section
((easier to understand than proseeasier to understand than prose
in paragraphsin paragraphs))
Use of VisualsUse of Visuals
Reader’s understanding ofReader’s understanding of
technical content is limitedtechnical content is limited
Speed is criticalSpeed is critical
Process will be clearerProcess will be clearer
Visual FunctionsVisual Functions
Organize numeric orOrganize numeric or
verbal data (tables,verbal data (tables,
diagrams)diagrams)
Show relationshipsShow relationships
among numeric oramong numeric or
verbal data (tables,verbal data (tables,
graphs, diagrams)graphs, diagrams)
Present chronology,Present chronology,
sequence or processsequence or process
(line graphs, flow(line graphs, flow
charts, org. charts)charts, org. charts)
Define or explainDefine or explain
concepts, objects, andconcepts, objects, and
processes (drawings,processes (drawings,
photos, diagrams)photos, diagrams)
Illustrate appearance orIllustrate appearance or
structure; describestructure; describe
objects/mechanismsobjects/mechanisms
(drawings, photos, maps)(drawings, photos, maps)
Identify facilities orIdentify facilities or
locations (maps, charts,locations (maps, charts,
schematics, andschematics, and
blueprints)blueprints)
Choose Visuals to HelpChoose Visuals to Help
ReadersReaders
Tables –Tables –
displaydisplay
data, identifydata, identify
characteristicscharacteristics
of ideas,of ideas,
objects or aobjects or a
processprocess
Graphs – displayGraphs – display
relationshipsrelationships
between 2 or morebetween 2 or more
types of datatypes of data
Graph Types: Pie,Graph Types: Pie,
Line, Scatter, BarLine, Scatter, Bar
Pictorial –be carefulPictorial –be careful
Charts –Charts –
representrepresent
components,components,
steps orsteps or
chronology ofchronology of
object,object,
mechanism,mechanism,
organism or orgorganism or org
Diagrams –Diagrams –
illustrateillustrate
complexcomplex
physicalphysical
components ofcomponents of
object,object,
mechanism ormechanism or
organismorganism
Drawings –Drawings –
depict actualdepict actual
appearance ofappearance of
object/orgobject/org
(phantom,(phantom,
cutaway,cutaway,
exploded forexploded for
assembly,assembly,
repair)repair)
Maps –Maps –
geographicalgeographical
info,info,
topographic,topographic,
demographic,demographic,
agricultural,agricultural,
meteorological,meteorological,
geological datageological data
Photos – depictPhotos – depict
actualactual
appearance ofappearance of
object, mech orobject, mech or
org (cutouts,org (cutouts,
small arrowssmall arrows
superimposedsuperimposed
to show ato show a
subject insubject in
How will theyHow will they
be viewed?be viewed?
Online?Online?
In bright room?In bright room?
B&W print?B&W print?
0
10
20
30
40
50
60
70
80
90
1st Qtr 2nd Qtr 3rd Qtr 4th Qtr
East
West
North
Multiple Bar Graph groups two or more
bars to present related variables
M a n u a l P ro je c t T e a m
J o h n J o n e s
T e c h n ic a l E d ito r
M a ry R o e
C o m p re h e n s iv e E d ito r
D a v e H a rt
T e x t E d ito r
J o a n S m ith
P ro je c t M a n a g e r
Organizational Chart
shows hierarchy of
project team
Verbal/Visual ChoicesVerbal/Visual Choices
All TextAll Text
Text with visualText with visual
supportsupport
Visual withVisual with
supporting textsupporting text
All visualAll visual
How Many?How Many?
What Tech LevelWhat Tech Level??
Make sure number isMake sure number is
appropriate to audience needappropriate to audience need
and subject matterand subject matter
Adapt to Audience LevelAdapt to Audience Level
• don’t dumb downdon’t dumb down
Conventions in ReferenceConventions in Reference
& Placement& Placement
Refer to in text - include figureRefer to in text - include figure
number and title (embedded ornumber and title (embedded or
parenthetical)parenthetical)
LabelingLabeling
• IdentificationIdentification
• TitleTitle
• CaptionCaption
Conventions of LabelingConventions of Labeling
More than 5 independent from text?More than 5 independent from text?
- Use List of Figures/Tables- Use List of Figures/Tables
Include dimensions of objects/scaleInclude dimensions of objects/scale
Avoid abbreviations or use standardAvoid abbreviations or use standard
ones and include a keyones and include a key
Identify source of data and graphicIdentify source of data and graphic
designerdesigner
Placement of VisualsPlacement of Visuals
Place as close as possiblePlace as close as possible
following the text referencefollowing the text reference
Surround with white space toSurround with white space to
separate from text of documentseparate from text of document
If it covers entire page?If it covers entire page?
• Both-sided doc - place full-page visual onBoth-sided doc - place full-page visual on
facing page (to text & discussion)facing page (to text & discussion)
• One-sided - place on page followingOne-sided - place on page following
Conventions of ColorConventions of Color
Avoid overuse of decorative colorAvoid overuse of decorative color
Avoid too much colorAvoid too much color
Pay attention to culturalPay attention to cultural
expectationsexpectations
Recognize differences in paper colorRecognize differences in paper color
vs. screen colorvs. screen color
Make sure it’s needed and is anMake sure it’s needed and is an
integral part of the info readers needintegral part of the info readers need
Use Standard ConventionsUse Standard Conventions
Place close toPlace close to
text referencetext reference
Accurately labelAccurately label
each visualeach visual
IncludeInclude
completecomplete
dimensions ofdimensions of
objects in eachobjects in each
Use standardUse standard
abbreviationsabbreviations
and a keyand a key
Surround withSurround with
white spacewhite space
Include aInclude a
complete textualcomplete textual
referencereference
Include list ofInclude list of
figures if morefigures if more
than fivethan five
Identify sourceIdentify source
of data andof data and
graphic designergraphic designer
Specify focus orSpecify focus or
interpretationinterpretation
you wantyou want
readers to applyreaders to apply

More Related Content

What's hot

Types of paragraph
Types of paragraphTypes of paragraph
Types of paragraph
Julie Basto
 

What's hot (20)

Describing graph, chart and diagram
Describing graph, chart and diagramDescribing graph, chart and diagram
Describing graph, chart and diagram
 
The Introductory Paragraph
The Introductory ParagraphThe Introductory Paragraph
The Introductory Paragraph
 
3 purposes for writing
3 purposes for writing3 purposes for writing
3 purposes for writing
 
Types of paragraph
Types of paragraphTypes of paragraph
Types of paragraph
 
Power point presentations dos and don’ts
Power point presentations dos and don’tsPower point presentations dos and don’ts
Power point presentations dos and don’ts
 
Visual aids
Visual aidsVisual aids
Visual aids
 
Editing and proofreading
Editing and proofreadingEditing and proofreading
Editing and proofreading
 
skim and scan
 skim and scan skim and scan
skim and scan
 
Fact or opinion
Fact or opinionFact or opinion
Fact or opinion
 
Data Transformation PowerPoint Presentation Slides
Data Transformation PowerPoint Presentation Slides Data Transformation PowerPoint Presentation Slides
Data Transformation PowerPoint Presentation Slides
 
Datavisualization - Embed - Focus + Text
Datavisualization - Embed - Focus + TextDatavisualization - Embed - Focus + Text
Datavisualization - Embed - Focus + Text
 
Argumentative Writing
Argumentative WritingArgumentative Writing
Argumentative Writing
 
Visual aids
Visual aidsVisual aids
Visual aids
 
Writing an Effective Introduction and Conclusion for your Presentation
Writing an Effective Introduction and Conclusion for your PresentationWriting an Effective Introduction and Conclusion for your Presentation
Writing an Effective Introduction and Conclusion for your Presentation
 
Data visualization
Data visualizationData visualization
Data visualization
 
Presentation layout tips
Presentation layout tipsPresentation layout tips
Presentation layout tips
 
Data science & data scientist
Data science & data scientistData science & data scientist
Data science & data scientist
 
Technical Writing: Organisation and drafting of a document
Technical Writing: Organisation and drafting of a documentTechnical Writing: Organisation and drafting of a document
Technical Writing: Organisation and drafting of a document
 
5 Data Visualization Pitfalls
5 Data Visualization Pitfalls5 Data Visualization Pitfalls
5 Data Visualization Pitfalls
 
Data visualization
Data visualizationData visualization
Data visualization
 

Viewers also liked

Section 1 And 2 Classification Slideshow
Section 1 And 2 Classification SlideshowSection 1 And 2 Classification Slideshow
Section 1 And 2 Classification Slideshow
guest7a613a
 
How to present your design to the development team so they build it right
How to present your design to the development team so they build it right How to present your design to the development team so they build it right
How to present your design to the development team so they build it right
Kim Gerona
 
Device Classification (Slideshare)
Device Classification (Slideshare)Device Classification (Slideshare)
Device Classification (Slideshare)
Carlton666
 
Definition problems in definition
Definition   problems in definitionDefinition   problems in definition
Definition problems in definition
Eliécer Díaz
 
Classification of computer
Classification of computerClassification of computer
Classification of computer
Jan Ralph
 
Classification & Division[1]
Classification & Division[1]Classification & Division[1]
Classification & Division[1]
professorgriffith
 
Division and classification
Division and classificationDivision and classification
Division and classification
pernak
 
Techniques of emphasizing in written communication 1
Techniques of emphasizing in written communication 1Techniques of emphasizing in written communication 1
Techniques of emphasizing in written communication 1
arunmutholil1
 
Classification & Division[1]
Classification & Division[1]Classification & Division[1]
Classification & Division[1]
professorgriffith
 

Viewers also liked (20)

Best Practices for Creating Definitions in Technical Writing and Editing
Best Practices for Creating Definitions in Technical Writing and EditingBest Practices for Creating Definitions in Technical Writing and Editing
Best Practices for Creating Definitions in Technical Writing and Editing
 
Section 1 And 2 Classification Slideshow
Section 1 And 2 Classification SlideshowSection 1 And 2 Classification Slideshow
Section 1 And 2 Classification Slideshow
 
How to present your design to the development team so they build it right
How to present your design to the development team so they build it right How to present your design to the development team so they build it right
How to present your design to the development team so they build it right
 
Device Classification (Slideshare)
Device Classification (Slideshare)Device Classification (Slideshare)
Device Classification (Slideshare)
 
Definition problems in definition
Definition   problems in definitionDefinition   problems in definition
Definition problems in definition
 
Classification of computer
Classification of computerClassification of computer
Classification of computer
 
Classification & Division[1]
Classification & Division[1]Classification & Division[1]
Classification & Division[1]
 
Division and classification
Division and classificationDivision and classification
Division and classification
 
Creating a formal sentence definition
Creating a formal sentence definitionCreating a formal sentence definition
Creating a formal sentence definition
 
Techniques of emphasizing in written communication 1
Techniques of emphasizing in written communication 1Techniques of emphasizing in written communication 1
Techniques of emphasizing in written communication 1
 
Classification & Division[1]
Classification & Division[1]Classification & Division[1]
Classification & Division[1]
 
Effective Use Of Visual Aids
Effective Use Of Visual AidsEffective Use Of Visual Aids
Effective Use Of Visual Aids
 
Techniques of Emphasizing in written communication
Techniques of Emphasizing in written communicationTechniques of Emphasizing in written communication
Techniques of Emphasizing in written communication
 
Technical Communication; Definition and Classification
Technical Communication; Definition and ClassificationTechnical Communication; Definition and Classification
Technical Communication; Definition and Classification
 
Classification Paragraph
Classification ParagraphClassification Paragraph
Classification Paragraph
 
Definitions in Technical Writing
Definitions in Technical WritingDefinitions in Technical Writing
Definitions in Technical Writing
 
Types of Storage Devices
Types of Storage DevicesTypes of Storage Devices
Types of Storage Devices
 
Cipr social media guidelines 2013
Cipr social media guidelines 2013Cipr social media guidelines 2013
Cipr social media guidelines 2013
 
Classification of animals
Classification of animalsClassification of animals
Classification of animals
 
Document Design in Technical Writing
Document Design in Technical WritingDocument Design in Technical Writing
Document Design in Technical Writing
 

Similar to Best Practices for Using Visuals in Technical Writing

6. verbal and visual support
6. verbal and visual support6. verbal and visual support
6. verbal and visual support
Yousuf Adil
 
Effective Presentation Skills New01
Effective  Presentation  Skills  New01Effective  Presentation  Skills  New01
Effective Presentation Skills New01
Alaa Sadik
 
1. Add interview methods assume you are asking 2 people questions..docx
1. Add interview methods assume you are asking 2 people questions..docx1. Add interview methods assume you are asking 2 people questions..docx
1. Add interview methods assume you are asking 2 people questions..docx
SONU61709
 
WritingProcessForBusinessAnalysis-Guide
WritingProcessForBusinessAnalysis-GuideWritingProcessForBusinessAnalysis-Guide
WritingProcessForBusinessAnalysis-Guide
Jas Mahay
 
53.staticimage(3.6) 3
53.staticimage(3.6) 353.staticimage(3.6) 3
53.staticimage(3.6) 3
Linda Rubens
 
Textstructures 140205132119-phpapp02
Textstructures 140205132119-phpapp02Textstructures 140205132119-phpapp02
Textstructures 140205132119-phpapp02
Kourtney Moscarello
 
Report Writing Guide
Report  Writing GuideReport  Writing Guide
Report Writing Guide
guest74f577
 
Yuva ppt how to presnt
Yuva ppt how to presntYuva ppt how to presnt
Yuva ppt how to presnt
Yuvarajan Siva
 
Characteristics of technical_writing
Characteristics of technical_writingCharacteristics of technical_writing
Characteristics of technical_writing
Ann Castillo
 

Similar to Best Practices for Using Visuals in Technical Writing (20)

types-of-oral-communication.ppt
types-of-oral-communication.ppttypes-of-oral-communication.ppt
types-of-oral-communication.ppt
 
Gcse evidence research steps assgmt1
Gcse evidence research steps assgmt1Gcse evidence research steps assgmt1
Gcse evidence research steps assgmt1
 
20080626012119_727.ppt
20080626012119_727.ppt20080626012119_727.ppt
20080626012119_727.ppt
 
Effective Presentation Skills
Effective Presentation SkillsEffective Presentation Skills
Effective Presentation Skills
 
6. verbal and visual support
6. verbal and visual support6. verbal and visual support
6. verbal and visual support
 
Effective Presentation Skills New01
Effective  Presentation  Skills  New01Effective  Presentation  Skills  New01
Effective Presentation Skills New01
 
Educational Technology Graphic/Audio Visual Materials
Educational Technology Graphic/Audio Visual MaterialsEducational Technology Graphic/Audio Visual Materials
Educational Technology Graphic/Audio Visual Materials
 
Creating and discussing visual aids
Creating and discussing visual aidsCreating and discussing visual aids
Creating and discussing visual aids
 
Best communication design practices when using “Shape Tools” for visual prese...
Best communication design practices when using “Shape Tools” for visual prese...Best communication design practices when using “Shape Tools” for visual prese...
Best communication design practices when using “Shape Tools” for visual prese...
 
Write with PowerPoint-Purdue Lab
Write with PowerPoint-Purdue LabWrite with PowerPoint-Purdue Lab
Write with PowerPoint-Purdue Lab
 
Multimedia design principles
Multimedia design principlesMultimedia design principles
Multimedia design principles
 
1. Add interview methods assume you are asking 2 people questions..docx
1. Add interview methods assume you are asking 2 people questions..docx1. Add interview methods assume you are asking 2 people questions..docx
1. Add interview methods assume you are asking 2 people questions..docx
 
WritingProcessForBusinessAnalysis-Guide
WritingProcessForBusinessAnalysis-GuideWritingProcessForBusinessAnalysis-Guide
WritingProcessForBusinessAnalysis-Guide
 
53.staticimage(3.6) 3
53.staticimage(3.6) 353.staticimage(3.6) 3
53.staticimage(3.6) 3
 
An effective poster is camera of your work
An effective poster is camera of your workAn effective poster is camera of your work
An effective poster is camera of your work
 
Visual Principles
Visual PrinciplesVisual Principles
Visual Principles
 
Textstructures 140205132119-phpapp02
Textstructures 140205132119-phpapp02Textstructures 140205132119-phpapp02
Textstructures 140205132119-phpapp02
 
Report Writing Guide
Report  Writing GuideReport  Writing Guide
Report Writing Guide
 
Yuva ppt how to presnt
Yuva ppt how to presntYuva ppt how to presnt
Yuva ppt how to presnt
 
Characteristics of technical_writing
Characteristics of technical_writingCharacteristics of technical_writing
Characteristics of technical_writing
 

More from The Integral Worm

More from The Integral Worm (17)

Artificial Intelligence: Artificial Neural Networks
Artificial Intelligence: Artificial Neural NetworksArtificial Intelligence: Artificial Neural Networks
Artificial Intelligence: Artificial Neural Networks
 
Artificial Intelligence: Data Mining
Artificial Intelligence: Data MiningArtificial Intelligence: Data Mining
Artificial Intelligence: Data Mining
 
Artificial Intelligence: Agent Technology
Artificial Intelligence: Agent TechnologyArtificial Intelligence: Agent Technology
Artificial Intelligence: Agent Technology
 
Artificial Intelligence: Case-based & Model-based Reasoning
Artificial Intelligence: Case-based & Model-based ReasoningArtificial Intelligence: Case-based & Model-based Reasoning
Artificial Intelligence: Case-based & Model-based Reasoning
 
Artificial Intelligence: Knowledge Acquisition
Artificial Intelligence: Knowledge AcquisitionArtificial Intelligence: Knowledge Acquisition
Artificial Intelligence: Knowledge Acquisition
 
Artificial Intelligence: The Nine Phases of the Expert System Development Lif...
Artificial Intelligence: The Nine Phases of the Expert System Development Lif...Artificial Intelligence: The Nine Phases of the Expert System Development Lif...
Artificial Intelligence: The Nine Phases of the Expert System Development Lif...
 
Artificial Intelligence: Knowledge Engineering
Artificial Intelligence: Knowledge EngineeringArtificial Intelligence: Knowledge Engineering
Artificial Intelligence: Knowledge Engineering
 
Artificial Intelligence: Expert Systems Components
Artificial Intelligence: Expert Systems ComponentsArtificial Intelligence: Expert Systems Components
Artificial Intelligence: Expert Systems Components
 
Best Practices for Effective Written Correspondence
Best Practices for Effective Written CorrespondenceBest Practices for Effective Written Correspondence
Best Practices for Effective Written Correspondence
 
Ethical Considerations in Technical Writing and the Workplace
Ethical Considerations in Technical Writing and the WorkplaceEthical Considerations in Technical Writing and the Workplace
Ethical Considerations in Technical Writing and the Workplace
 
Best Practices and Guidelines for Collaboration in Workplace Communications
Best Practices and Guidelines for Collaboration in Workplace CommunicationsBest Practices and Guidelines for Collaboration in Workplace Communications
Best Practices and Guidelines for Collaboration in Workplace Communications
 
Best Practices and Guidelines for Writing Analytical Reports
Best Practices and Guidelines for Writing Analytical ReportsBest Practices and Guidelines for Writing Analytical Reports
Best Practices and Guidelines for Writing Analytical Reports
 
Best Practices for Writing and Editing User/Instruction Manuals
Best Practices for Writing and Editing User/Instruction ManualsBest Practices for Writing and Editing User/Instruction Manuals
Best Practices for Writing and Editing User/Instruction Manuals
 
The Good, the bad, and the ugly of Thin Client/Server Computing
The Good, the bad, and the ugly of Thin Client/Server ComputingThe Good, the bad, and the ugly of Thin Client/Server Computing
The Good, the bad, and the ugly of Thin Client/Server Computing
 
Legal Aspects of Information Systems: State of Maryland vs. CyberSmoke.
Legal Aspects of Information Systems: State of Maryland vs. CyberSmoke.Legal Aspects of Information Systems: State of Maryland vs. CyberSmoke.
Legal Aspects of Information Systems: State of Maryland vs. CyberSmoke.
 
The Test Subject Simulation of the "Cyberpeople Jack Implant" Artifact
The Test Subject Simulation of the "Cyberpeople Jack Implant" ArtifactThe Test Subject Simulation of the "Cyberpeople Jack Implant" Artifact
The Test Subject Simulation of the "Cyberpeople Jack Implant" Artifact
 
UMBC IFSM438 Project Management Group Presentation
UMBC IFSM438 Project Management Group PresentationUMBC IFSM438 Project Management Group Presentation
UMBC IFSM438 Project Management Group Presentation
 

Recently uploaded

Artificial Intelligence: Facts and Myths
Artificial Intelligence: Facts and MythsArtificial Intelligence: Facts and Myths
Artificial Intelligence: Facts and Myths
Joaquim Jorge
 

Recently uploaded (20)

Scaling API-first – The story of a global engineering organization
Scaling API-first – The story of a global engineering organizationScaling API-first – The story of a global engineering organization
Scaling API-first – The story of a global engineering organization
 
Developing An App To Navigate The Roads of Brazil
Developing An App To Navigate The Roads of BrazilDeveloping An App To Navigate The Roads of Brazil
Developing An App To Navigate The Roads of Brazil
 
Strategies for Landing an Oracle DBA Job as a Fresher
Strategies for Landing an Oracle DBA Job as a FresherStrategies for Landing an Oracle DBA Job as a Fresher
Strategies for Landing an Oracle DBA Job as a Fresher
 
Automating Google Workspace (GWS) & more with Apps Script
Automating Google Workspace (GWS) & more with Apps ScriptAutomating Google Workspace (GWS) & more with Apps Script
Automating Google Workspace (GWS) & more with Apps Script
 
Tech Trends Report 2024 Future Today Institute.pdf
Tech Trends Report 2024 Future Today Institute.pdfTech Trends Report 2024 Future Today Institute.pdf
Tech Trends Report 2024 Future Today Institute.pdf
 
Mastering MySQL Database Architecture: Deep Dive into MySQL Shell and MySQL R...
Mastering MySQL Database Architecture: Deep Dive into MySQL Shell and MySQL R...Mastering MySQL Database Architecture: Deep Dive into MySQL Shell and MySQL R...
Mastering MySQL Database Architecture: Deep Dive into MySQL Shell and MySQL R...
 
Tata AIG General Insurance Company - Insurer Innovation Award 2024
Tata AIG General Insurance Company - Insurer Innovation Award 2024Tata AIG General Insurance Company - Insurer Innovation Award 2024
Tata AIG General Insurance Company - Insurer Innovation Award 2024
 
🐬 The future of MySQL is Postgres 🐘
🐬  The future of MySQL is Postgres   🐘🐬  The future of MySQL is Postgres   🐘
🐬 The future of MySQL is Postgres 🐘
 
Real Time Object Detection Using Open CV
Real Time Object Detection Using Open CVReal Time Object Detection Using Open CV
Real Time Object Detection Using Open CV
 
Workshop - Best of Both Worlds_ Combine KG and Vector search for enhanced R...
Workshop - Best of Both Worlds_ Combine  KG and Vector search for  enhanced R...Workshop - Best of Both Worlds_ Combine  KG and Vector search for  enhanced R...
Workshop - Best of Both Worlds_ Combine KG and Vector search for enhanced R...
 
Finology Group – Insurtech Innovation Award 2024
Finology Group – Insurtech Innovation Award 2024Finology Group – Insurtech Innovation Award 2024
Finology Group – Insurtech Innovation Award 2024
 
How to Troubleshoot Apps for the Modern Connected Worker
How to Troubleshoot Apps for the Modern Connected WorkerHow to Troubleshoot Apps for the Modern Connected Worker
How to Troubleshoot Apps for the Modern Connected Worker
 
Understanding Discord NSFW Servers A Guide for Responsible Users.pdf
Understanding Discord NSFW Servers A Guide for Responsible Users.pdfUnderstanding Discord NSFW Servers A Guide for Responsible Users.pdf
Understanding Discord NSFW Servers A Guide for Responsible Users.pdf
 
Apidays New York 2024 - The value of a flexible API Management solution for O...
Apidays New York 2024 - The value of a flexible API Management solution for O...Apidays New York 2024 - The value of a flexible API Management solution for O...
Apidays New York 2024 - The value of a flexible API Management solution for O...
 
presentation ICT roal in 21st century education
presentation ICT roal in 21st century educationpresentation ICT roal in 21st century education
presentation ICT roal in 21st century education
 
TrustArc Webinar - Unlock the Power of AI-Driven Data Discovery
TrustArc Webinar - Unlock the Power of AI-Driven Data DiscoveryTrustArc Webinar - Unlock the Power of AI-Driven Data Discovery
TrustArc Webinar - Unlock the Power of AI-Driven Data Discovery
 
2024: Domino Containers - The Next Step. News from the Domino Container commu...
2024: Domino Containers - The Next Step. News from the Domino Container commu...2024: Domino Containers - The Next Step. News from the Domino Container commu...
2024: Domino Containers - The Next Step. News from the Domino Container commu...
 
Artificial Intelligence: Facts and Myths
Artificial Intelligence: Facts and MythsArtificial Intelligence: Facts and Myths
Artificial Intelligence: Facts and Myths
 
04-2024-HHUG-Sales-and-Marketing-Alignment.pptx
04-2024-HHUG-Sales-and-Marketing-Alignment.pptx04-2024-HHUG-Sales-and-Marketing-Alignment.pptx
04-2024-HHUG-Sales-and-Marketing-Alignment.pptx
 
Boost PC performance: How more available memory can improve productivity
Boost PC performance: How more available memory can improve productivityBoost PC performance: How more available memory can improve productivity
Boost PC performance: How more available memory can improve productivity
 

Best Practices for Using Visuals in Technical Writing

  • 1. Visual FormsVisual Forms Best practices for usingBest practices for using visuals in technicalvisuals in technical writingwriting
  • 2. Visual FormsVisual Forms More specific than textMore specific than text Processed moreProcessed more easily/quickly than texteasily/quickly than text Help readers learnHelp readers learn
  • 3. Visuals ImproveVisuals Improve Reception/UnderstandingReception/Understanding Presenter seems prepared,Presenter seems prepared, credible, persuasivecredible, persuasive Increase reader interestIncrease reader interest Help condense informationHelp condense information Emphasize critical dataEmphasize critical data Simplify, improve readersSimplify, improve readers efforts to understand documentefforts to understand document
  • 4. EthicsEthics Be careful not to undulyBe careful not to unduly influence reader’s reactioninfluence reader’s reaction
  • 5. VERBAL/VISUALVERBAL/VISUAL COMBINATIONSCOMBINATIONS Know whenKnow when Each shouldEach should make sense onmake sense on its own but alsoits own but also to:to: • illustrateillustrate • explainexplain • demonstratedemonstrate • verifyverify • supportsupport Use verbal and visual combinations
  • 6. Verbal/Visual Combo forVerbal/Visual Combo for Technical ManualTechnical Manual Use a verbal table to showUse a verbal table to show problems with analyses &problems with analyses & solutions forsolutions for trouble-shooting sectiontrouble-shooting section ((easier to understand than proseeasier to understand than prose in paragraphsin paragraphs))
  • 7. Use of VisualsUse of Visuals Reader’s understanding ofReader’s understanding of technical content is limitedtechnical content is limited Speed is criticalSpeed is critical Process will be clearerProcess will be clearer
  • 8. Visual FunctionsVisual Functions Organize numeric orOrganize numeric or verbal data (tables,verbal data (tables, diagrams)diagrams) Show relationshipsShow relationships among numeric oramong numeric or verbal data (tables,verbal data (tables, graphs, diagrams)graphs, diagrams) Present chronology,Present chronology, sequence or processsequence or process (line graphs, flow(line graphs, flow charts, org. charts)charts, org. charts) Define or explainDefine or explain concepts, objects, andconcepts, objects, and processes (drawings,processes (drawings, photos, diagrams)photos, diagrams) Illustrate appearance orIllustrate appearance or structure; describestructure; describe objects/mechanismsobjects/mechanisms (drawings, photos, maps)(drawings, photos, maps) Identify facilities orIdentify facilities or locations (maps, charts,locations (maps, charts, schematics, andschematics, and blueprints)blueprints)
  • 9. Choose Visuals to HelpChoose Visuals to Help ReadersReaders Tables –Tables – displaydisplay data, identifydata, identify characteristicscharacteristics of ideas,of ideas, objects or aobjects or a processprocess Graphs – displayGraphs – display relationshipsrelationships between 2 or morebetween 2 or more types of datatypes of data Graph Types: Pie,Graph Types: Pie, Line, Scatter, BarLine, Scatter, Bar Pictorial –be carefulPictorial –be careful Charts –Charts – representrepresent components,components, steps orsteps or chronology ofchronology of object,object, mechanism,mechanism, organism or orgorganism or org Diagrams –Diagrams – illustrateillustrate complexcomplex physicalphysical components ofcomponents of object,object, mechanism ormechanism or organismorganism Drawings –Drawings – depict actualdepict actual appearance ofappearance of object/orgobject/org (phantom,(phantom, cutaway,cutaway, exploded forexploded for assembly,assembly, repair)repair) Maps –Maps – geographicalgeographical info,info, topographic,topographic, demographic,demographic, agricultural,agricultural, meteorological,meteorological, geological datageological data Photos – depictPhotos – depict actualactual appearance ofappearance of object, mech orobject, mech or org (cutouts,org (cutouts, small arrowssmall arrows superimposedsuperimposed to show ato show a subject insubject in How will theyHow will they be viewed?be viewed? Online?Online? In bright room?In bright room? B&W print?B&W print?
  • 10. 0 10 20 30 40 50 60 70 80 90 1st Qtr 2nd Qtr 3rd Qtr 4th Qtr East West North Multiple Bar Graph groups two or more bars to present related variables
  • 11. M a n u a l P ro je c t T e a m J o h n J o n e s T e c h n ic a l E d ito r M a ry R o e C o m p re h e n s iv e E d ito r D a v e H a rt T e x t E d ito r J o a n S m ith P ro je c t M a n a g e r Organizational Chart shows hierarchy of project team
  • 12. Verbal/Visual ChoicesVerbal/Visual Choices All TextAll Text Text with visualText with visual supportsupport Visual withVisual with supporting textsupporting text All visualAll visual
  • 13. How Many?How Many? What Tech LevelWhat Tech Level?? Make sure number isMake sure number is appropriate to audience needappropriate to audience need and subject matterand subject matter Adapt to Audience LevelAdapt to Audience Level • don’t dumb downdon’t dumb down
  • 14. Conventions in ReferenceConventions in Reference & Placement& Placement Refer to in text - include figureRefer to in text - include figure number and title (embedded ornumber and title (embedded or parenthetical)parenthetical) LabelingLabeling • IdentificationIdentification • TitleTitle • CaptionCaption
  • 15. Conventions of LabelingConventions of Labeling More than 5 independent from text?More than 5 independent from text? - Use List of Figures/Tables- Use List of Figures/Tables Include dimensions of objects/scaleInclude dimensions of objects/scale Avoid abbreviations or use standardAvoid abbreviations or use standard ones and include a keyones and include a key Identify source of data and graphicIdentify source of data and graphic designerdesigner
  • 16. Placement of VisualsPlacement of Visuals Place as close as possiblePlace as close as possible following the text referencefollowing the text reference Surround with white space toSurround with white space to separate from text of documentseparate from text of document If it covers entire page?If it covers entire page? • Both-sided doc - place full-page visual onBoth-sided doc - place full-page visual on facing page (to text & discussion)facing page (to text & discussion) • One-sided - place on page followingOne-sided - place on page following
  • 17. Conventions of ColorConventions of Color Avoid overuse of decorative colorAvoid overuse of decorative color Avoid too much colorAvoid too much color Pay attention to culturalPay attention to cultural expectationsexpectations Recognize differences in paper colorRecognize differences in paper color vs. screen colorvs. screen color Make sure it’s needed and is anMake sure it’s needed and is an integral part of the info readers needintegral part of the info readers need
  • 18. Use Standard ConventionsUse Standard Conventions Place close toPlace close to text referencetext reference Accurately labelAccurately label each visualeach visual IncludeInclude completecomplete dimensions ofdimensions of objects in eachobjects in each Use standardUse standard abbreviationsabbreviations and a keyand a key Surround withSurround with white spacewhite space Include aInclude a complete textualcomplete textual referencereference Include list ofInclude list of figures if morefigures if more than fivethan five Identify sourceIdentify source of data andof data and graphic designergraphic designer Specify focus orSpecify focus or interpretationinterpretation you wantyou want readers to applyreaders to apply