SlideShare una empresa de Scribd logo
1 de 26
TODAY
1) A Report: What you must have, what you should
have, and what you MIGHT have
2) Anderson: designing good documents
3) Activity: Outline (like a boss)
4) Remember to turn in your case study!
5) Homework
Reports
So we’ve talked a great deal about what you need to
do to find data, to treat data, to cite data, etc.
Today, I want to take a step in the lateral direction,
and we’re going to talk about the actual FORM of your
reports.
It’s time for a game of “Must, Should, Might”
YOUR REPORT MUST…
…have a title.
Seriously. Reports with no title are laaaame.
The title should also tell the reader quite a
bit about the report.
…have an introduction.
And we know what the introduction should
do, from our readings. Quick, concise, but
tell us what the report is about. Prep me!
…have a reference list.
Not citing your sources = plagiarism.
Plagiarism=stealing. Stealing=you’re not
professional. Don’t do it!
…have content, with headings.
Content matters, obviously.
But the heading part is big. Headings
organize our documents.
…have a conclusion.
Reports don’t just end. You need to indicate
that the ending has come by summarizing
and literally bringing the report to a close.
YOUR REPORT SHOULD…
…use signposting.
In other words, tell us where we’re going,
tell us where we’ve been. Don’t shock us.
Lead the way!
…include data visualization.
It will be rare for any of you to have data
that doesn’t feature, at least at one point,
some sort of complex data. Remember the
graphic ways to express that data.
…be well designed.
Easy to read. Easy to scan. That’s what your
report should be.
YOUR REPORT MIGHT…
…need an appendix.
If you have a large chunk of data that is too
cumbersome to include, in raw form, to put
into your report, you can always include it as
an appendix that the reader can access after
reading.
…use a table of contents.
If your report gets long, or your headings get
too copious, a table of contents can make
the report easier for readers to
scan/navigate.
…have a separate title page.
Depending on where you’re presenting it,
and to what audience, you might have a
page JUST for the title and your name.
…have a separate title page.
Depending on where you’re presenting it,
and to what audience, you might have a
page JUST for the title and your name.
…include a summary or abstract.
Again, depending on the audience, you
might need to preface your report with a
short summary (often called an “abstract”).
…feature multi-media external
links.
You might have audio, or video. And that’s
okay.
To those ends…
… the chapter from Anderson I had you read for today
talks about document design and page design. The big
take-away, of course, is “The grid.”
Grid based design dominates the world wide web, and most
magazines and newspapers. Basically, the concept is that you
place information into a grid– like a piece of graph paper– so
that it is easier to access and read.
For a report…
You won’t want to go with a grid as crazy as most websites;
while that works for screen reading, it would make your
report cumbersome. But you might want to utilize a two
column approach, or to include break-out boxes for your
report. If you want to get inventive, you might present your
report in a brochure format, or even as a webpage, and with
that decision would come other grid options.
So you want…
… to think through how you want your reader to
encounter your information. Particularly if you’re
including images, tables, infographics, etc. the idea of
designing your pages on the grid will make a big
difference.
Think about directions we read online vs. when you
had to set them up on a single column page.
The basic premise of the grid…
… is that presenting textual data in simple pages is often NOT
user friendly. It is actually, believe it or not, more difficult to
read certain forms of prose in full page format.
Why do you imagine so many journals, magazines and
newspapers have smaller columns while novels and poetry
use full-page design?
Activity: a “design” outline
Hopefully at this point you have some sense of how
your report would look. I want you to spend some
time here in class thinking about a “design” minded
outline. What I mean is, obviously, you need to think
about the content, but I want you to focus in THIS
particular activity on how you want to present your
report. How do you want this thing to look? How do
you want it to be read?
Remember…
… that your case studies are due, via email, preferably as a
PDF though .doc(x) is fine, too.
No actual homework for next class. In honor of Halloween,
we’re going to do something a little bit fun that I think will
also help you to think more about what we’ve discussed
today.
See you bright and early on Thursday!

Más contenido relacionado

