SlideShare a Scribd company logo
Made by-
Vidushi Gupta
Assistant professor
English & Hss
Jiet Institute of Design & Technology
Lecture10
Lecture10
 Elements of Document Design
 “When you are designing your
document’s layout, it is just as important
to know your audience as when you are
planning your document’s text”
– Consistent use of elements creates a
sense of a unified document.
– Headings and lists help readers note
different sections.
Lecture10
 Effective documentation is compiled
information that triages multiple sources of
input, and assembles them in a coherent
fashion, allowing for a narrative to be built
around the product or feature that is being
built within an organization. One of the
results and outputs of this effective
documentation building, is software
requirements, which become crucial for
designers to understand what they’re
effectively solving for.
 How is documentation created?
 Documentation can be surfaced should be presented in a way that is digestible by
different team members (designers, developers, project and product managers,
stakeholders). Documentation is created by exposing a strategy that demonstrates
the and presented on a multitude of platforms these days. Following a process of
research, of defining design patterns, of gathering user testing data (in any
context, from initial validation, through concept testing, pre-deployment testing,
among others), all this information process by which a solution is being achieved,
one that marries different variables from design through development and
implementation. Translating all these sources of information into a coherent
narrative, is crucial.
 How is documentation effectively used?
I’ve come to realize that effective documentation paints a succinct
picture, allowing for the designer (in this particular case), to perceive
the context of the problem being addressed, and therefore enabling the
professional to focus on finding a solution (one that is not hindered by
factors that sometimes may be unknown, such as legal, localization and
cultural requirements). By having useful information available, but
more importantly, by having effective documentation compiled, it
facilitates the design process, enabling designers, development and
product teams to have a better flow in terms of productivity (measured
in successful iterative processes, workshops and other relevant
activities).
 Measuring the success of documentation properly
gathered. In order to summarize this article and to best
advocate for the usage and creation of effective
documentation, I’ll reinstate something that I’ve
witnessed while working in different types of
enterprises. Consistent, clear, and detailed
documentation empower the designer (and teams), to
understand context, narrative, and generate a more
effective problem solving process, one that is flexible
and ever evolving, but also prescient of how other teams
within the enterprise are impacted by their decisions.

Lecture10
Lecture10
 Document Structure
 By using grids and whitespace, you can keep content interesting
and clear:
 Grids
 Think about a document in terms of sections, using placeholders
to organize text and graphics.
 White Space
 "Experts have learned that readers are attracted to text when
white space surrounds it"
 White space can be used in margins, hanging indents, line
spacing, paragraph length, and paragraph indenting among
other textual spacing techniques
Content Structure
Two major elements:
 Lists
Help you group information for easier reading,
helps emphasize important points, help organize
information chronologically.
Lists should be formatted and follow guidelines
such as keeping items within the list as short as
possible and keeping lists parallel in format.
Content Structure
Headings
 Use at least one heading per page of a document
 Use substantive wording (Instead of "Costs" use "Production Costs of
the FastCopy800)
 • Use parallel form in wording-headings of equal value and degree
