Best Practices for Using Visuals in Technical WritingThe Integral Worm
This presentation outlines industry best practices for using visuals in technical writing. Appropriate visuals should be used only as needed to aid the user in understanding of the task at hand. Visuals are more specific, reduce processing time, and are more quickly understood than text. Visuals should make sense standing alone but also may be used to illustrate, explain, demonstrate, verify, and/or provide support. Use a verbal table to show problems with analyses and solutions for a trouble-shooting section. Visuals are easier to understand than prose in paragraphs. “A picture is worth a 1,000 words…” or at least a couple of hundred. Make sure the number of visuals is appropriate to the audience need and subject matter at hand. Adapt visuals to audience level without dumbing down the subject matter. If there are more than 5 independent visuals within the document, create a List of Figures/Tables. Place visuals as close as possible following (after) the text reference. Surround the visual with white space to separate from text of document. Avoid overuse of decorative color and too much color this only creates confusion for the user in meaning-making. A good example of the use of color are geographical maps and metropolitan train maps.
Best Practices for Using Visuals in Technical WritingThe Integral Worm
This presentation outlines industry best practices for using visuals in technical writing. Appropriate visuals should be used only as needed to aid the user in understanding of the task at hand. Visuals are more specific, reduce processing time, and are more quickly understood than text. Visuals should make sense standing alone but also may be used to illustrate, explain, demonstrate, verify, and/or provide support. Use a verbal table to show problems with analyses and solutions for a trouble-shooting section. Visuals are easier to understand than prose in paragraphs. “A picture is worth a 1,000 words…” or at least a couple of hundred. Make sure the number of visuals is appropriate to the audience need and subject matter at hand. Adapt visuals to audience level without dumbing down the subject matter. If there are more than 5 independent visuals within the document, create a List of Figures/Tables. Place visuals as close as possible following (after) the text reference. Surround the visual with white space to separate from text of document. Avoid overuse of decorative color and too much color this only creates confusion for the user in meaning-making. A good example of the use of color are geographical maps and metropolitan train maps.
11.09.2014 Perşembe Günü Ataşehir Ofisimizde gerçekleştirmiş olduğumuz "IIBA® Metodolojisi ile Gereksinim Analizi" konulu çalışmaya ait sunumu bulabilirsiniz.
Structured writing presentation to London Content Strategy MeetupEllis Pratt
Content can often seem like jelly - messy and hard to manage. In this presentation, we'll look at whether you can reduce this messiness through structured writing. In this overview of the topic, we'll explore what is structured writing, what it promises to give its adopters, the different standards, and the challenges that come with using structured writing.
If you've wanted to get a handle on structured content and how it could work to make your content work better, join us for this informative session.
Our presenter, Ellis Pratt, is a Consulting Technical Communicator and Director at Cherryleaf, a technical writing services company. He has been working in technical communication since the early 1990s. He has a degree in Business Studies. He is also:
- Member of the Institute of Scientific and Technical Communicators
- Associate of the Institution of Engineering and Technology
- An ISTC Management Council member
In 2017, he was listed as one of the top 25 Content Experience influencers in the world.
Ellis was a contributor to two books: Current Practices and Trends in Technical Communication, and The Language of Technical Communication.
CHAPTER 12 ����������
�
�� �
������������
Engineers use oral presentations to efficiently and effectively transfer information to a wide
range of audiences. Usually, the setting and circumstances allow for direct interaction between the
speaker and the audience. Oral presentations are a common method of evaluating the progress of a
project and the progress of the individual. The ability to present oneself and one’s project in a com-
petent and succinct manner enhances one’s college and career development.
Multiple components make up an oral presentation: 1) the audience, 2) the content and organi-
zation, 3) visual aids, and 4) the speaker. Student design teams have control over the last three
items, but little control over the audience. Thus, a presentation goal is to prepare effective visual
aids and a presentation method to capture and maintain the attention of the audience. As with writ-
ing, styles of oral presentation are numerous. All good presentations rely on clarity of expression, an
easily followed train of thought and well thought-out visual aids that illustrate key points in the talk.
High-quality visual aids can make or break a presentation as can poor organization and a sloppy
presentation style (e.g., mumbling, talking to one’s feet or failing to make eye contact with the audi-
ence).
�
�����
��
Since presentations are always prepared for an audience, the presenter must evaluate the
audience and determine the best way to pique its interest. Determine who will attend the presenta-
tion. Gather informaiton on the technical awareness of the audience as a whole and the degree of
familiarity that the audience has in the subject. For instance, a presentation on modeling weather
patterns in the Pacific Ocean would be different for an audience of middle school students versus
one prepared for an audience of applied mathematicians. By assessing the audience correctly, the
speaker determines the best way to interest the audience. Explain why the presenter(s) finds the
subject interesting. Convey enthusiasm when explaining how it was determined what the best
Introductory Engineering Design 139
Chapter 12: Oral Presentations
140
course of action was that led to the solution. The interested audience then responds with questions
and comments that show an appreciation for the content and the style of the talk.
Audiences rarely have a uniform composition. Those attending may include, for instance, peers,
managers, contractors, vendors and clients. Before discussing any specific details, present back-
ground information for those who have a limited level of expertise in the subject matter. This informa-
tion helps bring the audience up to a common knowledge level.
Often, the audience includes those who are assessing the work itself and the capabilities of the
presentation team. These individuals probably understand the topic well. For instance, an instructor
evaluates a design team as a.
11.09.2014 Perşembe Günü Ataşehir Ofisimizde gerçekleştirmiş olduğumuz "IIBA® Metodolojisi ile Gereksinim Analizi" konulu çalışmaya ait sunumu bulabilirsiniz.
Structured writing presentation to London Content Strategy MeetupEllis Pratt
Content can often seem like jelly - messy and hard to manage. In this presentation, we'll look at whether you can reduce this messiness through structured writing. In this overview of the topic, we'll explore what is structured writing, what it promises to give its adopters, the different standards, and the challenges that come with using structured writing.
If you've wanted to get a handle on structured content and how it could work to make your content work better, join us for this informative session.
Our presenter, Ellis Pratt, is a Consulting Technical Communicator and Director at Cherryleaf, a technical writing services company. He has been working in technical communication since the early 1990s. He has a degree in Business Studies. He is also:
- Member of the Institute of Scientific and Technical Communicators
- Associate of the Institution of Engineering and Technology
- An ISTC Management Council member
In 2017, he was listed as one of the top 25 Content Experience influencers in the world.
Ellis was a contributor to two books: Current Practices and Trends in Technical Communication, and The Language of Technical Communication.
CHAPTER 12 ����������
�
�� �
������������
Engineers use oral presentations to efficiently and effectively transfer information to a wide
range of audiences. Usually, the setting and circumstances allow for direct interaction between the
speaker and the audience. Oral presentations are a common method of evaluating the progress of a
project and the progress of the individual. The ability to present oneself and one’s project in a com-
petent and succinct manner enhances one’s college and career development.
Multiple components make up an oral presentation: 1) the audience, 2) the content and organi-
zation, 3) visual aids, and 4) the speaker. Student design teams have control over the last three
items, but little control over the audience. Thus, a presentation goal is to prepare effective visual
aids and a presentation method to capture and maintain the attention of the audience. As with writ-
ing, styles of oral presentation are numerous. All good presentations rely on clarity of expression, an
easily followed train of thought and well thought-out visual aids that illustrate key points in the talk.
High-quality visual aids can make or break a presentation as can poor organization and a sloppy
presentation style (e.g., mumbling, talking to one’s feet or failing to make eye contact with the audi-
ence).
�
�����
��
Since presentations are always prepared for an audience, the presenter must evaluate the
audience and determine the best way to pique its interest. Determine who will attend the presenta-
tion. Gather informaiton on the technical awareness of the audience as a whole and the degree of
familiarity that the audience has in the subject. For instance, a presentation on modeling weather
patterns in the Pacific Ocean would be different for an audience of middle school students versus
one prepared for an audience of applied mathematicians. By assessing the audience correctly, the
speaker determines the best way to interest the audience. Explain why the presenter(s) finds the
subject interesting. Convey enthusiasm when explaining how it was determined what the best
Introductory Engineering Design 139
Chapter 12: Oral Presentations
140
course of action was that led to the solution. The interested audience then responds with questions
and comments that show an appreciation for the content and the style of the talk.
Audiences rarely have a uniform composition. Those attending may include, for instance, peers,
managers, contractors, vendors and clients. Before discussing any specific details, present back-
ground information for those who have a limited level of expertise in the subject matter. This informa-
tion helps bring the audience up to a common knowledge level.
Often, the audience includes those who are assessing the work itself and the capabilities of the
presentation team. These individuals probably understand the topic well. For instance, an instructor
evaluates a design team as a.
Telling a Story through Data: Dashboard Design GuidelinesSisense
By using the right visualization, you can tell a clear story with your data, a story that expresses the meaning of the data and answers business questions. This presentation covers four principles of good data visualizations that will tell your story and allow you to focus on the information that's important.
Professional Communication in Computing - WritingUpekha Vandebona
About Writing
This discusses the difference between expository writing and technical writing. Also it highlights how to write user documents for information systems.
Format Matters - How presentation affects understandingMike Rice
One of the strengths of DITA architecture is the separation of presentation from content. When focusing on the content model, it is easy to forget about how it looks to the end user.
Together with Chris Patterson, an information developer with Creative and Technical Communications at Xerox, we discuss factors affecting the usability of technical publications and how research, experience, and DITA structure influence format decisions.
Mngt 1002 Essay Marking
Course Coordinator: Garry Haworth
Essay – Compare and contrast
Entrepreneurship & Innovation
F
P
C
D
HD
Identification and discussion of definitions of
entrepreneurship and Innovation (2 marks)
Comparison and contrasting of benefits of
entrepreneurship and innovation (3 marks)
Comparison and contrasting of detriments of
entrepreneurship and innovation (3 marks)
Discussion of economic and social implications
for entrepreneurship and innovation (2 marks)
Coverage of relevant theoretical issues, including
integration of relevant literature (academic and
applied industry) (2 marks)
Structure, including logic and reasoning (how well
argued) (1 mark)
Depth of research (academic and industry) ( 1
mark)
Validity of argument development, including
referencing style, spelling and grammar (1 mark)
Comments:
MNGT1002 Introduction to Entrepreneurship and Innovation
Criteria Fail Pass Credit Distinction High Distinction
Identification and discussion of
definitions of entrepreneurship and
innovation
Very narrowly researched minimal or no
academic sources used
Narrow research, some validity using
academic sources
Widely researched and discussed with
multiple sources supporting the
ideas/issues in the definitions
Very good research and discussion
demonstrating the width and depth of
academic sources used to support the
presented definitions
Excellent
validated
definitions with
concise and
insightful
discussion
Comparison and contrasting of
benefits of entrepreneurship and
innovation
Very poor or NO critical analysis. No
comparative arguments. Discussion
presents strong biases.
Poor critical and comparative analysis.
Discussion presents some biases.
Good critical and comparative analysis
with two-fold arguments presenting a
balanced discussion
Very good critical and comparative analysis
with strong two-fold arguments presenting
a balanced discussion
Excellent
formation of
comparative
argument, with
quality validation
Comparison and contrasting of
detriments of entrepreneurship and
innovation
Very poor or NO critical analysis. No
comparative arguments. Discussion
presents strong biases.
Poor critical and comparative analysis.
Discussion presents some biases.
Good critical and comparative analysis
with two-fold arguments presenting a
balanced discussion
Very good critical and comparative analysis
with strong two-fold arguments presenting
a balanced discussion
Excellent
formation of
comparative
argument, with
quality validation
Discussion of economic and social
implications for entrepreneurship
and innovation
Rudimentary logic with limited
connection between ideas.
OR
Lack of logic random collection of
ideas
Adequate logic, discussion and analyses of
some issues.
Sound logic, discussion and analyses all
...
Get full visibility and find hidden security issuesElasticsearch
Learn key practices in data collection and normalization to expand visibility into your environment. See how you can use Elastic Security to quickly and accurately triage, verify, and scope issues.
Similar to Wetland Delineation--IRIS Tubes[REDACTED] (20)
Get full visibility and find hidden security issues
Wetland Delineation--IRIS Tubes[REDACTED]
1. Rewriting Technical Information—IRIS Example
In the example below,Itriedto:
Make iteasyto see whywe are tellingthemthis(change headingto“SimplifyingWetland
Delineation”)
Provide contextupfront(the topicsentence orientsthe reader;thenIexplainthe traditional
approach;thenI explain the connectionbetweenhydricsoilsandwetlands)
Provide problemstatement(expensive,etc.)
Explainhowwe doit better/solve problem
Give clear,easy‐to‐readexplanationof the technology
Clearlystate the mainpoint(whatwe can conclude aboutwetlandpresence fromIRIStube
results)
Provide authoritative supportforthe technique (fromNTCHS)
Write it well sothe readergetspulledalong,isinterested,wantstokeepreading, remembers
the point
Importantcomponentswere:
Knowingwhatelementstoinclude (or leaveout)
Knowinghowtoresearchfor (andunderstandandsummarize) missinginformation
Knowingwhatorderof informationtouse
Knowinghowtowordeach sentence wellforflow,coherence,emphasis,andconcision
Knowingwhentoaskquestionsorseekexpertreviewof astatement
Original (206 words)
IRIS Tube use – alternative way to determine presence of reducing conditions in soils that
indicates hydrology.
A lesscostlyalternativetoexpensive anddata-intensivegroundwatermonitoringwellstodetermineif
wetlandconditonsandformationof hydricsoilshasoccurredistouse Indicatorof ReductionInSoils
(IRIS) tubes. Thislow-techmethodhasbeenapprovedbythe National Technical Committee onHydric
Soils(NTCHS). IRIStubesare 24 inchpvc tubingthat are coated witha speciallyformulatedironoxide
paint. Wheninstalledinthe groundfora monthor longer,the paintonthe tubesisdesignedtodissolve
underreducingsoil conditions(Rabenhorst,2008),indicatingthathydricsoilsare present. Results
indicate whetherornot there issufficienthydrologyandorganicmatterto supportmicrobial processes
that are indicative of wetlandsoils. IRIStubesare amuch lesstime consumingandlesscostlythan
groundwatermodelingbecause yousimplyleave theminthe groundfora monthor more (followingthe
protocol approvedbyNTCHS) and thenextractthemto determinewhatpercentage of the painthas
beendissolvedthatindicateswetlandsoil conditions.Thistechnologycouldbe usedinappropriate
locationsincoordinationwithgroundwaterwellstokeepcostsandlaborneedsdown.
Anita(184 words)
IRIS Tubes: Simplifying Wetland Delineation
Delineatingwetlandareas isanimportantpart of environmentalinvestigations. Traditionally, some of
the needed information is gathered by installing groundwater monitoring wells to test for the hydric
soils that developunderreducingconditions.These soilsare neededbyhydrophytic(water-loving)
2. vegetation,andtheirpresence indicatesthe existenceof awetland.However, these wells are
expensive,time-consuming, anddata-intensive.
Whenappropriate, [CompanyX] recommendsalesscostly,faster,andsimplermethod, Indicatorof
ReductioninSoils(IRIS) tubes.These 24-inchPVCtubesare coatedwithaspeciallyformulatediron
oxide paintthatdissolvesunderreducingconditions.Scientistssimply leave the tubes inthe groundfor
a monthor more (following approved protocol)andthendetermine whatpercentage of the painthas
dissolved. If ahighpercentage hasdissolved,hydricsoilsare present,and there islikely sufficientwater
circulation andorganicmatter tosupport wetland microbial processes.IRIStechnology hasbeen
approvedbythe National Technical Committee onHydricSoilsand canbe used in coordinationwith
groundwaterwellstokeepcostsandlaborneeds forwetlanddelineation down.
![vegetation,andtheirpresence indicatesthe existenceof awetland.However, these wells are
expensive,time-consuming, anddata-intensive.
Whenappropriate, [CompanyX] recommendsalesscostly,faster,andsimplermethod, Indicatorof
ReductioninSoils(IRIS) tubes.These 24-inchPVCtubesare coatedwithaspeciallyformulatediron
oxide paintthatdissolvesunderreducingconditions.Scientistssimply leave the tubes inthe groundfor
a monthor more (following approved protocol)andthendetermine whatpercentage of the painthas
dissolved. If ahighpercentage hasdissolved,hydricsoilsare present,and there islikely sufficientwater
circulation andorganicmatter tosupport wetland microbial processes.IRIStechnology hasbeen
approvedbythe National Technical Committee onHydricSoilsand canbe used in coordinationwith
groundwaterwellstokeepcostsandlaborneeds forwetlanddelineation down.](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)