Documentation: Choosing the Right Tool for the Job

Dan Brown
Dan BrownInformation Architect and UX Designer
Choosing the Right Tool
  User Experience Week 2007 • Washington, DC

                Dan Brown
          Principal, EightShapes, LLC
2
Documentation: Choosing the Right Tool for the Job
War is bad!
5
Longitude




                                Latitude
Number of troops

                             Direction




                      Time
        Temperature


                                                       5
• Define
• Elaborate
• Enhance
Anchors
                    Steps
                    Paths
               Decision Points
• Define      Step Distinctions
               Step Variations
• Elaborate    Step Groupings
                 Step Details
• Enhance        Error Paths
                   Triggers
                  Scenarios
                     etc...
Anchors
                    Steps
                    Paths
               Decision Points
• Define      Step Distinctions
               Step Variations
• Elaborate    Step Groupings
                 Step Details
• Enhance        Error Paths
                   Triggers
                  Scenarios
                     etc...
7
8
9
Choice of Moment
❖

❖ Choice of Frame

❖ Choice of Image

❖ Choice of Word

❖ Choice of Flow




                     10
From BPRD: Garden of Souls #5 © Dark Horse Comics
                                                    11
From BPRD: Garden of Souls #5 © Dark Horse Comics
                                                    11
From BPRD: Garden of Souls #5 © Dark Horse Comics
                                                    11
From BPRD: Garden of Souls #5 © Dark Horse Comics
                                                    11
From Fallen Son: Iron Man #5 © Marvel Comics
                                               12
From New Avengers #32 © Marvel Comics
                                        13
14




     From Making Comics © 2006 Scott McCloud
What aspects of the user   What level of detail are   How are you going to
experience are you going    you going to show?         represent abstract
        to show?                                           concepts?




                                                                             From Making Comics © 2006 Scott McCloud
            How are you going to        How are you going to work
           describe the experience?      within the constraints of
                                              the medium?
                                                                             14
• Purpose of document
• Document’s audience
• Project context
• Information on-hand
16
Document detailed interactions
•
• Account for different user groups
• Show business rules
• Prioritize steps in flow

                                      16
Aspects = steps, decisions, errors
•
• Detail = medium
• Description = labeling
• Abstraction = high
• Constraints = swimlanes

                                       16