Similar a Technical Writing, October 29, 2013

Technical Writing, October 8, 2013
Technical Writing, October 8, 2013Technical Writing, October 8, 2013
Technical Writing, October 8, 2013
Miami University
 
Smp project abstract
Smp project abstractSmp project abstract
Smp project abstract
ntgoodman
 
Tipsforplanningandwritingaresearchpaper
TipsforplanningandwritingaresearchpaperTipsforplanningandwritingaresearchpaper
Tipsforplanningandwritingaresearchpaper
Charlene Shotwell
 
PRNewswire Guide to Writing a Feature
PRNewswire Guide to Writing a FeaturePRNewswire Guide to Writing a Feature
PRNewswire Guide to Writing a Feature
Alli Mowrey
 
Information architecture workshops
Information architecture workshopsInformation architecture workshops
Information architecture workshops
Frank Lockwood
 
Report writing a presentation for dewas and gwalior
Report writing   a presentation for dewas and gwaliorReport writing   a presentation for dewas and gwalior
Report writing a presentation for dewas and gwalior
Manish Rao
 
Be your own publisher seminar 2010-session A
Be your own publisher seminar 2010-session ABe your own publisher seminar 2010-session A
Be your own publisher seminar 2010-session A
J T "Tom" Johnson
 

Similar a Technical Writing, October 29, 2013 (20)

Technical Writing, October 8, 2013
Technical Writing, October 8, 2013Technical Writing, October 8, 2013
Technical Writing, October 8, 2013
 
Smp project abstract
Smp project abstractSmp project abstract
Smp project abstract
 
04 Feb 10 Jour3340 Writing For The Web
04 Feb 10   Jour3340  Writing For The Web04 Feb 10   Jour3340  Writing For The Web
04 Feb 10 Jour3340 Writing For The Web
 
Tipsforplanningandwritingaresearchpaper
TipsforplanningandwritingaresearchpaperTipsforplanningandwritingaresearchpaper
Tipsforplanningandwritingaresearchpaper
 
PRNewswire Guide to Writing a Feature
PRNewswire Guide to Writing a FeaturePRNewswire Guide to Writing a Feature
PRNewswire Guide to Writing a Feature
 
Information architecture workshops
Information architecture workshopsInformation architecture workshops
Information architecture workshops
 
Report writing a presentation for dewas and gwalior
Report writing   a presentation for dewas and gwaliorReport writing   a presentation for dewas and gwalior
Report writing a presentation for dewas and gwalior
 
diseñando datos
diseñando datosdiseñando datos
diseñando datos
 
News design
News designNews design
News design
 
Twenty one suggestions
Twenty one suggestionsTwenty one suggestions
Twenty one suggestions
 
Digital Essay Intro & Brainstorming
Digital Essay Intro & BrainstormingDigital Essay Intro & Brainstorming
Digital Essay Intro & Brainstorming
 
Prefatory material of a Book Writing
Prefatory material of a Book Writing Prefatory material of a Book Writing
Prefatory material of a Book Writing
 
Research/Thesis Preparation, Oral Presentations, CV/Resume, Cover Letter
Research/Thesis Preparation, Oral Presentations, CV/Resume, Cover LetterResearch/Thesis Preparation, Oral Presentations, CV/Resume, Cover Letter
Research/Thesis Preparation, Oral Presentations, CV/Resume, Cover Letter
 
English 111, October 9th, 2012
English 111, October 9th, 2012English 111, October 9th, 2012
English 111, October 9th, 2012
 
Content Writing
Content WritingContent Writing
Content Writing
 
Writing good scientific_papers_v2
Writing good scientific_papers_v2Writing good scientific_papers_v2
Writing good scientific_papers_v2
 
Structure
StructureStructure
Structure
 
How to check out your paper
How to check out your paperHow to check out your paper
How to check out your paper
 
Be your own publisher seminar 2010-session A
Be your own publisher seminar 2010-session ABe your own publisher seminar 2010-session A
Be your own publisher seminar 2010-session A
 
