SlideShare a Scribd company logo
How to write-up UX test findings in a
Technical White Paper
1
Deliverable 1:
2
Table of Contents
Types of White Papers ............................................................................................................................................... 3-7
White Papers and Document Design.......................................................................................................................... 8-12
Requirements and Guidelines for Your Technical White Paper .................................................................................. 13
Required Pages and Structure.......................................................................................................................... 14
Title Page ............................................................................................................................................... 15-17
Table of Contents................................................................................................................................... 18
Introduction........................................................................................................................................... 19-21
Methodology or Methods ..................................................................................................................... 22-23
Results.................................................................................................................................................... 24-25
Recommendation(s) / Conclusion .......................................................................................................... 26
Bibliography ........................................................................................................................................... 27
Appendix................................................................................................................................................ 28
Types of White Papers
• Position White Papers
• Marketing White Papers
• Technical White Papers
3
Position White Papers
• The term white paper was originally used to describe a
report that states the social or political position of an
organization or think tank
4
Marketing White Papers
• Offer to solve problems for a client or customer. They are
persuasive documents aimed at selling features of products.
5
Technical White Papers
• Technical White Papers present the results of tests or
research findings and also aimed at solving problems.
6
7
White papers are composed in a
variety of formats and for delivery
across multiple platforms.
White Papers and Document Design
• Because white papers are
written to external
audiences they become
part of the communication
that businesses and
organizations use to present
a brand image.
• Creating cohesive and
consistent communication
across platforms is
important.
8
Structured Authoring
9
is a way of separating content from format and document
design in order to produce communication products that
have a consistent look and feel. Adobe FrameMaker is a
popular tool used for this purpose.
10
Notice how tableau’s website
and white papers have a
common look and feel.
There is some variation in the
pages of these white papers, but
the design and structure is
consistent.
These are examples of data sheets by
SEL. These sheets describe the features
and benefits of the products.
Notice they have a consistent look and
feel that supports the brand.
Structured Authoring and Your White Paper
• You will not be using structured authoring technology, but
you will be able to practice structured authoring
conceptually.
• I will require a rule for how to organize the body of your
white paper. This rule is use IMRaD structure to organize the
body of the paper, and it would be similar to a rule used in a
structured authoring tool for any white paper content.
12
Deliverable 1:
Requirements and Guidelines for
Your Technical White Paper
13
Required pages and IMRaD sections.
• Title (Page)
• Table of contents (Page)
• Use IMRaD structure for major section headings.
14
Introduction
Methodology or Methods
Results
Discussion/Conclusion
or Recommendations
• Bibliography (Page)
• Appendix (Page)
Title Page: use document design to create
visual interest but pay attention to what you learned
previously about graphic design.
15
Notice how these
choices of color
do not support the
white paper’s
purpose. In fact, they
work against it.
Title Page: effective designs.
16
Color choices and
design elements
support the
purpose of these
white papers.
17
Comparing
Wix and Weebly
A Cognitive Walkthrough
and Analysis
by Elizabeth Hernandez
Examples of title pages
by former students.
Table of Contents
18
• Use dot leaders.
• Right-align page numbers.
• This example organizes the
results by task, but there are
other ways to organize the
results.
• Try using the automatic
feature in Word.
!
Ii!
!
TABLE!OF!CONTENTS!
!
INTRODUCTION!............................................................................................................![#]!
METHODOLOGY!...........................................................................................................![#]!
! Tasks!.......................................................................................................................!!
! Environment/Equipment!..........................................................................................!!
! Metrics!.....................................................................................................................!!
RESULTS!.......................................................................................................................![#]!
! Task!1:![name!of!task]!.........................................................................................![#]!
! Task!2:![name!of!task]!.........................................................................................![#]!
! Task!3:![name!of!task]!.........................................................................................![#]!
! Task!4:![name!of!task]!.........................................................................................![#]!
! Task!5:![name!of!task]!.........................................................................................![#]!
! Task!6:![name!of!task]!.........................................................................................![#]!
! Task!7:![name!of!task]!.........................................................................................![#]!
! Task!8:![name!of!task]!.........................................................................................![#]!
! Task!9:![name!of!task]!.........................................................................................![#]!
! Task!10:![name!of!task]!.......................................................................................![#]!
RECOMMENDATION(S)/CONCLUSION!.......................................................................![#]!
!BIBLIOGRAPHY!............................................................................................................![#]!
APPENDICE!
! Appendix!A:!Data!Collection!Completed!Forms!or!Spreadsheet!.........................![#]!
!(NOTE:!!Page!numbers!must!be!right]aligned.)!
Introduction
• Rhetorically, the
introduction of a
technical white paper
creates a record of what
was tested and why.
19
Rhetorical moves for the introduction.
Option 1: start with a purpose statement that includes the
definition of the product or website.
20
Example:
This white paper describes the findings from a usability
test of two free blogging tools: Tumblr and Blogger.
Example:
This white paper evaluates how Gimp, a free cloud
computing tool, compares to its pricey counterpart:
Adobe Photoshop.
Option 2: start with a phrase or sentence definition and then
move to a purpose statement.
21
Example 1:
Weebly and Wix are popular website-builder tools. This white
paper presents the results of a usability test that compared
how well the tools performed in five component standards
that define usability.
Example 2:
Image editing software such as Adobe Photoshop often have
steep learning curves, deterring most novices from trying
them. This white paper describes the findings from a
comparison of two image editing products aimed at novice
users: [name the two products].
Methodology (or Methods)
• Just as in an engineering tests
or scientific experiments, the
methodology section explains
the design of the test or
experiment.
• Rhetorically, it explains how
you designed the test.
22
Methodology: What to include.
• Tasks. Create a list of the tasks and use a parallel structure.
• Test Environment. State when you did the test, where,
and anything else that helps a reader understand the testing
methods you used such as type of computer (laptop,
desktop, PC or Mac etc.?). Version of the products tested
etc.
• Evaluative Criteria/Rating Scale. List the five criteria
statements and include a numerical Likert scale with labels.
23
Results
• Rhetorically, the results
present the findings and
what the findings mean.
• How you organize this
section is your choice, but
the organizing pattern
should take readers logically
through the findings.
24
Results need to include:
• Clear, concise technical descriptions of what happened when
you did the task and how you evaluated usability.
• Incorporate visuals to help reader follow the test findings:
• screenshots that support descriptions.
• graphics that represent
the scoring data either in the
results and/or at the end in a summary.
• you may also choose to include
the criteria statements with
Likert scale in the results’ section.
And, if needed, make
• suggestions about how to improve the
product or website for each task.
25
Recommendation(s)/Conclusion
• Rhetorically, this section should make
an overall conclusion about how the
products compared.
• The recommendations in this section
should list, in order of importance,
any suggestions you made in the
results section for how to improve the
website or product.
26
Bibliography
• Include for website(s) or fully online
products you tested.
• Include the URL for any specific
information you cited when
considering how a feature worked,
such as claims made on the
product’s website etc.
• You may find an endnote system (i.e.
superscript that refers to bibliography
end note page) is easiest to use but
any documentation style is fine.
27
Appendix
• You will need to include the raw data
in this section, which is the
completed data collection forms or
spreadsheet.
• Consider multiple forms to be pages
of a single appendix. See the next
page for how to move from portrait
to landscape when inserting a
collection form made in landscape.
28
Appendices is the plural of appendix. Since you have only one
appendix (consider data collection forms to be one appendix
with multiple pages), use Appendix in the title of yours.

More Related Content

Similar to Engl317 project4 slidedoc3_technical_whitepaper

sap fresher jobs BANGALORE ERPTAC - INTERVIEW QUSTIONS
sap fresher jobs BANGALORE ERPTAC - INTERVIEW QUSTIONSsap fresher jobs BANGALORE ERPTAC - INTERVIEW QUSTIONS
sap fresher jobs BANGALORE ERPTAC - INTERVIEW QUSTIONS
Erptac Bangalore
 
DAT 390 Education Specialist |tutorialrank.com
 DAT 390 Education Specialist |tutorialrank.com DAT 390 Education Specialist |tutorialrank.com
DAT 390 Education Specialist |tutorialrank.com
ladworkspaces
 
Imrad structure
Imrad structureImrad structure
Imrad structure
Brian Malone
 
Guide to excel
Guide to excelGuide to excel
Guide to excel
accgenius2
 
IGCSE & O Level Computer Workbook for P2 by Inqilab Patel
IGCSE & O Level Computer Workbook for P2 by Inqilab PatelIGCSE & O Level Computer Workbook for P2 by Inqilab Patel
IGCSE & O Level Computer Workbook for P2 by Inqilab Patel
Inqilab Patel
 
Research: Developing an Interactive Web Information Retrieval and Visualizati...
Research: Developing an Interactive Web Information Retrieval and Visualizati...Research: Developing an Interactive Web Information Retrieval and Visualizati...
Research: Developing an Interactive Web Information Retrieval and Visualizati...
Roman Atachiants
 
Best Practices SQL 2005 SSIS
Best Practices SQL 2005 SSISBest Practices SQL 2005 SSIS
Best Practices SQL 2005 SSIS
ptolozah
 
TechWriterSamples
TechWriterSamplesTechWriterSamples
TechWriterSamples
David Schlosser
 
Slides (1)
Slides (1)Slides (1)
Slides (1)
vateat1
 
3. eDocumentation Process Build Phase
3. eDocumentation Process Build Phase3. eDocumentation Process Build Phase
3. eDocumentation Process Build Phase
Kathy Stanford Jackson
 
2 problem solving and programming workbook by inqilab patel
2 problem solving and programming workbook by inqilab patel2 problem solving and programming workbook by inqilab patel
2 problem solving and programming workbook by inqilab patel
Inqilab Patel
 
Week 8 & 10
Week 8 & 10Week 8 & 10
Week 8 & 10
Study Geek
 
EEECSE 120 Answer SheetCapstone Design Project .docx
EEECSE 120 Answer SheetCapstone Design Project             .docxEEECSE 120 Answer SheetCapstone Design Project             .docx
EEECSE 120 Answer SheetCapstone Design Project .docx
toltonkendal
 
DEPARTMENT OF CIVIL AND ENVIRONMENTAL ENGINEERING.docx
DEPARTMENT OF CIVIL AND ENVIRONMENTAL ENGINEERING.docxDEPARTMENT OF CIVIL AND ENVIRONMENTAL ENGINEERING.docx
DEPARTMENT OF CIVIL AND ENVIRONMENTAL ENGINEERING.docx
theodorelove43763
 
On site support operations draft
On site support operations draftOn site support operations draft
On site support operations draft
Texas Tech University
 
DBMS_Lab_Manual_&_Solution
DBMS_Lab_Manual_&_SolutionDBMS_Lab_Manual_&_Solution
DBMS_Lab_Manual_&_Solution
Syed Zaid Irshad
 
Data Analysis and Synthesis & Techniques of System.pptx
Data Analysis and Synthesis & Techniques of System.pptxData Analysis and Synthesis & Techniques of System.pptx
Data Analysis and Synthesis & Techniques of System.pptx
Ts. Heshalini Rajagopal
 
Sales and operations planning a research synthesis
Sales and operations planning  a research synthesisSales and operations planning  a research synthesis
Sales and operations planning a research synthesis
Wallace Almeida
 
Benchmarks for Digital Preservation tools. Kresimir Duretec, Artur Kulmukhame...
Benchmarks for Digital Preservation tools. Kresimir Duretec, Artur Kulmukhame...Benchmarks for Digital Preservation tools. Kresimir Duretec, Artur Kulmukhame...
Benchmarks for Digital Preservation tools. Kresimir Duretec, Artur Kulmukhame...
12th International Conference on Digital Preservation (iPRES 2015)
 
Guidelines for technical writing documents
Guidelines for technical writing documentsGuidelines for technical writing documents
Guidelines for technical writing documents
Rajesh Singamsetty
 

Similar to Engl317 project4 slidedoc3_technical_whitepaper (20)

sap fresher jobs BANGALORE ERPTAC - INTERVIEW QUSTIONS
sap fresher jobs BANGALORE ERPTAC - INTERVIEW QUSTIONSsap fresher jobs BANGALORE ERPTAC - INTERVIEW QUSTIONS
sap fresher jobs BANGALORE ERPTAC - INTERVIEW QUSTIONS
 
DAT 390 Education Specialist |tutorialrank.com
 DAT 390 Education Specialist |tutorialrank.com DAT 390 Education Specialist |tutorialrank.com
DAT 390 Education Specialist |tutorialrank.com
 
Imrad structure
Imrad structureImrad structure
Imrad structure
 
Guide to excel
Guide to excelGuide to excel
Guide to excel
 
IGCSE & O Level Computer Workbook for P2 by Inqilab Patel
IGCSE & O Level Computer Workbook for P2 by Inqilab PatelIGCSE & O Level Computer Workbook for P2 by Inqilab Patel
IGCSE & O Level Computer Workbook for P2 by Inqilab Patel
 
Research: Developing an Interactive Web Information Retrieval and Visualizati...
Research: Developing an Interactive Web Information Retrieval and Visualizati...Research: Developing an Interactive Web Information Retrieval and Visualizati...
Research: Developing an Interactive Web Information Retrieval and Visualizati...
 
Best Practices SQL 2005 SSIS
Best Practices SQL 2005 SSISBest Practices SQL 2005 SSIS
Best Practices SQL 2005 SSIS
 
TechWriterSamples
TechWriterSamplesTechWriterSamples
TechWriterSamples
 
Slides (1)
Slides (1)Slides (1)
Slides (1)
 
3. eDocumentation Process Build Phase
3. eDocumentation Process Build Phase3. eDocumentation Process Build Phase
3. eDocumentation Process Build Phase
 
2 problem solving and programming workbook by inqilab patel
2 problem solving and programming workbook by inqilab patel2 problem solving and programming workbook by inqilab patel
2 problem solving and programming workbook by inqilab patel
 
Week 8 & 10
Week 8 & 10Week 8 & 10
Week 8 & 10
 
EEECSE 120 Answer SheetCapstone Design Project .docx
EEECSE 120 Answer SheetCapstone Design Project             .docxEEECSE 120 Answer SheetCapstone Design Project             .docx
EEECSE 120 Answer SheetCapstone Design Project .docx
 
DEPARTMENT OF CIVIL AND ENVIRONMENTAL ENGINEERING.docx
DEPARTMENT OF CIVIL AND ENVIRONMENTAL ENGINEERING.docxDEPARTMENT OF CIVIL AND ENVIRONMENTAL ENGINEERING.docx
DEPARTMENT OF CIVIL AND ENVIRONMENTAL ENGINEERING.docx
 
On site support operations draft
On site support operations draftOn site support operations draft
On site support operations draft
 
DBMS_Lab_Manual_&_Solution
DBMS_Lab_Manual_&_SolutionDBMS_Lab_Manual_&_Solution
DBMS_Lab_Manual_&_Solution
 
Data Analysis and Synthesis & Techniques of System.pptx
Data Analysis and Synthesis & Techniques of System.pptxData Analysis and Synthesis & Techniques of System.pptx
Data Analysis and Synthesis & Techniques of System.pptx
 
Sales and operations planning a research synthesis
Sales and operations planning  a research synthesisSales and operations planning  a research synthesis
Sales and operations planning a research synthesis
 
Benchmarks for Digital Preservation tools. Kresimir Duretec, Artur Kulmukhame...
Benchmarks for Digital Preservation tools. Kresimir Duretec, Artur Kulmukhame...Benchmarks for Digital Preservation tools. Kresimir Duretec, Artur Kulmukhame...
Benchmarks for Digital Preservation tools. Kresimir Duretec, Artur Kulmukhame...
 
Guidelines for technical writing documents
Guidelines for technical writing documentsGuidelines for technical writing documents
Guidelines for technical writing documents
 

More from Zachary Williamson

Engl 208 03 self-documentary assignment sheet
Engl 208 03 self-documentary assignment sheetEngl 208 03 self-documentary assignment sheet
Engl 208 03 self-documentary assignment sheet
Zachary Williamson
 
Engl 208 03 essay ala bluets assignment sheet
Engl 208 03 essay ala bluets assignment sheetEngl 208 03 essay ala bluets assignment sheet
Engl 208 03 essay ala bluets assignment sheet
Zachary Williamson
 
Engl317 assignment sheet_project4
Engl317 assignment sheet_project4Engl317 assignment sheet_project4
Engl317 assignment sheet_project4
Zachary Williamson
 
Engl317 project4 slidedoc1_about_usabilitytesting
Engl317 project4 slidedoc1_about_usabilitytestingEngl317 project4 slidedoc1_about_usabilitytesting
Engl317 project4 slidedoc1_about_usabilitytesting
Zachary Williamson
 
Engl317 project4 slidedoc2_stepsto_designux_test
Engl317 project4 slidedoc2_stepsto_designux_testEngl317 project4 slidedoc2_stepsto_designux_test
Engl317 project4 slidedoc2_stepsto_designux_test
Zachary Williamson
 
Engl317 project4 slidedoc4_screencasting_usability_testfinding
Engl317 project4 slidedoc4_screencasting_usability_testfindingEngl317 project4 slidedoc4_screencasting_usability_testfinding
Engl317 project4 slidedoc4_screencasting_usability_testfinding
Zachary Williamson
 
Engl317 project3 slidedoc1_graphic_designprinciplesfornondesigners
Engl317 project3 slidedoc1_graphic_designprinciplesfornondesignersEngl317 project3 slidedoc1_graphic_designprinciplesfornondesigners
Engl317 project3 slidedoc1_graphic_designprinciplesfornondesigners
Zachary Williamson
 
Engl317 project3 slidedoc2_howto_createyourinfographic
Engl317 project3 slidedoc2_howto_createyourinfographicEngl317 project3 slidedoc2_howto_createyourinfographic
Engl317 project3 slidedoc2_howto_createyourinfographic
Zachary Williamson
 
Engl317 project3 slidedoc3_screencasting_design_justification_
Engl317 project3 slidedoc3_screencasting_design_justification_Engl317 project3 slidedoc3_screencasting_design_justification_
Engl317 project3 slidedoc3_screencasting_design_justification_
Zachary Williamson
 
Engl317 project2 slidedoc1_about_technical_definitions_and_descriptions
Engl317 project2 slidedoc1_about_technical_definitions_and_descriptionsEngl317 project2 slidedoc1_about_technical_definitions_and_descriptions
Engl317 project2 slidedoc1_about_technical_definitions_and_descriptions
Zachary Williamson
 
Engl317 project2 slidedoc3_how_to_create_the_slidecast
Engl317 project2 slidedoc3_how_to_create_the_slidecastEngl317 project2 slidedoc3_how_to_create_the_slidecast
Engl317 project2 slidedoc3_how_to_create_the_slidecast
Zachary Williamson
 
Engl317 project2 slidedoc2_how_to_write_the_technical_documentation
Engl317 project2 slidedoc2_how_to_write_the_technical_documentationEngl317 project2 slidedoc2_how_to_write_the_technical_documentation
Engl317 project2 slidedoc2_how_to_write_the_technical_documentation
Zachary Williamson
 
Engl317 project2 slidedoc4_optional_metaphors_similiesanalogies
Engl317 project2 slidedoc4_optional_metaphors_similiesanalogiesEngl317 project2 slidedoc4_optional_metaphors_similiesanalogies
Engl317 project2 slidedoc4_optional_metaphors_similiesanalogies
Zachary Williamson
 
F2 f project2_schedule_engl317_spring2019
F2 f project2_schedule_engl317_spring2019F2 f project2_schedule_engl317_spring2019
F2 f project2_schedule_engl317_spring2019
Zachary Williamson
 
F2 f project3_schedule_engl317_spring2019
F2 f project3_schedule_engl317_spring2019F2 f project3_schedule_engl317_spring2019
F2 f project3_schedule_engl317_spring2019
Zachary Williamson
 
F2 f project4_schedule_engl317_spring2019
F2 f project4_schedule_engl317_spring2019F2 f project4_schedule_engl317_spring2019
F2 f project4_schedule_engl317_spring2019
Zachary Williamson
 
F2 f project5_schedule_engl317_spring2019
F2 f project5_schedule_engl317_spring2019F2 f project5_schedule_engl317_spring2019
F2 f project5_schedule_engl317_spring2019
Zachary Williamson
 
F2 f project1_schedule_engl317_spring2019
F2 f project1_schedule_engl317_spring2019F2 f project1_schedule_engl317_spring2019
F2 f project1_schedule_engl317_spring2019
Zachary Williamson
 
Engl317 orientation about_technicalwriting
Engl317 orientation about_technicalwritingEngl317 orientation about_technicalwriting
Engl317 orientation about_technicalwriting
Zachary Williamson
 
Online project4 schedule_engl317_spring2019
Online project4 schedule_engl317_spring2019Online project4 schedule_engl317_spring2019
Online project4 schedule_engl317_spring2019
Zachary Williamson
 

More from Zachary Williamson (20)

Engl 208 03 self-documentary assignment sheet
Engl 208 03 self-documentary assignment sheetEngl 208 03 self-documentary assignment sheet
Engl 208 03 self-documentary assignment sheet
 
Engl 208 03 essay ala bluets assignment sheet
Engl 208 03 essay ala bluets assignment sheetEngl 208 03 essay ala bluets assignment sheet
Engl 208 03 essay ala bluets assignment sheet
 
Engl317 assignment sheet_project4
Engl317 assignment sheet_project4Engl317 assignment sheet_project4
Engl317 assignment sheet_project4
 
Engl317 project4 slidedoc1_about_usabilitytesting
Engl317 project4 slidedoc1_about_usabilitytestingEngl317 project4 slidedoc1_about_usabilitytesting
Engl317 project4 slidedoc1_about_usabilitytesting
 
Engl317 project4 slidedoc2_stepsto_designux_test
Engl317 project4 slidedoc2_stepsto_designux_testEngl317 project4 slidedoc2_stepsto_designux_test
Engl317 project4 slidedoc2_stepsto_designux_test
 
Engl317 project4 slidedoc4_screencasting_usability_testfinding
Engl317 project4 slidedoc4_screencasting_usability_testfindingEngl317 project4 slidedoc4_screencasting_usability_testfinding
Engl317 project4 slidedoc4_screencasting_usability_testfinding
 
Engl317 project3 slidedoc1_graphic_designprinciplesfornondesigners
Engl317 project3 slidedoc1_graphic_designprinciplesfornondesignersEngl317 project3 slidedoc1_graphic_designprinciplesfornondesigners
Engl317 project3 slidedoc1_graphic_designprinciplesfornondesigners
 
Engl317 project3 slidedoc2_howto_createyourinfographic
Engl317 project3 slidedoc2_howto_createyourinfographicEngl317 project3 slidedoc2_howto_createyourinfographic
Engl317 project3 slidedoc2_howto_createyourinfographic
 
Engl317 project3 slidedoc3_screencasting_design_justification_
Engl317 project3 slidedoc3_screencasting_design_justification_Engl317 project3 slidedoc3_screencasting_design_justification_
Engl317 project3 slidedoc3_screencasting_design_justification_
 
Engl317 project2 slidedoc1_about_technical_definitions_and_descriptions
Engl317 project2 slidedoc1_about_technical_definitions_and_descriptionsEngl317 project2 slidedoc1_about_technical_definitions_and_descriptions
Engl317 project2 slidedoc1_about_technical_definitions_and_descriptions
 
Engl317 project2 slidedoc3_how_to_create_the_slidecast
Engl317 project2 slidedoc3_how_to_create_the_slidecastEngl317 project2 slidedoc3_how_to_create_the_slidecast
Engl317 project2 slidedoc3_how_to_create_the_slidecast
 
Engl317 project2 slidedoc2_how_to_write_the_technical_documentation
Engl317 project2 slidedoc2_how_to_write_the_technical_documentationEngl317 project2 slidedoc2_how_to_write_the_technical_documentation
Engl317 project2 slidedoc2_how_to_write_the_technical_documentation
 
Engl317 project2 slidedoc4_optional_metaphors_similiesanalogies
Engl317 project2 slidedoc4_optional_metaphors_similiesanalogiesEngl317 project2 slidedoc4_optional_metaphors_similiesanalogies
Engl317 project2 slidedoc4_optional_metaphors_similiesanalogies
 
F2 f project2_schedule_engl317_spring2019
F2 f project2_schedule_engl317_spring2019F2 f project2_schedule_engl317_spring2019
F2 f project2_schedule_engl317_spring2019
 
F2 f project3_schedule_engl317_spring2019
F2 f project3_schedule_engl317_spring2019F2 f project3_schedule_engl317_spring2019
F2 f project3_schedule_engl317_spring2019
 
F2 f project4_schedule_engl317_spring2019
F2 f project4_schedule_engl317_spring2019F2 f project4_schedule_engl317_spring2019
F2 f project4_schedule_engl317_spring2019
 
F2 f project5_schedule_engl317_spring2019
F2 f project5_schedule_engl317_spring2019F2 f project5_schedule_engl317_spring2019
F2 f project5_schedule_engl317_spring2019
 
F2 f project1_schedule_engl317_spring2019
F2 f project1_schedule_engl317_spring2019F2 f project1_schedule_engl317_spring2019
F2 f project1_schedule_engl317_spring2019
 
Engl317 orientation about_technicalwriting
Engl317 orientation about_technicalwritingEngl317 orientation about_technicalwriting
Engl317 orientation about_technicalwriting
 
Online project4 schedule_engl317_spring2019
Online project4 schedule_engl317_spring2019Online project4 schedule_engl317_spring2019
Online project4 schedule_engl317_spring2019
 

Recently uploaded

PIMS Job Advertisement 2024.pdf Islamabad
PIMS Job Advertisement 2024.pdf IslamabadPIMS Job Advertisement 2024.pdf Islamabad
PIMS Job Advertisement 2024.pdf Islamabad
AyyanKhan40
 
BÀI TẬP BỔ TRỢ TIẾNG ANH 8 CẢ NĂM - GLOBAL SUCCESS - NĂM HỌC 2023-2024 (CÓ FI...
BÀI TẬP BỔ TRỢ TIẾNG ANH 8 CẢ NĂM - GLOBAL SUCCESS - NĂM HỌC 2023-2024 (CÓ FI...BÀI TẬP BỔ TRỢ TIẾNG ANH 8 CẢ NĂM - GLOBAL SUCCESS - NĂM HỌC 2023-2024 (CÓ FI...
BÀI TẬP BỔ TRỢ TIẾNG ANH 8 CẢ NĂM - GLOBAL SUCCESS - NĂM HỌC 2023-2024 (CÓ FI...
Nguyen Thanh Tu Collection
 
Chapter 4 - Islamic Financial Institutions in Malaysia.pptx
Chapter 4 - Islamic Financial Institutions in Malaysia.pptxChapter 4 - Islamic Financial Institutions in Malaysia.pptx
Chapter 4 - Islamic Financial Institutions in Malaysia.pptx
Mohd Adib Abd Muin, Senior Lecturer at Universiti Utara Malaysia
 
Life upper-Intermediate B2 Workbook for student
Life upper-Intermediate B2 Workbook for studentLife upper-Intermediate B2 Workbook for student
Life upper-Intermediate B2 Workbook for student
NgcHiNguyn25
 
writing about opinions about Australia the movie
writing about opinions about Australia the moviewriting about opinions about Australia the movie
writing about opinions about Australia the movie
Nicholas Montgomery
 
Azure Interview Questions and Answers PDF By ScholarHat
Azure Interview Questions and Answers PDF By ScholarHatAzure Interview Questions and Answers PDF By ScholarHat
Azure Interview Questions and Answers PDF By ScholarHat
Scholarhat
 
How to Fix the Import Error in the Odoo 17
How to Fix the Import Error in the Odoo 17How to Fix the Import Error in the Odoo 17
How to Fix the Import Error in the Odoo 17
Celine George
 
MARY JANE WILSON, A “BOA MÃE” .
MARY JANE WILSON, A “BOA MÃE”           .MARY JANE WILSON, A “BOA MÃE”           .
MARY JANE WILSON, A “BOA MÃE” .
Colégio Santa Teresinha
 
Pollock and Snow "DEIA in the Scholarly Landscape, Session One: Setting Expec...
Pollock and Snow "DEIA in the Scholarly Landscape, Session One: Setting Expec...Pollock and Snow "DEIA in the Scholarly Landscape, Session One: Setting Expec...
Pollock and Snow "DEIA in the Scholarly Landscape, Session One: Setting Expec...
National Information Standards Organization (NISO)
 
Pengantar Penggunaan Flutter - Dart programming language1.pptx
Pengantar Penggunaan Flutter - Dart programming language1.pptxPengantar Penggunaan Flutter - Dart programming language1.pptx
Pengantar Penggunaan Flutter - Dart programming language1.pptx
Fajar Baskoro
 
Film vocab for eal 3 students: Australia the movie
Film vocab for eal 3 students: Australia the movieFilm vocab for eal 3 students: Australia the movie
Film vocab for eal 3 students: Australia the movie
Nicholas Montgomery
 
Cognitive Development Adolescence Psychology
Cognitive Development Adolescence PsychologyCognitive Development Adolescence Psychology
Cognitive Development Adolescence Psychology
paigestewart1632
 
LAND USE LAND COVER AND NDVI OF MIRZAPUR DISTRICT, UP
LAND USE LAND COVER AND NDVI OF MIRZAPUR DISTRICT, UPLAND USE LAND COVER AND NDVI OF MIRZAPUR DISTRICT, UP
LAND USE LAND COVER AND NDVI OF MIRZAPUR DISTRICT, UP
RAHUL
 
A Independência da América Espanhola LAPBOOK.pdf
A Independência da América Espanhola LAPBOOK.pdfA Independência da América Espanhola LAPBOOK.pdf
A Independência da América Espanhola LAPBOOK.pdf
Jean Carlos Nunes Paixão
 
BBR 2024 Summer Sessions Interview Training
BBR  2024 Summer Sessions Interview TrainingBBR  2024 Summer Sessions Interview Training
BBR 2024 Summer Sessions Interview Training
Katrina Pritchard
 
How to Add Chatter in the odoo 17 ERP Module
How to Add Chatter in the odoo 17 ERP ModuleHow to Add Chatter in the odoo 17 ERP Module
How to Add Chatter in the odoo 17 ERP Module
Celine George
 
Digital Artefact 1 - Tiny Home Environmental Design
Digital Artefact 1 - Tiny Home Environmental DesignDigital Artefact 1 - Tiny Home Environmental Design
Digital Artefact 1 - Tiny Home Environmental Design
amberjdewit93
 
DRUGS AND ITS classification slide share
DRUGS AND ITS classification slide shareDRUGS AND ITS classification slide share
DRUGS AND ITS classification slide share
taiba qazi
 
RPMS TEMPLATE FOR SCHOOL YEAR 2023-2024 FOR TEACHER 1 TO TEACHER 3
RPMS TEMPLATE FOR SCHOOL YEAR 2023-2024 FOR TEACHER 1 TO TEACHER 3RPMS TEMPLATE FOR SCHOOL YEAR 2023-2024 FOR TEACHER 1 TO TEACHER 3
RPMS TEMPLATE FOR SCHOOL YEAR 2023-2024 FOR TEACHER 1 TO TEACHER 3
IreneSebastianRueco1
 
Walmart Business+ and Spark Good for Nonprofits.pdf
Walmart Business+ and Spark Good for Nonprofits.pdfWalmart Business+ and Spark Good for Nonprofits.pdf
Walmart Business+ and Spark Good for Nonprofits.pdf
TechSoup
 

Recently uploaded (20)

PIMS Job Advertisement 2024.pdf Islamabad
PIMS Job Advertisement 2024.pdf IslamabadPIMS Job Advertisement 2024.pdf Islamabad
PIMS Job Advertisement 2024.pdf Islamabad
 
BÀI TẬP BỔ TRỢ TIẾNG ANH 8 CẢ NĂM - GLOBAL SUCCESS - NĂM HỌC 2023-2024 (CÓ FI...
BÀI TẬP BỔ TRỢ TIẾNG ANH 8 CẢ NĂM - GLOBAL SUCCESS - NĂM HỌC 2023-2024 (CÓ FI...BÀI TẬP BỔ TRỢ TIẾNG ANH 8 CẢ NĂM - GLOBAL SUCCESS - NĂM HỌC 2023-2024 (CÓ FI...
BÀI TẬP BỔ TRỢ TIẾNG ANH 8 CẢ NĂM - GLOBAL SUCCESS - NĂM HỌC 2023-2024 (CÓ FI...
 
Chapter 4 - Islamic Financial Institutions in Malaysia.pptx
Chapter 4 - Islamic Financial Institutions in Malaysia.pptxChapter 4 - Islamic Financial Institutions in Malaysia.pptx
Chapter 4 - Islamic Financial Institutions in Malaysia.pptx
 
Life upper-Intermediate B2 Workbook for student
Life upper-Intermediate B2 Workbook for studentLife upper-Intermediate B2 Workbook for student
Life upper-Intermediate B2 Workbook for student
 
writing about opinions about Australia the movie
writing about opinions about Australia the moviewriting about opinions about Australia the movie
writing about opinions about Australia the movie
 
Azure Interview Questions and Answers PDF By ScholarHat
Azure Interview Questions and Answers PDF By ScholarHatAzure Interview Questions and Answers PDF By ScholarHat
Azure Interview Questions and Answers PDF By ScholarHat
 
How to Fix the Import Error in the Odoo 17
How to Fix the Import Error in the Odoo 17How to Fix the Import Error in the Odoo 17
How to Fix the Import Error in the Odoo 17
 
MARY JANE WILSON, A “BOA MÃE” .
MARY JANE WILSON, A “BOA MÃE”           .MARY JANE WILSON, A “BOA MÃE”           .
MARY JANE WILSON, A “BOA MÃE” .
 
Pollock and Snow "DEIA in the Scholarly Landscape, Session One: Setting Expec...
Pollock and Snow "DEIA in the Scholarly Landscape, Session One: Setting Expec...Pollock and Snow "DEIA in the Scholarly Landscape, Session One: Setting Expec...
Pollock and Snow "DEIA in the Scholarly Landscape, Session One: Setting Expec...
 
Pengantar Penggunaan Flutter - Dart programming language1.pptx
Pengantar Penggunaan Flutter - Dart programming language1.pptxPengantar Penggunaan Flutter - Dart programming language1.pptx
Pengantar Penggunaan Flutter - Dart programming language1.pptx
 
Film vocab for eal 3 students: Australia the movie
Film vocab for eal 3 students: Australia the movieFilm vocab for eal 3 students: Australia the movie
Film vocab for eal 3 students: Australia the movie
 
Cognitive Development Adolescence Psychology
Cognitive Development Adolescence PsychologyCognitive Development Adolescence Psychology
Cognitive Development Adolescence Psychology
 
LAND USE LAND COVER AND NDVI OF MIRZAPUR DISTRICT, UP
LAND USE LAND COVER AND NDVI OF MIRZAPUR DISTRICT, UPLAND USE LAND COVER AND NDVI OF MIRZAPUR DISTRICT, UP
LAND USE LAND COVER AND NDVI OF MIRZAPUR DISTRICT, UP
 
A Independência da América Espanhola LAPBOOK.pdf
A Independência da América Espanhola LAPBOOK.pdfA Independência da América Espanhola LAPBOOK.pdf
A Independência da América Espanhola LAPBOOK.pdf
 
BBR 2024 Summer Sessions Interview Training
BBR  2024 Summer Sessions Interview TrainingBBR  2024 Summer Sessions Interview Training
BBR 2024 Summer Sessions Interview Training
 
How to Add Chatter in the odoo 17 ERP Module
How to Add Chatter in the odoo 17 ERP ModuleHow to Add Chatter in the odoo 17 ERP Module
How to Add Chatter in the odoo 17 ERP Module
 
Digital Artefact 1 - Tiny Home Environmental Design
Digital Artefact 1 - Tiny Home Environmental DesignDigital Artefact 1 - Tiny Home Environmental Design
Digital Artefact 1 - Tiny Home Environmental Design
 
DRUGS AND ITS classification slide share
DRUGS AND ITS classification slide shareDRUGS AND ITS classification slide share
DRUGS AND ITS classification slide share
 
RPMS TEMPLATE FOR SCHOOL YEAR 2023-2024 FOR TEACHER 1 TO TEACHER 3
RPMS TEMPLATE FOR SCHOOL YEAR 2023-2024 FOR TEACHER 1 TO TEACHER 3RPMS TEMPLATE FOR SCHOOL YEAR 2023-2024 FOR TEACHER 1 TO TEACHER 3
RPMS TEMPLATE FOR SCHOOL YEAR 2023-2024 FOR TEACHER 1 TO TEACHER 3
 
Walmart Business+ and Spark Good for Nonprofits.pdf
Walmart Business+ and Spark Good for Nonprofits.pdfWalmart Business+ and Spark Good for Nonprofits.pdf
Walmart Business+ and Spark Good for Nonprofits.pdf
 

Engl317 project4 slidedoc3_technical_whitepaper

  • 1. How to write-up UX test findings in a Technical White Paper 1 Deliverable 1:
  • 2. 2 Table of Contents Types of White Papers ............................................................................................................................................... 3-7 White Papers and Document Design.......................................................................................................................... 8-12 Requirements and Guidelines for Your Technical White Paper .................................................................................. 13 Required Pages and Structure.......................................................................................................................... 14 Title Page ............................................................................................................................................... 15-17 Table of Contents................................................................................................................................... 18 Introduction........................................................................................................................................... 19-21 Methodology or Methods ..................................................................................................................... 22-23 Results.................................................................................................................................................... 24-25 Recommendation(s) / Conclusion .......................................................................................................... 26 Bibliography ........................................................................................................................................... 27 Appendix................................................................................................................................................ 28
  • 3. Types of White Papers • Position White Papers • Marketing White Papers • Technical White Papers 3
  • 4. Position White Papers • The term white paper was originally used to describe a report that states the social or political position of an organization or think tank 4
  • 5. Marketing White Papers • Offer to solve problems for a client or customer. They are persuasive documents aimed at selling features of products. 5
  • 6. Technical White Papers • Technical White Papers present the results of tests or research findings and also aimed at solving problems. 6
  • 7. 7 White papers are composed in a variety of formats and for delivery across multiple platforms.
  • 8. White Papers and Document Design • Because white papers are written to external audiences they become part of the communication that businesses and organizations use to present a brand image. • Creating cohesive and consistent communication across platforms is important. 8
  • 9. Structured Authoring 9 is a way of separating content from format and document design in order to produce communication products that have a consistent look and feel. Adobe FrameMaker is a popular tool used for this purpose.
  • 10. 10 Notice how tableau’s website and white papers have a common look and feel. There is some variation in the pages of these white papers, but the design and structure is consistent.
  • 11. These are examples of data sheets by SEL. These sheets describe the features and benefits of the products. Notice they have a consistent look and feel that supports the brand.
  • 12. Structured Authoring and Your White Paper • You will not be using structured authoring technology, but you will be able to practice structured authoring conceptually. • I will require a rule for how to organize the body of your white paper. This rule is use IMRaD structure to organize the body of the paper, and it would be similar to a rule used in a structured authoring tool for any white paper content. 12
  • 13. Deliverable 1: Requirements and Guidelines for Your Technical White Paper 13
  • 14. Required pages and IMRaD sections. • Title (Page) • Table of contents (Page) • Use IMRaD structure for major section headings. 14 Introduction Methodology or Methods Results Discussion/Conclusion or Recommendations • Bibliography (Page) • Appendix (Page)
  • 15. Title Page: use document design to create visual interest but pay attention to what you learned previously about graphic design. 15 Notice how these choices of color do not support the white paper’s purpose. In fact, they work against it.
  • 16. Title Page: effective designs. 16 Color choices and design elements support the purpose of these white papers.
  • 17. 17 Comparing Wix and Weebly A Cognitive Walkthrough and Analysis by Elizabeth Hernandez Examples of title pages by former students.
  • 18. Table of Contents 18 • Use dot leaders. • Right-align page numbers. • This example organizes the results by task, but there are other ways to organize the results. • Try using the automatic feature in Word. ! Ii! ! TABLE!OF!CONTENTS! ! INTRODUCTION!............................................................................................................![#]! METHODOLOGY!...........................................................................................................![#]! ! Tasks!.......................................................................................................................!! ! Environment/Equipment!..........................................................................................!! ! Metrics!.....................................................................................................................!! RESULTS!.......................................................................................................................![#]! ! Task!1:![name!of!task]!.........................................................................................![#]! ! Task!2:![name!of!task]!.........................................................................................![#]! ! Task!3:![name!of!task]!.........................................................................................![#]! ! Task!4:![name!of!task]!.........................................................................................![#]! ! Task!5:![name!of!task]!.........................................................................................![#]! ! Task!6:![name!of!task]!.........................................................................................![#]! ! Task!7:![name!of!task]!.........................................................................................![#]! ! Task!8:![name!of!task]!.........................................................................................![#]! ! Task!9:![name!of!task]!.........................................................................................![#]! ! Task!10:![name!of!task]!.......................................................................................![#]! RECOMMENDATION(S)/CONCLUSION!.......................................................................![#]! !BIBLIOGRAPHY!............................................................................................................![#]! APPENDICE! ! Appendix!A:!Data!Collection!Completed!Forms!or!Spreadsheet!.........................![#]! !(NOTE:!!Page!numbers!must!be!right]aligned.)!
  • 19. Introduction • Rhetorically, the introduction of a technical white paper creates a record of what was tested and why. 19
  • 20. Rhetorical moves for the introduction. Option 1: start with a purpose statement that includes the definition of the product or website. 20 Example: This white paper describes the findings from a usability test of two free blogging tools: Tumblr and Blogger. Example: This white paper evaluates how Gimp, a free cloud computing tool, compares to its pricey counterpart: Adobe Photoshop.
  • 21. Option 2: start with a phrase or sentence definition and then move to a purpose statement. 21 Example 1: Weebly and Wix are popular website-builder tools. This white paper presents the results of a usability test that compared how well the tools performed in five component standards that define usability. Example 2: Image editing software such as Adobe Photoshop often have steep learning curves, deterring most novices from trying them. This white paper describes the findings from a comparison of two image editing products aimed at novice users: [name the two products].
  • 22. Methodology (or Methods) • Just as in an engineering tests or scientific experiments, the methodology section explains the design of the test or experiment. • Rhetorically, it explains how you designed the test. 22
  • 23. Methodology: What to include. • Tasks. Create a list of the tasks and use a parallel structure. • Test Environment. State when you did the test, where, and anything else that helps a reader understand the testing methods you used such as type of computer (laptop, desktop, PC or Mac etc.?). Version of the products tested etc. • Evaluative Criteria/Rating Scale. List the five criteria statements and include a numerical Likert scale with labels. 23
  • 24. Results • Rhetorically, the results present the findings and what the findings mean. • How you organize this section is your choice, but the organizing pattern should take readers logically through the findings. 24
  • 25. Results need to include: • Clear, concise technical descriptions of what happened when you did the task and how you evaluated usability. • Incorporate visuals to help reader follow the test findings: • screenshots that support descriptions. • graphics that represent the scoring data either in the results and/or at the end in a summary. • you may also choose to include the criteria statements with Likert scale in the results’ section. And, if needed, make • suggestions about how to improve the product or website for each task. 25
  • 26. Recommendation(s)/Conclusion • Rhetorically, this section should make an overall conclusion about how the products compared. • The recommendations in this section should list, in order of importance, any suggestions you made in the results section for how to improve the website or product. 26
  • 27. Bibliography • Include for website(s) or fully online products you tested. • Include the URL for any specific information you cited when considering how a feature worked, such as claims made on the product’s website etc. • You may find an endnote system (i.e. superscript that refers to bibliography end note page) is easiest to use but any documentation style is fine. 27
  • 28. Appendix • You will need to include the raw data in this section, which is the completed data collection forms or spreadsheet. • Consider multiple forms to be pages of a single appendix. See the next page for how to move from portrait to landscape when inserting a collection form made in landscape. 28 Appendices is the plural of appendix. Since you have only one appendix (consider data collection forms to be one appendix with multiple pages), use Appendix in the title of yours.