॰‫ ݏ‬ԏ
     ৺ӹ৺ ‫ݏ‬

      XXXXXX > XXXXXX > XXXXXX
                                      • The LIST TEMPLATE provides a page structure for
                    ÿ XXX | XXX | XXX   displaying lists of objects--campaigns, pages, or alerts.
                                                            • Each campaign has lists dedicated to pages and alerts.
              XXXXXXXXX XXX | XXX | XXX
                                                            • Each campaign also has a quot;watchlistquot;, rendered in the same
              XXXXXXXXX XXX | XXX | XXX
                                                              template, that combines both pages and alerts.
              XXXXXXXXX XXX | XXX | XXX
                                                            • Users may add pages and alerts to the watchlist, though a
              XXXXXXXXX XXX | XXX | XXX
                                                              campaign's watchlist is shared by all users of the system.
              XXXXXXXXX XXX | XXX | XXX
              XXXXXXXXX XXX | XXX | XXX
              XXXXXXXXX XXX | XXX | XXX
              XXXXXXXXX XXX | XXX | XXX



        &                                                                             &                                                                                 &                                                                               )        quot;

            [Client name]                                                                 [Client name]       [Campaign name]                                               [Client name]      [Campaign name]                                              [Client name]    Watchlist



 (          Active      By Label        By Host       All                                 By Visits     By Date               By Label     All                              By Date      By Label               All                                         NONE



            Compare Export      Label                                                     Compare Export           Label                                                    Compare Export           Label                                                  Compare Export         Label




            By Label        Filter by label: select label...                              By Date              Show pages launched on:             mm/dd/yyyy               By Date             Show alerts launched on:           mm/dd/yyyy
                                                                                                                                                                                                                                                            NONE

            By Host          Filter by host:   select host...                             By Label             Filter by label: select label...                             By Label            Filter by label: select label...




&#             [Name of Campaign]                                                                              [Name of Page]                                                                   [Name of Alert]                                                       [launch date] [Name of Item]
                                               watch list   alerts list   page list           [launch date]                              add to/remove from watchlist          [launch date]                          add to/remove from watchlist                                                              remove from watchlist

                                                                                                               [page title]                                                                     [alert title]                                                                      [item title]
                                                                                                                                                                                                                                                            OR
                                                                                                               [list of labels]                                                                 [list of labels]                                                                   [list of labels]




                                                                                                                                                                                                                                            Grassroots Enterprises                            Dan Brown
                                                                                                                                                                                                                             client:                                         prepared by:
                                                                                                                                                                                                                                            Reports Module Redesign                           Thu Feb 22 2007
                                                                                                                                                                                                                             project:                                        date:
                                                                                                                                                                                                                                                                                                                          Page 4 of 5
                                                                                                                                                                                                                                            Speci cation                                      1.0
                                                                                                                                                                                                                             document:                                       version:




                                                                                                                                                                                                                                                                                                                                        17
॰‫ ݏ‬ԏ
     ৺ӹ৺ ‫ݏ‬

      XXXXXX > XXXXXX > XXXXXX
                                      • The LIST TEMPLATE provides a page structure for
                    ÿ XXX | XXX | XXX   displaying lists of objects--campaigns, pages, or alerts.
                                                            • Each campaign has lists dedicated to pages and alerts.
              XXXXXXXXX XXX | XXX | XXX
                                                            • Each campaign also has a quot;watchlistquot;, rendered in the same
              XXXXXXXXX XXX | XXX | XXX
                                                              template, that combines both pages and alerts.
              XXXXXXXXX XXX | XXX | XXX
                                                            • Users may add pages and alerts to the watchlist, though a
              XXXXXXXXX XXX | XXX | XXX
                                                              campaign's watchlist is shared by all users of the system.
              XXXXXXXXX XXX | XXX | XXX
              XXXXXXXXX XXX | XXX | XXX
              XXXXXXXXX XXX | XXX | XXX
              XXXXXXXXX XXX | XXX | XXX



        &                                                                             &                                                                                 &                                                                               )        quot;

            [Client name]                                                                 [Client name]       [Campaign name]                                               [Client name]      [Campaign name]                                              [Client name]    Watchlist



 (          Active      By Label        By Host       All                                 By Visits     By Date               By Label     All                              By Date      By Label               All                                         NONE



            Compare Export      Label                                                     Compare Export           Label                                                    Compare Export           Label                                                  Compare Export         Label




            By Label        Filter by label: select label...                              By Date              Show pages launched on:             mm/dd/yyyy               By Date             Show alerts launched on:           mm/dd/yyyy
                                                                                                                                                                                                                                                            NONE

            By Host          Filter by host:   select host...                             By Label             Filter by label: select label...                             By Label            Filter by label: select label...


                                                                            Aspects = set of pages
                                                                          •
&#             [Name of Campaign]                                                                              [Name of Page]                                                                   [Name of Alert]                                                       [launch date] [Name of Item]
                                               watch list   alerts list   page list           [launch date]                              add to/remove from watchlist          [launch date]                          add to/remove from watchlist                                                              remove from watchlist

                                                                                                               [page title]                                                                     [alert title]                                                                      [item title]
                                                                                                                                                                                                                                                            OR



                                                                          • Detail = high
                                                                                                               [list of labels]                                                                 [list of labels]                                                                   [list of labels]




                                                                          • Description = minimal
                                                                          • Abstraction = A LOT
                                                                          • Constraints = highly abstract, limit detail
                                                                                                                                                                                                                                            Grassroots Enterprises                            Dan Brown
                                                                                                                                                                                                                             client:                                         prepared by:
                                                                                                                                                                                                                                            Reports Module Redesign                           Thu Feb 22 2007
                                                                                                                                                                                                                             project:                                        date:
                                                                                                                                                                                                                                                                                                                          Page 4 of 5
                                                                                                                                                                                                                                            Speci cation                                      1.0
                                                                                                                                                                                                                             document:                                       version:




                                                                                                                                                                                                                                                                                                                                        17
॰‫ ݏ‬ԏ
     ৺ӹ৺ ‫ݏ‬

      XXXXXX > XXXXXX > XXXXXX
                                      • The LIST TEMPLATE provides a page structure for
                    ÿ XXX | XXX | XXX   displaying lists of objects--campaigns, pages, or alerts.
                                                            • Each campaign has lists dedicated to pages and alerts.
              XXXXXXXXX XXX | XXX | XXX
                                                            • Each campaign also has a quot;watchlistquot;, rendered in the same
              XXXXXXXXX XXX | XXX | XXX
                                                              template, that combines both pages and alerts.
              XXXXXXXXX XXX | XXX | XXX
                                                            • Users may add pages and alerts to the watchlist, though a
              XXXXXXXXX XXX | XXX | XXX
                                                              campaign's watchlist is shared by all users of the system.
              XXXXXXXXX XXX | XXX | XXX
              XXXXXXXXX XXX | XXX | XXX
              XXXXXXXXX XXX | XXX | XXX
              XXXXXXXXX XXX | XXX | XXX



        &                                                                             &                                                                                 &

            [Client name]                                                                 [Client name]       [Campaign name]                                               [Client name]      [Campaign name]



 (          Active      By Label        By Host       All                                 By Visits     By Date               By Label     All                              By Date      By Label               All



            Compare Export      Label                                                     Compare Export           Label                                                    Compare Export           Label



            By Label        Filter by label: select label...                              By Date              Show pages launched on:             mm/dd/yyyy               By Date             Show alerts launche



            By Host          Filter by host:   select host...                             By Label             Filter by label: select label...                             By Label            Filter by label: sele




&#             [Name of Campaign]                                                                              [Name of Page]                                                                   [Name of Alert]
                                               watch list   alerts list   page list           [launch date]                              add to/remove from watchlist          [launch date]

                                                                                                               [page title]                                                                     [alert title]

                                                                                                               [list of labels]                                                                 [list of labels]



                                                                                                                                                                                                                      18
॰‫ ݏ‬ԏ
     ৺ӹ৺ ‫ݏ‬

      XXXXXX > XXXXXX > XXXXXX
                                      • The LIST TEMPLATE provides a page structure for
                    ÿ XXX | XXX | XXX   displaying lists of objects--campaigns, pages, or alerts.
                                                            • Each campaign has lists dedicated to pages and alerts.
              XXXXXXXXX XXX | XXX | XXX
                                                            • Each campaign also has a quot;watchlistquot;, rendered in the same
              XXXXXXXXX XXX | XXX | XXX
                                                              template, that combines both pages and alerts.
              XXXXXXXXX XXX | XXX | XXX
                                                            • Users may add pages and alerts to the watchlist, though a
              XXXXXXXXX XXX | XXX | XXX
                                                              campaign's watchlist is shared by all users of the system.
              XXXXXXXXX XXX | XXX | XXX
              XXXXXXXXX XXX | XXX | XXX
              XXXXXXXXX XXX | XXX | XXX
              XXXXXXXXX XXX | XXX | XXX



        &                                                                             &                                                                                 &

            [Client name]                                                                 [Client name]       [Campaign name]                                               [Client name]      [Campaign name]



 (          Active      By Label        By Host       All                                 By Visits     By Date               By Label     All                              By Date      By Label               All



            Compare Export      Label                                                     Compare Export           Label                                                    Compare Export           Label




                                                                                                                               Multiple audiences:
            By Label        Filter by label: select label...                              By Date              Show pages launched on:             mm/dd/yyyy               By Date             Show alerts launche




                                                                                                                               • Stakeholders
            By Host          Filter by host:   select host...                             By Label             Filter by label: select label...                             By Label            Filter by label: sele




                                                                                                                               • Technologists
&#             [Name of Campaign]                                                                              [Name of Page]                                                                   [Name of Alert]
                                               watch list   alerts list   page list           [launch date]                              add to/remove from watchlist          [launch date]

                                                                                                               [page title]                                                                     [alert title]

                                                                                                               [list of labels]                                                                 [list of labels]



                                                                                                                                                                                                                      18
॰‫ ݏ‬ԏ
     ৺ӹ৺ ‫ݏ‬

      XXXXXX > XXXXXX > XXXXXX
                                      • The LIST TEMPLATE provides a page structure for
                    ÿ XXX | XXX | XXX   displaying lists of objects--campaigns, pages, or alerts.
                                                            • Each campaign has lists dedicated to pages and alerts.
              XXXXXXXXX XXX | XXX | XXX
                                                            • Each campaign also has a quot;watchlistquot;, rendered in the same
              XXXXXXXXX XXX | XXX | XXX
                                                              template, that combines both pages and alerts.
              XXXXXXXXX XXX | XXX | XXX
                                                            • Users may add pages and alerts to the watchlist, though a
              XXXXXXXXX XXX | XXX | XXX
                                                              campaign's watchlist is shared by all users of the system.
              XXXXXXXXX XXX | XXX | XXX
              XXXXXXXXX XXX | XXX | XXX
              XXXXXXXXX XXX | XXX | XXX
              XXXXXXXXX XXX | XXX | XXX



        &                                                                             &                                                                                 &

            [Client name]                                                                 [Client name]       [Campaign name]                                               [Client name]      [Campaign name]



 (          Active      By Label        By Host       All                                 By Visits     By Date               By Label     All                              By Date      By Label               All



            Compare Export      Label                                                     Compare Export           Label                                                    Compare Export           Label




                                                                                                                               one audience:
            By Label        Filter by label: select label...                              By Date              Show pages launched on:             mm/dd/yyyy               By Date             Show alerts launche



            By Host          Filter by host:   select host...                             By Label             Filter by label: select label...                             By Label            Filter by label: sele




&#             [Name of Campaign]                                                                              [Name of Page]                                                                   [Name of Alert]
                                               watch list   alerts list   page list           [launch date]                              add to/remove from watchlist          [launch date]

                                                                                                               [page title]                                                                     [alert title]

                                                                                                               [list of labels]                                                                 [list of labels]



                                                                                                                                                                                                                      18
॰‫ ݏ‬ԏ
     ৺ӹ৺ ‫ݏ‬

      XXXXXX > XXXXXX > XXXXXX
                                      • The LIST TEMPLATE provides a page structure for
                    ÿ XXX | XXX | XXX   displaying lists of objects--campaigns, pages, or alerts.
                                                            • Each campaign has lists dedicated to pages and alerts.
              XXXXXXXXX XXX | XXX | XXX
                                                            • Each campaign also has a quot;watchlistquot;, rendered in the same
              XXXXXXXXX XXX | XXX | XXX
                                                              template, that combines both pages and alerts.
              XXXXXXXXX XXX | XXX | XXX
                                                            • Users may add pages and alerts to the watchlist, though a
              XXXXXXXXX XXX | XXX | XXX
                                                              campaign's watchlist is shared by all users of the system.
              XXXXXXXXX XXX | XXX | XXX
              XXXXXXXXX XXX | XXX | XXX
              XXXXXXXXX XXX | XXX | XXX
              XXXXXXXXX XXX | XXX | XXX



        &                                                                             &                                                                                 &

            [Client name]                                                                 [Client name]       [Campaign name]                                               [Client name]      [Campaign name]



 (          Active      By Label        By Host       All                                 By Visits     By Date               By Label     All                              By Date      By Label               All



            Compare Export      Label                                                     Compare Export           Label                                                    Compare Export           Label




                                                                                                                               one audience:
            By Label        Filter by label: select label...                              By Date              Show pages launched on:             mm/dd/yyyy               By Date             Show alerts launche



            By Host          Filter by host:   select host...                             By Label             Filter by label: select label...                             By Label            Filter by label: sele




                                                                                                                               •ME
&#             [Name of Campaign]                                                                              [Name of Page]                                                                   [Name of Alert]
                                               watch list   alerts list   page list           [launch date]                              add to/remove from watchlist          [launch date]

                                                                                                               [page title]                                                                     [alert title]

                                                                                                               [list of labels]                                                                 [list of labels]



                                                                                                                                                                                                                      18
Purpose = explain business rules
•

    Audience = stakeholders, technologists, others?
•

    Context = requirements elicitation
•

    Information = meeting notes
•
Aspect = rules constraining interactions
•

    Detail = as much as possible
•

    Describe = rule “headline” and details
•

    Abstractions = visualize
•

    Constraints = incorporate pictures
•
Unused activation                                Passes expire at 23:59 CT
   Activation codes expire                                                                                                                                                   Client can create passes
                                                                   codes expire after                                on the third day after
        after one use.                                                                                                                                                           for distribution.
                                                                  predetermined date.                                      activation.
                                                                                                                                                                             Passes may be created by either the Marketing
                                                                                                                      Su      M      T      W        Th      F       Sa
                                                                                                                                                                            Department or Customer Service, and each will be
                                                                                                                                                                                 coded uniquely for tracking purposes.
                                                                                      
                                                                                                                                                                           Passes created by Client may break any of the rules in
                                                                                                                                                                                     this row (expiration and duration).
                                                                                                                      Pass Activated Here        Pass Expires Here

The system will be exible so Client can create passes       The system will be exible so Client can create codes   The system will be exible so Client can create passes
          that can be used more than one.                               that have longer lifespans.                          that last longer than three days.



                                                                                                                      Every pass is a quot;childquot;
 Guest registrations share                                    Subscribers are allowed                                                                                         All dates and times are
                                                                                                                      account assigned to a
   the namespace with                                           ve invitations a day.                                                                                             in Central Time.
                                                                                                                     quot;super-parentquot; account.
  regular subscriptions
                                                        Tuesday               Wednesday                 Thursday

                                                                                                                                         CHILD            CHILD
                                   SUBSCRIBER
                                                                                                                                                  CHILD
     GUEST                                                                                                                  SUPER
                                                                                                                           PARENT
                                                                                                                                         CHILD
                                                                                                                                                            CHILD
                     NAMESPACE
                                                                                                                                                  CHILD




                                                                                                                                                                                                                             21
ion               Passes expire at 23:59 CT
                                                                            Client
ter                on the third day after
                                                                                fo
 ate.                    activation.
                                                                           Passes may
                    Su      M      T      W       Th      F       Sa
                                                                          Department o
                                                                               coded u

                                                                         Passes created
                                                                                   this ro
                    Pass Activated Here       Pass Expires Here

n create codes   The system will be exible so Client can create passes
s.                         that last longer than three days.



                      Every pass is a quot;childquot;
owed                                                                         All da   22
Purpose = define scope of content
•

    Audience = stakeholders, money
•

    Context = direction-setting
•

    Information = none
•
Aspect = relationship between key content
•

    Detail = as little as possible
•

    Describe = label concepts
•

    Abstractions = line formatting, color coding
•

    Constraints = limit depth and detail
•
25
Thanks!
Dan Brown
dan@eightshapes.com

www.communicatingdesign.com
1 of 39

Recommended

It Employee Change Request Form by
It Employee Change Request FormIt Employee Change Request Form
It Employee Change Request FormMitch Willis
1.6K views2 slides
Social Networking for The Technical Writer by
Social Networking for The Technical WriterSocial Networking for The Technical Writer
Social Networking for The Technical WriterMitch Willis
2.2K views26 slides
Bernard Aschwanden press release by
Bernard Aschwanden press release Bernard Aschwanden press release
Bernard Aschwanden press release Mitch Willis
456 views2 slides
Writing great documentation - CodeConf 2011 by
Writing great documentation - CodeConf 2011Writing great documentation - CodeConf 2011
Writing great documentation - CodeConf 2011Jacob Kaplan-Moss
4.2K views61 slides
Doing Implementation Documentation Right by
Doing Implementation Documentation RightDoing Implementation Documentation Right
Doing Implementation Documentation RightSynchrono
360 views21 slides
Social Media Marketing Plan by
Social Media Marketing PlanSocial Media Marketing Plan
Social Media Marketing PlanMitch Willis
1.2K views6 slides

More Related Content

Similar to Documentation: Choosing the Right Tool for the Job

[DSBW Spring 2009] Unit 04: From Requirements to the UX Model by
[DSBW Spring 2009] Unit 04: From Requirements to the UX Model[DSBW Spring 2009] Unit 04: From Requirements to the UX Model
[DSBW Spring 2009] Unit 04: From Requirements to the UX ModelCarles Farré
861 views31 slides
Building Silverlight & Wpf Applications With Prism by
Building Silverlight & Wpf Applications With PrismBuilding Silverlight & Wpf Applications With Prism
Building Silverlight & Wpf Applications With PrismDavid Chou
1.2K views20 slides
Music Recommender Systems by
Music Recommender SystemsMusic Recommender Systems
Music Recommender Systemszhu02
900 views28 slides
Crunching Data with Google BigQuery. JORDAN TIGANI at Big Data Spain 2012 by
Crunching Data with Google BigQuery. JORDAN TIGANI at Big Data Spain 2012Crunching Data with Google BigQuery. JORDAN TIGANI at Big Data Spain 2012
Crunching Data with Google BigQuery. JORDAN TIGANI at Big Data Spain 2012Big Data Spain
4.4K views71 slides
Clearspring Widgetsphere by
Clearspring WidgetsphereClearspring Widgetsphere
Clearspring Widgetsphereeraz
374 views25 slides
Flink Forward San Francisco 2018: Aris Koliopoulos & Alex Garella - "Panta R... by
Flink Forward San Francisco 2018:  Aris Koliopoulos & Alex Garella - "Panta R...Flink Forward San Francisco 2018:  Aris Koliopoulos & Alex Garella - "Panta R...
Flink Forward San Francisco 2018: Aris Koliopoulos & Alex Garella - "Panta R...Flink Forward
973 views73 slides

Similar to Documentation: Choosing the Right Tool for the Job(20)

[DSBW Spring 2009] Unit 04: From Requirements to the UX Model by Carles Farré
[DSBW Spring 2009] Unit 04: From Requirements to the UX Model[DSBW Spring 2009] Unit 04: From Requirements to the UX Model
[DSBW Spring 2009] Unit 04: From Requirements to the UX Model
Carles Farré861 views
Building Silverlight & Wpf Applications With Prism by David Chou
Building Silverlight & Wpf Applications With PrismBuilding Silverlight & Wpf Applications With Prism
Building Silverlight & Wpf Applications With Prism
David Chou1.2K views
Music Recommender Systems by zhu02
Music Recommender SystemsMusic Recommender Systems
Music Recommender Systems
zhu02900 views
Crunching Data with Google BigQuery. JORDAN TIGANI at Big Data Spain 2012 by Big Data Spain
Crunching Data with Google BigQuery. JORDAN TIGANI at Big Data Spain 2012Crunching Data with Google BigQuery. JORDAN TIGANI at Big Data Spain 2012
Crunching Data with Google BigQuery. JORDAN TIGANI at Big Data Spain 2012
Big Data Spain4.4K views
Clearspring Widgetsphere by eraz
Clearspring WidgetsphereClearspring Widgetsphere
Clearspring Widgetsphere
eraz374 views
Flink Forward San Francisco 2018: Aris Koliopoulos & Alex Garella - "Panta R... by Flink Forward
Flink Forward San Francisco 2018:  Aris Koliopoulos & Alex Garella - "Panta R...Flink Forward San Francisco 2018:  Aris Koliopoulos & Alex Garella - "Panta R...
Flink Forward San Francisco 2018: Aris Koliopoulos & Alex Garella - "Panta R...
Flink Forward973 views
Efficient Filtering in Pub-Sub Systems using BDD by Nabeel Yoosuf
Efficient Filtering in Pub-Sub Systems using BDDEfficient Filtering in Pub-Sub Systems using BDD
Efficient Filtering in Pub-Sub Systems using BDD
Nabeel Yoosuf2.1K views
UI Test Automation Effectiveness by SQALab
UI Test Automation EffectivenessUI Test Automation Effectiveness
UI Test Automation Effectiveness
SQALab512 views
The Building Blocks Of Modularity by LittleBIGRuby
The Building Blocks Of ModularityThe Building Blocks Of Modularity
The Building Blocks Of Modularity
LittleBIGRuby1.3K views
Drivetribe: A Social Network on Streams by C4Media
Drivetribe: A Social Network on StreamsDrivetribe: A Social Network on Streams
Drivetribe: A Social Network on Streams
C4Media269 views
A Critical Look at Fixtures by ActsAsCon
A Critical Look at FixturesA Critical Look at Fixtures
A Critical Look at Fixtures
ActsAsCon334 views
Learn C# Includes The C# 3.0 Features by ZEZUA Z.
Learn C# Includes The C# 3.0 FeaturesLearn C# Includes The C# 3.0 Features
Learn C# Includes The C# 3.0 Features
ZEZUA Z.1.5K views
Refactoring at Large by Danilo Sato
Refactoring at LargeRefactoring at Large
Refactoring at Large
Danilo Sato8.1K views
SUGCON ANZ 2022 Sitecore Personalize Technical.pptx by Jitendra Soni
SUGCON ANZ 2022 Sitecore Personalize Technical.pptxSUGCON ANZ 2022 Sitecore Personalize Technical.pptx
SUGCON ANZ 2022 Sitecore Personalize Technical.pptx
Jitendra Soni60 views
Measure Right the First Time - Infusionsoft Partnercon by Vuurr
Measure Right the First Time - Infusionsoft PartnerconMeasure Right the First Time - Infusionsoft Partnercon
Measure Right the First Time - Infusionsoft Partnercon
Vuurr5.4K views

More from Dan Brown

Information Architecture Lenses - by Dan Brown by
Information Architecture Lenses - by Dan BrownInformation Architecture Lenses - by Dan Brown
Information Architecture Lenses - by Dan BrownDan Brown
1.5K views44 slides
IA Lenses: Helpful perspectives for information architects by
IA Lenses: Helpful perspectives for information architectsIA Lenses: Helpful perspectives for information architects
IA Lenses: Helpful perspectives for information architectsDan Brown
2.4K views58 slides
Crafting the Discovery Phase: Starting Design Projects Right by
Crafting the Discovery Phase: Starting Design Projects RightCrafting the Discovery Phase: Starting Design Projects Right
Crafting the Discovery Phase: Starting Design Projects RightDan Brown
4.6K views85 slides
Eight Principles of Information Architecture by
Eight Principles of Information ArchitectureEight Principles of Information Architecture
Eight Principles of Information ArchitectureDan Brown
54.3K views39 slides
Difficult Conversations in Creative Environments ~ IA Summit 2009 by
Difficult Conversations in Creative Environments ~ IA Summit 2009Difficult Conversations in Creative Environments ~ IA Summit 2009
Difficult Conversations in Creative Environments ~ IA Summit 2009Dan Brown
12K views57 slides
Modeling Concepts ~ IA Summit 2009 by
Modeling Concepts ~ IA Summit 2009Modeling Concepts ~ IA Summit 2009
Modeling Concepts ~ IA Summit 2009Dan Brown
9.6K views61 slides

More from Dan Brown(12)

Information Architecture Lenses - by Dan Brown by Dan Brown
Information Architecture Lenses - by Dan BrownInformation Architecture Lenses - by Dan Brown
Information Architecture Lenses - by Dan Brown
Dan Brown1.5K views
IA Lenses: Helpful perspectives for information architects by Dan Brown
IA Lenses: Helpful perspectives for information architectsIA Lenses: Helpful perspectives for information architects
IA Lenses: Helpful perspectives for information architects
Dan Brown2.4K views
Crafting the Discovery Phase: Starting Design Projects Right by Dan Brown
Crafting the Discovery Phase: Starting Design Projects RightCrafting the Discovery Phase: Starting Design Projects Right
Crafting the Discovery Phase: Starting Design Projects Right
Dan Brown4.6K views
Eight Principles of Information Architecture by Dan Brown
Eight Principles of Information ArchitectureEight Principles of Information Architecture
Eight Principles of Information Architecture
Dan Brown54.3K views
Difficult Conversations in Creative Environments ~ IA Summit 2009 by Dan Brown
Difficult Conversations in Creative Environments ~ IA Summit 2009Difficult Conversations in Creative Environments ~ IA Summit 2009
Difficult Conversations in Creative Environments ~ IA Summit 2009
Dan Brown12K views
Modeling Concepts ~ IA Summit 2009 by Dan Brown
Modeling Concepts ~ IA Summit 2009Modeling Concepts ~ IA Summit 2009
Modeling Concepts ~ IA Summit 2009
Dan Brown9.6K views
Designing Rules ~ IA Summit 2009 by Dan Brown
Designing Rules ~ IA Summit 2009Designing Rules ~ IA Summit 2009
Designing Rules ~ IA Summit 2009
Dan Brown3.4K views
Concept Models ~ Interaction08 by Dan Brown
Concept Models ~ Interaction08Concept Models ~ Interaction08
Concept Models ~ Interaction08
Dan Brown3.7K views
Beyond Wireframes from Voices That Matter (Oct 2007) by Dan Brown
Beyond Wireframes from Voices That Matter (Oct 2007)Beyond Wireframes from Voices That Matter (Oct 2007)
Beyond Wireframes from Voices That Matter (Oct 2007)
Dan Brown1.3K views
Documentation Workshop @ IA Summit by Dan Brown
Documentation Workshop @ IA SummitDocumentation Workshop @ IA Summit
Documentation Workshop @ IA Summit
Dan Brown2.5K views
Communicating Design Session @ IA Summit by Dan Brown
Communicating Design Session @ IA SummitCommunicating Design Session @ IA Summit
Communicating Design Session @ IA Summit
Dan Brown2.7K views
Dan Brown's Communicating Design Presentation to DOE by Dan Brown
Dan Brown's Communicating Design Presentation to DOEDan Brown's Communicating Design Presentation to DOE
Dan Brown's Communicating Design Presentation to DOE
Dan Brown4.2K views

Recently uploaded

Top 5 educational movie by
Top 5 educational movieTop 5 educational movie
Top 5 educational movieSunjedaAkterSumaiya
5 views5 slides
RESUME (Updated) by
RESUME (Updated)RESUME (Updated)
RESUME (Updated)bvtp649ry8
9 views1 slide
polaris script by
polaris scriptpolaris script
polaris scriptscribdgrudge308
14 views14 slides
Mann-Mayal-Novel-By-Aileen-Noor-Episode2.pdf by
Mann-Mayal-Novel-By-Aileen-Noor-Episode2.pdfMann-Mayal-Novel-By-Aileen-Noor-Episode2.pdf
Mann-Mayal-Novel-By-Aileen-Noor-Episode2.pdfnovelsmag
8 views17 slides
RESUME by
RESUMERESUME
RESUMEbvtp649ry8
9 views1 slide
FA kala Ilam specialist in Pakistan , sifli jadu expert +92-3217066670 #amilb... by
FA kala Ilam specialist in Pakistan , sifli jadu expert +92-3217066670 #amilb...FA kala Ilam specialist in Pakistan , sifli jadu expert +92-3217066670 #amilb...
FA kala Ilam specialist in Pakistan , sifli jadu expert +92-3217066670 #amilb...#Astrologer
5 views29 slides

Recently uploaded(15)

Mann-Mayal-Novel-By-Aileen-Noor-Episode2.pdf by novelsmag
Mann-Mayal-Novel-By-Aileen-Noor-Episode2.pdfMann-Mayal-Novel-By-Aileen-Noor-Episode2.pdf
Mann-Mayal-Novel-By-Aileen-Noor-Episode2.pdf
novelsmag8 views
FA kala Ilam specialist in Pakistan , sifli jadu expert +92-3217066670 #amilb... by #Astrologer
FA kala Ilam specialist in Pakistan , sifli jadu expert +92-3217066670 #amilb...FA kala Ilam specialist in Pakistan , sifli jadu expert +92-3217066670 #amilb...
FA kala Ilam specialist in Pakistan , sifli jadu expert +92-3217066670 #amilb...
#Astrologer5 views
Gwyneth Paltrow rejects Nepo Baby as her name reason by danealbwp228
Gwyneth Paltrow rejects Nepo Baby as her name reasonGwyneth Paltrow rejects Nepo Baby as her name reason
Gwyneth Paltrow rejects Nepo Baby as her name reason
danealbwp2287 views
Fun Session 3 Movie Quiz.pptx by ssuserd156e61
Fun Session 3 Movie Quiz.pptxFun Session 3 Movie Quiz.pptx
Fun Session 3 Movie Quiz.pptx
ssuserd156e6113 views
Mann-Mayal-Novel-By-Aileen-Noor-Episode2.pdf by novelsmag
Mann-Mayal-Novel-By-Aileen-Noor-Episode2.pdfMann-Mayal-Novel-By-Aileen-Noor-Episode2.pdf
Mann-Mayal-Novel-By-Aileen-Noor-Episode2.pdf
novelsmag7 views

Documentation: Choosing the Right Tool for the Job

  • 1. Choosing the Right Tool User Experience Week 2007 • Washington, DC Dan Brown Principal, EightShapes, LLC
  • 2. 2
  • 5. 5
  • 6. Longitude Latitude Number of troops Direction Time Temperature 5
  • 8. Anchors Steps Paths Decision Points • Define Step Distinctions Step Variations • Elaborate Step Groupings Step Details • Enhance Error Paths Triggers Scenarios etc...
  • 9. Anchors Steps Paths Decision Points • Define Step Distinctions Step Variations • Elaborate Step Groupings Step Details • Enhance Error Paths Triggers Scenarios etc...
  • 10. 7
  • 11. 8
  • 12. 9
  • 13. Choice of Moment ❖ ❖ Choice of Frame ❖ Choice of Image ❖ Choice of Word ❖ Choice of Flow 10
  • 14. From BPRD: Garden of Souls #5 © Dark Horse Comics 11
  • 15. From BPRD: Garden of Souls #5 © Dark Horse Comics 11
  • 16. From BPRD: Garden of Souls #5 © Dark Horse Comics 11
  • 17. From BPRD: Garden of Souls #5 © Dark Horse Comics 11
  • 18. From Fallen Son: Iron Man #5 © Marvel Comics 12
  • 19. From New Avengers #32 © Marvel Comics 13
  • 20. 14 From Making Comics © 2006 Scott McCloud
  • 21. What aspects of the user What level of detail are How are you going to experience are you going you going to show? represent abstract to show? concepts? From Making Comics © 2006 Scott McCloud How are you going to How are you going to work describe the experience? within the constraints of the medium? 14
  • 22. • Purpose of document • Document’s audience • Project context • Information on-hand
  • 23. 16
  • 24. Document detailed interactions • • Account for different user groups • Show business rules • Prioritize steps in flow 16
  • 25. Aspects = steps, decisions, errors • • Detail = medium • Description = labeling • Abstraction = high • Constraints = swimlanes 16
  • 26. ॰‫ ݏ‬ԏ ৺ӹ৺ ‫ݏ‬ XXXXXX > XXXXXX > XXXXXX • The LIST TEMPLATE provides a page structure for ÿ XXX | XXX | XXX displaying lists of objects--campaigns, pages, or alerts. • Each campaign has lists dedicated to pages and alerts. XXXXXXXXX XXX | XXX | XXX • Each campaign also has a quot;watchlistquot;, rendered in the same XXXXXXXXX XXX | XXX | XXX template, that combines both pages and alerts. XXXXXXXXX XXX | XXX | XXX • Users may add pages and alerts to the watchlist, though a XXXXXXXXX XXX | XXX | XXX campaign's watchlist is shared by all users of the system. XXXXXXXXX XXX | XXX | XXX XXXXXXXXX XXX | XXX | XXX XXXXXXXXX XXX | XXX | XXX XXXXXXXXX XXX | XXX | XXX & & & ) quot; [Client name] [Client name] [Campaign name] [Client name] [Campaign name] [Client name] Watchlist ( Active By Label By Host All By Visits By Date By Label All By Date By Label All NONE Compare Export Label Compare Export Label Compare Export Label Compare Export Label By Label Filter by label: select label... By Date Show pages launched on: mm/dd/yyyy By Date Show alerts launched on: mm/dd/yyyy NONE By Host Filter by host: select host... By Label Filter by label: select label... By Label Filter by label: select label... &# [Name of Campaign] [Name of Page] [Name of Alert] [launch date] [Name of Item] watch list alerts list page list [launch date] add to/remove from watchlist [launch date] add to/remove from watchlist remove from watchlist [page title] [alert title] [item title] OR [list of labels] [list of labels] [list of labels] Grassroots Enterprises Dan Brown client: prepared by: Reports Module Redesign Thu Feb 22 2007 project: date: Page 4 of 5 Speci cation 1.0 document: version: 17
  • 27. ॰‫ ݏ‬ԏ ৺ӹ৺ ‫ݏ‬ XXXXXX > XXXXXX > XXXXXX • The LIST TEMPLATE provides a page structure for ÿ XXX | XXX | XXX displaying lists of objects--campaigns, pages, or alerts. • Each campaign has lists dedicated to pages and alerts. XXXXXXXXX XXX | XXX | XXX • Each campaign also has a quot;watchlistquot;, rendered in the same XXXXXXXXX XXX | XXX | XXX template, that combines both pages and alerts. XXXXXXXXX XXX | XXX | XXX • Users may add pages and alerts to the watchlist, though a XXXXXXXXX XXX | XXX | XXX campaign's watchlist is shared by all users of the system. XXXXXXXXX XXX | XXX | XXX XXXXXXXXX XXX | XXX | XXX XXXXXXXXX XXX | XXX | XXX XXXXXXXXX XXX | XXX | XXX & & & ) quot; [Client name] [Client name] [Campaign name] [Client name] [Campaign name] [Client name] Watchlist ( Active By Label By Host All By Visits By Date By Label All By Date By Label All NONE Compare Export Label Compare Export Label Compare Export Label Compare Export Label By Label Filter by label: select label... By Date Show pages launched on: mm/dd/yyyy By Date Show alerts launched on: mm/dd/yyyy NONE By Host Filter by host: select host... By Label Filter by label: select label... By Label Filter by label: select label... Aspects = set of pages • &# [Name of Campaign] [Name of Page] [Name of Alert] [launch date] [Name of Item] watch list alerts list page list [launch date] add to/remove from watchlist [launch date] add to/remove from watchlist remove from watchlist [page title] [alert title] [item title] OR • Detail = high [list of labels] [list of labels] [list of labels] • Description = minimal • Abstraction = A LOT • Constraints = highly abstract, limit detail Grassroots Enterprises Dan Brown client: prepared by: Reports Module Redesign Thu Feb 22 2007 project: date: Page 4 of 5 Speci cation 1.0 document: version: 17
  • 28. ॰‫ ݏ‬ԏ ৺ӹ৺ ‫ݏ‬ XXXXXX > XXXXXX > XXXXXX • The LIST TEMPLATE provides a page structure for ÿ XXX | XXX | XXX displaying lists of objects--campaigns, pages, or alerts. • Each campaign has lists dedicated to pages and alerts. XXXXXXXXX XXX | XXX | XXX • Each campaign also has a quot;watchlistquot;, rendered in the same XXXXXXXXX XXX | XXX | XXX template, that combines both pages and alerts. XXXXXXXXX XXX | XXX | XXX • Users may add pages and alerts to the watchlist, though a XXXXXXXXX XXX | XXX | XXX campaign's watchlist is shared by all users of the system. XXXXXXXXX XXX | XXX | XXX XXXXXXXXX XXX | XXX | XXX XXXXXXXXX XXX | XXX | XXX XXXXXXXXX XXX | XXX | XXX & & & [Client name] [Client name] [Campaign name] [Client name] [Campaign name] ( Active By Label By Host All By Visits By Date By Label All By Date By Label All Compare Export Label Compare Export Label Compare Export Label By Label Filter by label: select label... By Date Show pages launched on: mm/dd/yyyy By Date Show alerts launche By Host Filter by host: select host... By Label Filter by label: select label... By Label Filter by label: sele &# [Name of Campaign] [Name of Page] [Name of Alert] watch list alerts list page list [launch date] add to/remove from watchlist [launch date] [page title] [alert title] [list of labels] [list of labels] 18
  • 29. ॰‫ ݏ‬ԏ ৺ӹ৺ ‫ݏ‬ XXXXXX > XXXXXX > XXXXXX • The LIST TEMPLATE provides a page structure for ÿ XXX | XXX | XXX displaying lists of objects--campaigns, pages, or alerts. • Each campaign has lists dedicated to pages and alerts. XXXXXXXXX XXX | XXX | XXX • Each campaign also has a quot;watchlistquot;, rendered in the same XXXXXXXXX XXX | XXX | XXX template, that combines both pages and alerts. XXXXXXXXX XXX | XXX | XXX • Users may add pages and alerts to the watchlist, though a XXXXXXXXX XXX | XXX | XXX campaign's watchlist is shared by all users of the system. XXXXXXXXX XXX | XXX | XXX XXXXXXXXX XXX | XXX | XXX XXXXXXXXX XXX | XXX | XXX XXXXXXXXX XXX | XXX | XXX & & & [Client name] [Client name] [Campaign name] [Client name] [Campaign name] ( Active By Label By Host All By Visits By Date By Label All By Date By Label All Compare Export Label Compare Export Label Compare Export Label Multiple audiences: By Label Filter by label: select label... By Date Show pages launched on: mm/dd/yyyy By Date Show alerts launche • Stakeholders By Host Filter by host: select host... By Label Filter by label: select label... By Label Filter by label: sele • Technologists &# [Name of Campaign] [Name of Page] [Name of Alert] watch list alerts list page list [launch date] add to/remove from watchlist [launch date] [page title] [alert title] [list of labels] [list of labels] 18
  • 30. ॰‫ ݏ‬ԏ ৺ӹ৺ ‫ݏ‬ XXXXXX > XXXXXX > XXXXXX • The LIST TEMPLATE provides a page structure for ÿ XXX | XXX | XXX displaying lists of objects--campaigns, pages, or alerts. • Each campaign has lists dedicated to pages and alerts. XXXXXXXXX XXX | XXX | XXX • Each campaign also has a quot;watchlistquot;, rendered in the same XXXXXXXXX XXX | XXX | XXX template, that combines both pages and alerts. XXXXXXXXX XXX | XXX | XXX • Users may add pages and alerts to the watchlist, though a XXXXXXXXX XXX | XXX | XXX campaign's watchlist is shared by all users of the system. XXXXXXXXX XXX | XXX | XXX XXXXXXXXX XXX | XXX | XXX XXXXXXXXX XXX | XXX | XXX XXXXXXXXX XXX | XXX | XXX & & & [Client name] [Client name] [Campaign name] [Client name] [Campaign name] ( Active By Label By Host All By Visits By Date By Label All By Date By Label All Compare Export Label Compare Export Label Compare Export Label one audience: By Label Filter by label: select label... By Date Show pages launched on: mm/dd/yyyy By Date Show alerts launche By Host Filter by host: select host... By Label Filter by label: select label... By Label Filter by label: sele &# [Name of Campaign] [Name of Page] [Name of Alert] watch list alerts list page list [launch date] add to/remove from watchlist [launch date] [page title] [alert title] [list of labels] [list of labels] 18
  • 31. ॰‫ ݏ‬ԏ ৺ӹ৺ ‫ݏ‬ XXXXXX > XXXXXX > XXXXXX • The LIST TEMPLATE provides a page structure for ÿ XXX | XXX | XXX displaying lists of objects--campaigns, pages, or alerts. • Each campaign has lists dedicated to pages and alerts. XXXXXXXXX XXX | XXX | XXX • Each campaign also has a quot;watchlistquot;, rendered in the same XXXXXXXXX XXX | XXX | XXX template, that combines both pages and alerts. XXXXXXXXX XXX | XXX | XXX • Users may add pages and alerts to the watchlist, though a XXXXXXXXX XXX | XXX | XXX campaign's watchlist is shared by all users of the system. XXXXXXXXX XXX | XXX | XXX XXXXXXXXX XXX | XXX | XXX XXXXXXXXX XXX | XXX | XXX XXXXXXXXX XXX | XXX | XXX & & & [Client name] [Client name] [Campaign name] [Client name] [Campaign name] ( Active By Label By Host All By Visits By Date By Label All By Date By Label All Compare Export Label Compare Export Label Compare Export Label one audience: By Label Filter by label: select label... By Date Show pages launched on: mm/dd/yyyy By Date Show alerts launche By Host Filter by host: select host... By Label Filter by label: select label... By Label Filter by label: sele •ME &# [Name of Campaign] [Name of Page] [Name of Alert] watch list alerts list page list [launch date] add to/remove from watchlist [launch date] [page title] [alert title] [list of labels] [list of labels] 18
  • 32. Purpose = explain business rules • Audience = stakeholders, technologists, others? • Context = requirements elicitation • Information = meeting notes •
  • 33. Aspect = rules constraining interactions • Detail = as much as possible • Describe = rule “headline” and details • Abstractions = visualize • Constraints = incorporate pictures •
  • 34. Unused activation Passes expire at 23:59 CT Activation codes expire Client can create passes codes expire after on the third day after after one use. for distribution. predetermined date. activation. Passes may be created by either the Marketing Su M T W Th F Sa Department or Customer Service, and each will be coded uniquely for tracking purposes.  Passes created by Client may break any of the rules in this row (expiration and duration). Pass Activated Here Pass Expires Here The system will be exible so Client can create passes The system will be exible so Client can create codes The system will be exible so Client can create passes that can be used more than one. that have longer lifespans. that last longer than three days. Every pass is a quot;childquot; Guest registrations share Subscribers are allowed All dates and times are account assigned to a the namespace with ve invitations a day. in Central Time. quot;super-parentquot; account. regular subscriptions Tuesday Wednesday Thursday CHILD CHILD SUBSCRIBER CHILD GUEST SUPER PARENT CHILD CHILD NAMESPACE CHILD 21
  • 35. ion Passes expire at 23:59 CT Client ter on the third day after fo ate. activation. Passes may Su M T W Th F Sa Department o coded u Passes created this ro Pass Activated Here Pass Expires Here n create codes The system will be exible so Client can create passes s. that last longer than three days. Every pass is a quot;childquot; owed All da 22
  • 36. Purpose = define scope of content • Audience = stakeholders, money • Context = direction-setting • Information = none •
  • 37. Aspect = relationship between key content • Detail = as little as possible • Describe = label concepts • Abstractions = line formatting, color coding • Constraints = limit depth and detail •
  • 38. 25