Writing every page is page one topics
Writing every page is page one topics Writing every page is page one topics
Writing every page is page one topics
 

Más de Miami University

Más de Miami University (20)

At nasty
At nastyAt nasty
At nasty
 
Crap
CrapCrap
Crap
 
Rhetanal
RhetanalRhetanal
Rhetanal
 
Visual Rhetoric 4
Visual Rhetoric 4Visual Rhetoric 4
Visual Rhetoric 4
 
Visual Rhetoric 3
Visual Rhetoric 3Visual Rhetoric 3
Visual Rhetoric 3
 
Capstone Day 3
Capstone Day 3Capstone Day 3
Capstone Day 3
 
Capstone Day 4
Capstone Day 4Capstone Day 4
Capstone Day 4
 
Capstone Day 2
Capstone Day 2Capstone Day 2
Capstone Day 2
 
Capstone Day 1
Capstone Day 1Capstone Day 1
Capstone Day 1
 
Visual Rhetoric 2
Visual Rhetoric 2Visual Rhetoric 2
Visual Rhetoric 2
 
Visual Rhetoric 1
Visual Rhetoric 1Visual Rhetoric 1
Visual Rhetoric 1
 
224 summerfinal
224 summerfinal224 summerfinal
224 summerfinal
 
Dr philleval211
Dr philleval211Dr philleval211
Dr philleval211
 
211 finalreview
211 finalreview211 finalreview
211 finalreview
 
Week 2
Week 2Week 2
Week 2
 
Brief Video Game History
Brief Video Game HistoryBrief Video Game History
Brief Video Game History
 
Dungeons & Dragons history
Dungeons & Dragons historyDungeons & Dragons history
Dungeons & Dragons history
 
Rhetoric of Advertising
Rhetoric of AdvertisingRhetoric of Advertising
Rhetoric of Advertising
 
Logos
LogosLogos
Logos
 
411 Personal Logo PowerPoint
411 Personal Logo PowerPoint411 Personal Logo PowerPoint
411 Personal Logo PowerPoint
 

Último

Activity 01 - Artificial Culture (1).pdf
Activity 01 - Artificial Culture (1).pdfActivity 01 - Artificial Culture (1).pdf
Activity 01 - Artificial Culture (1).pdf
ciinovamais
 
Making and Justifying Mathematical Decisions.pdf
Making and Justifying Mathematical Decisions.pdfMaking and Justifying Mathematical Decisions.pdf
Making and Justifying Mathematical Decisions.pdf
Chris Hunter
 

Último (20)

This PowerPoint helps students to consider the concept of infinity.
This PowerPoint helps students to consider the concept of infinity.This PowerPoint helps students to consider the concept of infinity.
This PowerPoint helps students to consider the concept of infinity.
 
Introduction to Nonprofit Accounting: The Basics
Introduction to Nonprofit Accounting: The BasicsIntroduction to Nonprofit Accounting: The Basics
Introduction to Nonprofit Accounting: The Basics
 
Unit-IV; Professional Sales Representative (PSR).pptx
Unit-IV; Professional Sales Representative (PSR).pptxUnit-IV; Professional Sales Representative (PSR).pptx
Unit-IV; Professional Sales Representative (PSR).pptx
 
Z Score,T Score, Percential Rank and Box Plot Graph
Z Score,T Score, Percential Rank and Box Plot GraphZ Score,T Score, Percential Rank and Box Plot Graph
Z Score,T Score, Percential Rank and Box Plot Graph
 
psychiatric nursing HISTORY COLLECTION .docx
psychiatric  nursing HISTORY  COLLECTION  .docxpsychiatric  nursing HISTORY  COLLECTION  .docx
psychiatric nursing HISTORY COLLECTION .docx
 
Energy Resources. ( B. Pharmacy, 1st Year, Sem-II) Natural Resources
Energy Resources. ( B. Pharmacy, 1st Year, Sem-II) Natural ResourcesEnergy Resources. ( B. Pharmacy, 1st Year, Sem-II) Natural Resources
Energy Resources. ( B. Pharmacy, 1st Year, Sem-II) Natural Resources
 