should have the same grammatical form (Using the SmartArt Tool,
Adding New Slides, Arranging Slide Elements, are all parallel in
grammatical form)
 Establish a clear hierarchy with formatting/bolding (make sure
readers can tell a heading 1 from a heading 2
 User larger type-size for higher level headings; heading position to
show ranking (center a title, for example); and typographic elements
(bolding italics, color, underline)
 Use decimal headings for longer, formal documents
Lecture10

More Related Content

PDF
Technical Writing
PPT
DOC-20230804-gghjddnmkjggfdxxnkkgfd004..ppt
PPTX
Document Design in Technical Writing
PPS
Modular Documentation Joe Gelb Techshoret 2009
PPT
Ia Toolkit
PPT
Information Architecture Development
PPT
Success Factors for DITA Adoption with XMetaL: Best Practices and Fundamentals
Technical Writing
DOC-20230804-gghjddnmkjggfdxxnkkgfd004..ppt
Document Design in Technical Writing
Modular Documentation Joe Gelb Techshoret 2009
Ia Toolkit
Information Architecture Development
Success Factors for DITA Adoption with XMetaL: Best Practices and Fundamentals

Similar to Lecture10 (20)

PPT
Kbee Spaces Financial Services
PDF
Untitled document (58).pdf
PPT
Process And Methodology Research
PDF
Generation of Automatic Code using Design Patterns
PDF
JDD 2016 - Ademar Aguiar - To Document Or Not Document - That Is The Question
PPT
Evaluation of Research Tools
PPTX
Successful Single-Source Content Development
DOC
list script and flowchart
PPTX
Mastering the Art of SharePoint DMS
PDF
PPTX
Elements of technical document
PDF
Publishing management solution using enterprise content management tools
PDF
Information Architecture
PPT
Content Analysis: Methods and Mentoring
PPTX
Business analytics
PPT
Agile And Documentation
PPT
DITA, Semantics, Content Management, Dynamic Documents, and Linked Data – A M...
PPTX
Understanding Content Analysis in Qualitative Research.pptx
PPT
Using Qualitative Data Analysis Software By Michelle C. Bligh, Ph.D., Claremo...
PDF
Kbee Spaces Financial Services
Untitled document (58).pdf
Process And Methodology Research
Generation of Automatic Code using Design Patterns
JDD 2016 - Ademar Aguiar - To Document Or Not Document - That Is The Question
Evaluation of Research Tools
Successful Single-Source Content Development
list script and flowchart
Mastering the Art of SharePoint DMS
Elements of technical document
Publishing management solution using enterprise content management tools
Information Architecture
Content Analysis: Methods and Mentoring
Business analytics
Agile And Documentation
DITA, Semantics, Content Management, Dynamic Documents, and Linked Data – A M...
Understanding Content Analysis in Qualitative Research.pptx
Using Qualitative Data Analysis Software By Michelle C. Bligh, Ph.D., Claremo...
Ad

Recently uploaded (20)

PDF
Unit I ESSENTIAL OF DIGITAL MARKETING.pdf
PDF
Model Code of Practice - Construction Work - 21102022 .pdf
PDF
PPT on Performance Review to get promotions
PDF
Evaluating the Democratization of the Turkish Armed Forces from a Normative P...
PPTX
Construction Project Organization Group 2.pptx
PPTX
Artificial Intelligence
PPTX
OOP with Java - Java Introduction (Basics)
PDF
composite construction of structures.pdf
PPTX
Safety Seminar civil to be ensured for safe working.
PDF
III.4.1.2_The_Space_Environment.p pdffdf
PDF
737-MAX_SRG.pdf student reference guides
PDF
The CXO Playbook 2025 – Future-Ready Strategies for C-Suite Leaders Cerebrai...
PDF
Well-logging-methods_new................
PPTX
CH1 Production IntroductoryConcepts.pptx
PPTX
Internet of Things (IOT) - A guide to understanding
PPTX
Fundamentals of safety and accident prevention -final (1).pptx
PPTX
additive manufacturing of ss316l using mig welding
PPTX
Sustainable Sites - Green Building Construction
PPTX
web development for engineering and engineering
PPTX
CYBER-CRIMES AND SECURITY A guide to understanding
Unit I ESSENTIAL OF DIGITAL MARKETING.pdf
Model Code of Practice - Construction Work - 21102022 .pdf
PPT on Performance Review to get promotions
Evaluating the Democratization of the Turkish Armed Forces from a Normative P...
Construction Project Organization Group 2.pptx
Artificial Intelligence
OOP with Java - Java Introduction (Basics)
composite construction of structures.pdf
Safety Seminar civil to be ensured for safe working.
III.4.1.2_The_Space_Environment.p pdffdf
737-MAX_SRG.pdf student reference guides
The CXO Playbook 2025 – Future-Ready Strategies for C-Suite Leaders Cerebrai...
Well-logging-methods_new................
CH1 Production IntroductoryConcepts.pptx
Internet of Things (IOT) - A guide to understanding
Fundamentals of safety and accident prevention -final (1).pptx
additive manufacturing of ss316l using mig welding
Sustainable Sites - Green Building Construction
web development for engineering and engineering
CYBER-CRIMES AND SECURITY A guide to understanding
Ad

Lecture10

  • 1. Made by- Vidushi Gupta Assistant professor English & Hss Jiet Institute of Design & Technology
  • 4.  Elements of Document Design  “When you are designing your document’s layout, it is just as important to know your audience as when you are planning your document’s text” – Consistent use of elements creates a sense of a unified document. – Headings and lists help readers note different sections.
  • 6.  Effective documentation is compiled information that triages multiple sources of input, and assembles them in a coherent fashion, allowing for a narrative to be built around the product or feature that is being built within an organization. One of the results and outputs of this effective documentation building, is software requirements, which become crucial for designers to understand what they’re effectively solving for.
  • 7.  How is documentation created?  Documentation can be surfaced should be presented in a way that is digestible by different team members (designers, developers, project and product managers, stakeholders). Documentation is created by exposing a strategy that demonstrates the and presented on a multitude of platforms these days. Following a process of research, of defining design patterns, of gathering user testing data (in any context, from initial validation, through concept testing, pre-deployment testing, among others), all this information process by which a solution is being achieved, one that marries different variables from design through development and implementation. Translating all these sources of information into a coherent narrative, is crucial.
  • 8.  How is documentation effectively used? I’ve come to realize that effective documentation paints a succinct picture, allowing for the designer (in this particular case), to perceive the context of the problem being addressed, and therefore enabling the professional to focus on finding a solution (one that is not hindered by factors that sometimes may be unknown, such as legal, localization and cultural requirements). By having useful information available, but more importantly, by having effective documentation compiled, it facilitates the design process, enabling designers, development and product teams to have a better flow in terms of productivity (measured in successful iterative processes, workshops and other relevant activities).
  • 9.  Measuring the success of documentation properly gathered. In order to summarize this article and to best advocate for the usage and creation of effective documentation, I’ll reinstate something that I’ve witnessed while working in different types of enterprises. Consistent, clear, and detailed documentation empower the designer (and teams), to understand context, narrative, and generate a more effective problem solving process, one that is flexible and ever evolving, but also prescient of how other teams within the enterprise are impacted by their decisions. 
  • 12.  Document Structure  By using grids and whitespace, you can keep content interesting and clear:  Grids  Think about a document in terms of sections, using placeholders to organize text and graphics.  White Space  "Experts have learned that readers are attracted to text when white space surrounds it"  White space can be used in margins, hanging indents, line spacing, paragraph length, and paragraph indenting among other textual spacing techniques
  • 13. Content Structure Two major elements:  Lists Help you group information for easier reading, helps emphasize important points, help organize information chronologically. Lists should be formatted and follow guidelines such as keeping items within the list as short as possible and keeping lists parallel in format.
  • 14. Content Structure Headings  Use at least one heading per page of a document  Use substantive wording (Instead of "Costs" use "Production Costs of the FastCopy800)  • Use parallel form in wording-headings of equal value and degree should have the same grammatical form (Using the SmartArt Tool, Adding New Slides, Arranging Slide Elements, are all parallel in grammatical form)  Establish a clear hierarchy with formatting/bolding (make sure readers can tell a heading 1 from a heading 2  User larger type-size for higher level headings; heading position to show ranking (center a title, for example); and typographic elements (bolding italics, color, underline)  Use decimal headings for longer, formal documents