Key note speaker Neum_Admir Softic_ENG.pdf
Key note speaker Neum_Admir Softic_ENG.pdfKey note speaker Neum_Admir Softic_ENG.pdf
Key note speaker Neum_Admir Softic_ENG.pdf
 
PROCESS RECORDING FORMAT.docx
PROCESS      RECORDING        FORMAT.docxPROCESS      RECORDING        FORMAT.docx
PROCESS RECORDING FORMAT.docx
 
On National Teacher Day, meet the 2024-25 Kenan Fellows
On National Teacher Day, meet the 2024-25 Kenan FellowsOn National Teacher Day, meet the 2024-25 Kenan Fellows
On National Teacher Day, meet the 2024-25 Kenan Fellows
 
Advanced Views - Calendar View in Odoo 17
Advanced Views - Calendar View in Odoo 17Advanced Views - Calendar View in Odoo 17
Advanced Views - Calendar View in Odoo 17
 
Sociology 101 Demonstration of Learning Exhibit
Sociology 101 Demonstration of Learning ExhibitSociology 101 Demonstration of Learning Exhibit
Sociology 101 Demonstration of Learning Exhibit
 
Class 11th Physics NEET formula sheet pdf
Class 11th Physics NEET formula sheet pdfClass 11th Physics NEET formula sheet pdf
Class 11th Physics NEET formula sheet pdf
 
Activity 01 - Artificial Culture (1).pdf
Activity 01 - Artificial Culture (1).pdfActivity 01 - Artificial Culture (1).pdf
Activity 01 - Artificial Culture (1).pdf
 
ComPTIA Overview | Comptia Security+ Book SY0-701
ComPTIA Overview | Comptia Security+ Book SY0-701ComPTIA Overview | Comptia Security+ Book SY0-701
ComPTIA Overview | Comptia Security+ Book SY0-701
 
TỔNG ÔN TẬP THI VÀO LỚP 10 MÔN TIẾNG ANH NĂM HỌC 2023 - 2024 CÓ ĐÁP ÁN (NGỮ Â...
TỔNG ÔN TẬP THI VÀO LỚP 10 MÔN TIẾNG ANH NĂM HỌC 2023 - 2024 CÓ ĐÁP ÁN (NGỮ Â...TỔNG ÔN TẬP THI VÀO LỚP 10 MÔN TIẾNG ANH NĂM HỌC 2023 - 2024 CÓ ĐÁP ÁN (NGỮ Â...
TỔNG ÔN TẬP THI VÀO LỚP 10 MÔN TIẾNG ANH NĂM HỌC 2023 - 2024 CÓ ĐÁP ÁN (NGỮ Â...
 
INDIA QUIZ 2024 RLAC DELHI UNIVERSITY.pptx
INDIA QUIZ 2024 RLAC DELHI UNIVERSITY.pptxINDIA QUIZ 2024 RLAC DELHI UNIVERSITY.pptx
INDIA QUIZ 2024 RLAC DELHI UNIVERSITY.pptx
 
Measures of Central Tendency: Mean, Median and Mode
Measures of Central Tendency: Mean, Median and ModeMeasures of Central Tendency: Mean, Median and Mode
Measures of Central Tendency: Mean, Median and Mode
 
Explore beautiful and ugly buildings. Mathematics helps us create beautiful d...
Explore beautiful and ugly buildings. Mathematics helps us create beautiful d...Explore beautiful and ugly buildings. Mathematics helps us create beautiful d...
Explore beautiful and ugly buildings. Mathematics helps us create beautiful d...
 
Mixin Classes in Odoo 17 How to Extend Models Using Mixin Classes
Mixin Classes in Odoo 17  How to Extend Models Using Mixin ClassesMixin Classes in Odoo 17  How to Extend Models Using Mixin Classes
Mixin Classes in Odoo 17 How to Extend Models Using Mixin Classes
 
Making and Justifying Mathematical Decisions.pdf
Making and Justifying Mathematical Decisions.pdfMaking and Justifying Mathematical Decisions.pdf
Making and Justifying Mathematical Decisions.pdf
 

Technical Writing, October 29, 2013

  • 1.
  • 2. TODAY 1) A Report: What you must have, what you should have, and what you MIGHT have 2) Anderson: designing good documents 3) Activity: Outline (like a boss) 4) Remember to turn in your case study! 5) Homework
  • 3. Reports So we’ve talked a great deal about what you need to do to find data, to treat data, to cite data, etc. Today, I want to take a step in the lateral direction, and we’re going to talk about the actual FORM of your reports. It’s time for a game of “Must, Should, Might”
  • 5. …have a title. Seriously. Reports with no title are laaaame. The title should also tell the reader quite a bit about the report.
  • 6. …have an introduction. And we know what the introduction should do, from our readings. Quick, concise, but tell us what the report is about. Prep me!
  • 7. …have a reference list. Not citing your sources = plagiarism. Plagiarism=stealing. Stealing=you’re not professional. Don’t do it!
  • 8. …have content, with headings. Content matters, obviously. But the heading part is big. Headings organize our documents.
  • 9. …have a conclusion. Reports don’t just end. You need to indicate that the ending has come by summarizing and literally bringing the report to a close.
  • 11. …use signposting. In other words, tell us where we’re going, tell us where we’ve been. Don’t shock us. Lead the way!
  • 12. …include data visualization. It will be rare for any of you to have data that doesn’t feature, at least at one point, some sort of complex data. Remember the graphic ways to express that data.
  • 13. …be well designed. Easy to read. Easy to scan. That’s what your report should be.
  • 15. …need an appendix. If you have a large chunk of data that is too cumbersome to include, in raw form, to put into your report, you can always include it as an appendix that the reader can access after reading.
  • 16. …use a table of contents. If your report gets long, or your headings get too copious, a table of contents can make the report easier for readers to scan/navigate.
  • 17. …have a separate title page. Depending on where you’re presenting it, and to what audience, you might have a page JUST for the title and your name.
  • 18. …have a separate title page. Depending on where you’re presenting it, and to what audience, you might have a page JUST for the title and your name.
  • 19. …include a summary or abstract. Again, depending on the audience, you might need to preface your report with a short summary (often called an “abstract”).
  • 20. …feature multi-media external links. You might have audio, or video. And that’s okay.
  • 21. To those ends… … the chapter from Anderson I had you read for today talks about document design and page design. The big take-away, of course, is “The grid.” Grid based design dominates the world wide web, and most magazines and newspapers. Basically, the concept is that you place information into a grid– like a piece of graph paper– so that it is easier to access and read.
  • 22. For a report… You won’t want to go with a grid as crazy as most websites; while that works for screen reading, it would make your report cumbersome. But you might want to utilize a two column approach, or to include break-out boxes for your report. If you want to get inventive, you might present your report in a brochure format, or even as a webpage, and with that decision would come other grid options.
  • 23. So you want… … to think through how you want your reader to encounter your information. Particularly if you’re including images, tables, infographics, etc. the idea of designing your pages on the grid will make a big difference. Think about directions we read online vs. when you had to set them up on a single column page.
  • 24. The basic premise of the grid… … is that presenting textual data in simple pages is often NOT user friendly. It is actually, believe it or not, more difficult to read certain forms of prose in full page format. Why do you imagine so many journals, magazines and newspapers have smaller columns while novels and poetry use full-page design?
  • 25. Activity: a “design” outline Hopefully at this point you have some sense of how your report would look. I want you to spend some time here in class thinking about a “design” minded outline. What I mean is, obviously, you need to think about the content, but I want you to focus in THIS particular activity on how you want to present your report. How do you want this thing to look? How do you want it to be read?
  • 26. Remember… … that your case studies are due, via email, preferably as a PDF though .doc(x) is fine, too. No actual homework for next class. In honor of Halloween, we’re going to do something a little bit fun that I think will also help you to think more about what we’ve discussed today. See you bright and early on Thursday!