Documenting interaction design specification

28 Dec 2007 - 12:40am
6 years ago
7 replies
2623 reads
Sachendra
2005

What tools do you use for documenting interaction design specification.

I create the interaction model for screens and the flow diagrams and
in MS Visio and import them in MS Word where the interaction model and
flows are described in detail.

Is there a better, more efficient way to do this?

Cheers
Sachendra

Comments

28 Dec 2007 - 9:03am
mtumi
2004

I like wiki. Wiki and mostly Fireworks, because it does both vector
and bitmap, and exports to a number of formats (and the frames and
pages are very handy for working with graphic screens that change
only partially - think states of an app, or webpages). For diagrams
I sometimes use Keynote or Omni Graffle. I will also occasionally do
an animated demo in flash.

some of the things I like about using a wiki:

versioning - mediawiki saves all the old versions so I can rollback
or just diff against an old version
easily accessible to everyone
only one copy of the doc, and the most current one is always in the
same place

there are a number of things that are not great (must upload images
rather than cut and paste, restricting access can be a pain...) but
overall I am a wiki-holic.

I also find that thinking in either an outline format or a numbered
list format (common wiki formats, at least on mediawiki) is
surprisingly helpful. specifications are not the kind of thing that
you want to make more verbose than necessary.

HTH -

MT

On Dec 28, 2007, at 12:40 AM, Sachendra Yadav wrote:

> What tools do you use for documenting interaction design
> specification.
>
> I create the interaction model for screens and the flow diagrams and
> in MS Visio and import them in MS Word where the interaction model and
> flows are described in detail.
>
> Is there a better, more efficient way to do this?
>
> Cheers
> Sachendra
> ________________________________________________________________
> *Come to IxDA Interaction08 | Savannah*
> February 8-10, 2008 in Savannah, GA, USA
> Register today: http://interaction08.ixda.org/
>
> ________________________________________________________________
> Welcome to the Interaction Design Association (IxDA)!
> To post to this list ....... discuss at ixda.org
> Unsubscribe ................ http://www.ixda.org/unsubscribe
> List Guidelines ............ http://www.ixda.org/guidelines
> List Help .................. http://www.ixda.org/help

28 Dec 2007 - 10:03am
Nicholas Iozzo
2007

We have also begun to experiment with a wiki for the reasons you stated.

For drawings we have used Visio. Because Visio has such customization and automation ability, it has been the best so far. If you dig in and create some custom templates and stencils, then you can really move fast.

As an aside, I just figured out how to create glue points for all objects in the stencils. All of the widgets have one. This allows me to glue the labels to the form elements and the form elements to each other. When you building the UI everything snaps into place with perfect and even spacing.

We have been using an object oriented approach to our wireframes and specs (a description of which will be out on our blog after the holidays). But this approach allows you to easily deal with complexity.

We looked at some of the prototyping and specing tools out (Axure, iRise, ProcessView Composer), but have not found any that can handle a great deal of complexity.

For example, one of our clients has a page within the booking process that is made up of 12 modules. Not all modules will always be displayed, some will be displayed based on the role you play. The form they can take on can be different based on your role, actions you did on a prior page, actions you have taken during a prior session, or actions you are taking on that page now. When you do the math, you end up with over 14,000,000 possible states to that page. I have not found any of the prototyping or specing tools that can handle this.

Nick Iozzo
Principal User Experience Architect

tandemseven

847.452.7442 mobile

niozzo at tandemseven.com
http://www.tandemseven.com/

From: Michael Tuminello
Sent: Fri 12/28/2007 8:03 AM
To: IxDA list
Subject: Re: [IxDA Discuss] Documenting interaction design specification

I like wiki. Wiki and mostly Fireworks, because it does both vector
and bitmap, and exports to a number of formats (and the frames and
pages are very handy for working with graphic screens that change
only partially - think states of an app, or webpages). For diagrams
I sometimes use Keynote or Omni Graffle. I will also occasionally do
an animated demo in flash.

some of the things I like about using a wiki:

versioning - mediawiki saves all the old versions so I can rollback
or just diff against an old version
easily accessible to everyone
only one copy of the doc, and the most current one is always in the
same place

there are a number of things that are not great (must upload images
rather than cut and paste, restricting access can be a pain...) but
overall I am a wiki-holic.

I also find that thinking in either an outline format or a numbered
list format (common wiki formats, at least on mediawiki) is
surprisingly helpful. specifications are not the kind of thing that
you want to make more verbose than necessary.

HTH -

MT

On Dec 28, 2007, at 12:40 AM, Sachendra Yadav wrote:

> What tools do you use for documenting interaction design
> specification.
>
> I create the interaction model for screens and the flow diagrams and
> in MS Visio and import them in MS Word where the interaction model and
> flows are described in detail.
>
> Is there a better, more efficient way to do this?
>
> Cheers
> Sachendra
> ________________________________________________________________
> *Come to IxDA Interaction08 | Savannah*
> February 8-10, 2008 in Savannah, GA, USA
> Register today: http://interaction08.ixda.org/
>
> ________________________________________________________________
> Welcome to the Interaction Design Association (IxDA)!
> To post to this list ....... discuss at ixda.org
> Unsubscribe ................ http://www.ixda.org/unsubscribe
> List Guidelines ............ http://www.ixda.org/guidelines
> List Help .................. http://www.ixda.org/help

________________________________________________________________
*Come to IxDA Interaction08 | Savannah*
February 8-10, 2008 in Savannah, GA, USA
Register today: http://interaction08.ixda.org/

________________________________________________________________
Welcome to the Interaction Design Association (IxDA)!
To post to this list ....... discuss at ixda.org
Unsubscribe ................ http://www.ixda.org/unsubscribe
List Guidelines ............ http://www.ixda.org/guidelines
List Help .................. http://www.ixda.org/help

28 Dec 2007 - 4:57pm
mtumi
2004

mediawiki (mediawiki.org). also open source - runs wikipedia.
obviously very scalable. :-) I have also used pmwiki, because I
needed password protection, but I ended up happily back with
mediawiki after some issue.

as far as commercial wikis, i have heard good things about jira,
which adobe is apparently using.

here are a gazillion others:
http://en.wikipedia.org/wiki/List_of_wiki_software

I have plenty of examples, but nothing online at the moment. I'll
see if I can dig something up that wouldn't be proprietary
information (I think I may be hard pressed to do this, but I'll poke
around).

Michael

On Dec 28, 2007, at 11:33 AM, jorge.marquezm at gmail.com wrote:

> We have been experimenting using dokuwiki, an opensource wiki. But
> requieres an aditional effort of customizing the template for the
> wiki.
>
> Which wiki do you use to use? Do you have any online examples of
> documenting Interaction design using wiki?
>
> Jorge Marquez
> Usability consultant at everis
>
>
> Enviado desde mi BlackBerry® de Vodafone
>
> -----Original Message-----
> From: "Nick Iozzo" <niozzo at tandemseven.com>
>
> Date: Fri, 28 Dec 2007 09:03:56
> To:"Michael Tuminello" <mt at motiontek.com>,"IxDA list"
> <discuss at ixda.org>
> Subject: Re: [IxDA Discuss] Documenting interaction design
> specification
>
>
> We have also begun to experiment with a wiki for the reasons you
> stated.
>
> For drawings we have used Visio. Because Visio has such
> customization and automation ability, it has been the best so far.
> If you dig in and create some custom templates and stencils, then
> you can really move fast.
>
> As an aside, I just figured out how to create glue points for all
> objects in the stencils. All of the widgets have one. This allows
> me to glue the labels to the form elements and the form elements to
> each other. When you building the UI everything snaps into place
> with perfect and even spacing.
>
> We have been using an object oriented approach to our wireframes
> and specs (a description of which will be out on our blog after the
> holidays). But this approach allows you to easily deal with
> complexity.
>
> We looked at some of the prototyping and specing tools out (Axure,
> iRise, ProcessView Composer), but have not found any that can
> handle a great deal of complexity.
>
> For example, one of our clients has a page within the booking
> process that is made up of 12 modules. Not all modules will always
> be displayed, some will be displayed based on the role you play.
> The form they can take on can be different based on your role,
> actions you did on a prior page, actions you have taken during a
> prior session, or actions you are taking on that page now. When you
> do the math, you end up with over 14,000,000 possible states to
> that page. I have not found any of the prototyping or specing
> tools that can handle this.
>
> Nick Iozzo
> Principal User Experience Architect
>
> tandemseven
>
> 847.452.7442 mobile
>
> niozzo at tandemseven.com
> http://www.tandemseven.com/
>
>
>
>
> From: Michael Tuminello
> Sent: Fri 12/28/2007 8:03 AM
> To: IxDA list
> Subject: Re: [IxDA Discuss] Documenting interaction design
> specification
>
>
> I like wiki. Wiki and mostly Fireworks, because it does both vector
> and bitmap, and exports to a number of formats (and the frames and
> pages are very handy for working with graphic screens that change
> only partially - think states of an app, or webpages). For diagrams
> I sometimes use Keynote or Omni Graffle. I will also occasionally do
> an animated demo in flash.
>
> some of the things I like about using a wiki:
>
> versioning - mediawiki saves all the old versions so I can rollback
> or just diff against an old version
> easily accessible to everyone
> only one copy of the doc, and the most current one is always in the
> same place
>
> there are a number of things that are not great (must upload images
> rather than cut and paste, restricting access can be a pain...) but
> overall I am a wiki-holic.
>
> I also find that thinking in either an outline format or a numbered
> list format (common wiki formats, at least on mediawiki) is
> surprisingly helpful. specifications are not the kind of thing that
> you want to make more verbose than necessary.
>
> HTH -
>
> MT
>
>
> On Dec 28, 2007, at 12:40 AM, Sachendra Yadav wrote:
>
>> What tools do you use for documenting interaction design
>> specification.
>>
>> I create the interaction model for screens and the flow diagrams and
>> in MS Visio and import them in MS Word where the interaction model
>> and
>> flows are described in detail.
>>
>> Is there a better, more efficient way to do this?
>>
>> Cheers
>> Sachendra
>> ________________________________________________________________
>> *Come to IxDA Interaction08 | Savannah*
>> February 8-10, 2008 in Savannah, GA, USA
>> Register today: http://interaction08.ixda.org/
>>
>> ________________________________________________________________
>> Welcome to the Interaction Design Association (IxDA)!
>> To post to this list ....... discuss at ixda.org
>> Unsubscribe ................ http://www.ixda.org/unsubscribe
>> List Guidelines ............ http://www.ixda.org/guidelines
>> List Help .................. http://www.ixda.org/help
>
> ________________________________________________________________
> *Come to IxDA Interaction08 | Savannah*
> February 8-10, 2008 in Savannah, GA, USA
> Register today: http://interaction08.ixda.org/
>
> ________________________________________________________________
> Welcome to the Interaction Design Association (IxDA)!
> To post to this list ....... discuss at ixda.org
> Unsubscribe ................ http://www.ixda.org/unsubscribe
> List Guidelines ............ http://www.ixda.org/guidelines
> List Help .................. http://www.ixda.org/help
> ________________________________________________________________
> *Come to IxDA Interaction08 | Savannah*
> February 8-10, 2008 in Savannah, GA, USA
> Register today: http://interaction08.ixda.org/
>
> ________________________________________________________________
> Welcome to the Interaction Design Association (IxDA)!
> To post to this list ....... discuss at ixda.org
> Unsubscribe ................ http://www.ixda.org/unsubscribe
> List Guidelines ............ http://www.ixda.org/guidelines
> List Help .................. http://www.ixda.org/help

28 Dec 2007 - 6:08pm
dmitryn
2004

Regarding the use of commercial wikis for documentation, I've had good
success using Atlassian's Confluence (
http://www.atlassian.com/software/confluence/). The markup is reasonably
usable, and there is no need to do much template customization (at least for
general-purpose textual specs with a few image attachments here and there).

I like wiki-based documentation for reasons mentioned by Michael, as well as
for ease of contextual cross-linking. That being said, I have yet to find a
good solution for integrating wikis with prototyping tools like Axure and
Visio.

For my current project, I've ended up creating a set of prototypes in
parallel with the wiki-based specs, and making verbal references to
prototype screens/flows in the specs. This is clearly not ideal, as the two
can easily fall out of sync. I'd be interested to hear if anyone has come up
with a solution to this issue.

Another drawback to the use of wikis for documentation is that their
information architecture must be actively managed and pruned to avoid
duplicate and outdated content. Again, any thoughts on addressing this would
be appreciated.

Dmitry

On Dec 28, 2007 4:57 PM, Michael Tuminello <mt at motiontek.com> wrote:

> mediawiki (mediawiki.org). also open source - runs wikipedia.
> obviously very scalable. :-) I have also used pmwiki, because I
> needed password protection, but I ended up happily back with
> mediawiki after some issue.
>
> as far as commercial wikis, i have heard good things about jira,
> which adobe is apparently using.
>
> here are a gazillion others:
> http://en.wikipedia.org/wiki/List_of_wiki_software
>
>
> I have plenty of examples, but nothing online at the moment. I'll
> see if I can dig something up that wouldn't be proprietary
> information (I think I may be hard pressed to do this, but I'll poke
> around).
>
>
>
> Michael
>
> On Dec 28, 2007, at 11:33 AM, jorge.marquezm at gmail.com wrote:
>
> > We have been experimenting using dokuwiki, an opensource wiki. But
> > requieres an aditional effort of customizing the template for the
> > wiki.
> >
> > Which wiki do you use to use? Do you have any online examples of
> > documenting Interaction design using wiki?
> >
> > Jorge Marquez
> > Usability consultant at everis
> >
> >
> > Enviado desde mi BlackBerry(R) de Vodafone
> >
> > -----Original Message-----
> > From: "Nick Iozzo" <niozzo at tandemseven.com>
> >
> > Date: Fri, 28 Dec 2007 09:03:56
> > To:"Michael Tuminello" <mt at motiontek.com>,"IxDA list"
> > <discuss at ixda.org>
> > Subject: Re: [IxDA Discuss] Documenting interaction design
> > specification
> >
> >
> > We have also begun to experiment with a wiki for the reasons you
> > stated.
> >
> > For drawings we have used Visio. Because Visio has such
> > customization and automation ability, it has been the best so far.
> > If you dig in and create some custom templates and stencils, then
> > you can really move fast.
> >
> > As an aside, I just figured out how to create glue points for all
> > objects in the stencils. All of the widgets have one. This allows
> > me to glue the labels to the form elements and the form elements to
> > each other. When you building the UI everything snaps into place
> > with perfect and even spacing.
> >
> > We have been using an object oriented approach to our wireframes
> > and specs (a description of which will be out on our blog after the
> > holidays). But this approach allows you to easily deal with
> > complexity.
> >
> > We looked at some of the prototyping and specing tools out (Axure,
> > iRise, ProcessView Composer), but have not found any that can
> > handle a great deal of complexity.
> >
> > For example, one of our clients has a page within the booking
> > process that is made up of 12 modules. Not all modules will always
> > be displayed, some will be displayed based on the role you play.
> > The form they can take on can be different based on your role,
> > actions you did on a prior page, actions you have taken during a
> > prior session, or actions you are taking on that page now. When you
> > do the math, you end up with over 14,000,000 possible states to
> > that page. I have not found any of the prototyping or specing
> > tools that can handle this.
> >
> > Nick Iozzo
> > Principal User Experience Architect
> >
> > tandemseven
> >
> > 847.452.7442 mobile
> >
> > niozzo at tandemseven.com
> > http://www.tandemseven.com/
> >
> >
> >
> >
> > From: Michael Tuminello
> > Sent: Fri 12/28/2007 8:03 AM
> > To: IxDA list
> > Subject: Re: [IxDA Discuss] Documenting interaction design
> > specification
> >
> >
> > I like wiki. Wiki and mostly Fireworks, because it does both vector
> > and bitmap, and exports to a number of formats (and the frames and
> > pages are very handy for working with graphic screens that change
> > only partially - think states of an app, or webpages). For diagrams
> > I sometimes use Keynote or Omni Graffle. I will also occasionally do
> > an animated demo in flash.
> >
> > some of the things I like about using a wiki:
> >
> > versioning - mediawiki saves all the old versions so I can rollback
> > or just diff against an old version
> > easily accessible to everyone
> > only one copy of the doc, and the most current one is always in the
> > same place
> >
> > there are a number of things that are not great (must upload images
> > rather than cut and paste, restricting access can be a pain...) but
> > overall I am a wiki-holic.
> >
> > I also find that thinking in either an outline format or a numbered
> > list format (common wiki formats, at least on mediawiki) is
> > surprisingly helpful. specifications are not the kind of thing that
> > you want to make more verbose than necessary.
> >
> > HTH -
> >
> > MT
> >
> >
> > On Dec 28, 2007, at 12:40 AM, Sachendra Yadav wrote:
> >
> >> What tools do you use for documenting interaction design
> >> specification.
> >>
> >> I create the interaction model for screens and the flow diagrams and
> >> in MS Visio and import them in MS Word where the interaction model
> >> and
> >> flows are described in detail.
> >>
> >> Is there a better, more efficient way to do this?
> >>
> >> Cheers
> >> Sachendra
> >> ________________________________________________________________
> >> *Come to IxDA Interaction08 | Savannah*
> >> February 8-10, 2008 in Savannah, GA, USA
> >> Register today: http://interaction08.ixda.org/
> >>
> >> ________________________________________________________________
> >> Welcome to the Interaction Design Association (IxDA)!
> >> To post to this list ....... discuss at ixda.org
> >> Unsubscribe ................ http://www.ixda.org/unsubscribe
> >> List Guidelines ............ http://www.ixda.org/guidelines
> >> List Help .................. http://www.ixda.org/help
> >
> > ________________________________________________________________
> > *Come to IxDA Interaction08 | Savannah*
> > February 8-10, 2008 in Savannah, GA, USA
> > Register today: http://interaction08.ixda.org/
> >
> > ________________________________________________________________
> > Welcome to the Interaction Design Association (IxDA)!
> > To post to this list ....... discuss at ixda.org
> > Unsubscribe ................ http://www.ixda.org/unsubscribe
> > List Guidelines ............ http://www.ixda.org/guidelines
> > List Help .................. http://www.ixda.org/help
> > ________________________________________________________________
> > *Come to IxDA Interaction08 | Savannah*
> > February 8-10, 2008 in Savannah, GA, USA
> > Register today: http://interaction08.ixda.org/
> >
> > ________________________________________________________________
> > Welcome to the Interaction Design Association (IxDA)!
> > To post to this list ....... discuss at ixda.org
> > Unsubscribe ................ http://www.ixda.org/unsubscribe
> > List Guidelines ............ http://www.ixda.org/guidelines
> > List Help .................. http://www.ixda.org/help
>
> ________________________________________________________________
> *Come to IxDA Interaction08 | Savannah*
> February 8-10, 2008 in Savannah, GA, USA
> Register today: http://interaction08.ixda.org/
>
> ________________________________________________________________
> Welcome to the Interaction Design Association (IxDA)!
> To post to this list ....... discuss at ixda.org
> Unsubscribe ................ http://www.ixda.org/unsubscribe
> List Guidelines ............ http://www.ixda.org/guidelines
> List Help .................. http://www.ixda.org/help
>

29 Dec 2007 - 12:00pm
mtumi
2004

BTW, I meant Conflence as well - Jira is Atlassian's issue tracking
software. I get all the made up words confused... :-)

I'd be interested to hear what you mean by integration with
prototyping tools - I poked around a bit, and visio has a web viewer
and axure suggests the following (which are not as nice):

http://axure.com/CS/blogs/axure/archive/2007/03/06/Distributing-
Prototypes.aspx

I just export any images either as web-friendly images or, if people
may need to see something move to understand it, as Flash. You're
right in that they do fall out of sync, in which case you end up
having to go back in and update and rexport the images. That's
another reason I like FW, because you can store multiple screens in a
single document rather than having to open (and keep track of) a
whole bunch of separate documents. It's then one step to reexport
all the images (save frames as files, or save pages as files).

As far as actively managing the information architecture goes, you're
right about that - it can be quite a pain. For that reason, as well
as printing, I have moved towards working with one very long page
rather than having a large number of cross-linked pages. In the case
of an app that requires a lot of documentation, like a desktop app, I
will try to separate some things based on what part of the program
they are in (menus, notifications, preferences) rather than by
functionality (don't do this with dialogs though). I initially tried
separating them by functionality, but that did not work well for the
developers, as they ended up skipping from page to page. You need
to talk to the developers and break it out in a way that is not
disruptive for how they work. establishing a standard naming
convention for pages is also helpful for managing a large number of
pages.

overall I would say one of my biggest complaints about mediawiki is
the lack of any built-in contextual navigation, letting you know
where you've been and where you are in relation to everything else
(breadcrumbs are a 3rd party extension). So I have definitely had
this problem - we may well look into confluence.

Michael

On Dec 28, 2007, at 6:08 PM, Dmitry Nekrasovski wrote:

> Regarding the use of commercial wikis for documentation, I've had
> good success using Atlassian's Confluence (http://www.atlassian.com/
> software/confluence/ ). The markup is reasonably usable, and there
> is no need to do much template customization (at least for general-
> purpose textual specs with a few image attachments here and there).
>
> I like wiki-based documentation for reasons mentioned by Michael,
> as well as for ease of contextual cross-linking. That being said, I
> have yet to find a good solution for integrating wikis with
> prototyping tools like Axure and Visio.
>
> For my current project, I've ended up creating a set of prototypes
> in parallel with the wiki-based specs, and making verbal references
> to prototype screens/flows in the specs. This is clearly not ideal,
> as the two can easily fall out of sync. I'd be interested to hear
> if anyone has come up with a solution to this issue.
>
> Another drawback to the use of wikis for documentation is that
> their information architecture must be actively managed and pruned
> to avoid duplicate and outdated content. Again, any thoughts on
> addressing this would be appreciated.
>
> Dmitry
>
>
> On Dec 28, 2007 4:57 PM, Michael Tuminello <mt at motiontek.com> wrote:
> mediawiki (mediawiki.org). also open source - runs wikipedia.
> obviously very scalable. :-) I have also used pmwiki, because I
> needed password protection, but I ended up happily back with
> mediawiki after some issue.
>
> as far as commercial wikis, i have heard good things about jira,
> which adobe is apparently using.
>
> here are a gazillion others:
> http://en.wikipedia.org/wiki/List_of_wiki_software
>
>
> I have plenty of examples, but nothing online at the moment. I'll
> see if I can dig something up that wouldn't be proprietary
> information (I think I may be hard pressed to do this, but I'll poke
> around).
>
>
>
> Michael
>
> On Dec 28, 2007, at 11:33 AM, jorge.marquezm at gmail.com wrote:
>
> > We have been experimenting using dokuwiki, an opensource wiki. But
> > requieres an aditional effort of customizing the template for the
> > wiki.
> >
> > Which wiki do you use to use? Do you have any online examples of
> > documenting Interaction design using wiki?
> >
> > Jorge Marquez
> > Usability consultant at everis
> >
> >
> > Enviado desde mi BlackBerry® de Vodafone
> >
> > -----Original Message-----
> > From: "Nick Iozzo" < niozzo at tandemseven.com>
> >
> > Date: Fri, 28 Dec 2007 09:03:56
> > To:"Michael Tuminello" <mt at motiontek.com>,"IxDA list"
> > <discuss at ixda.org>
> > Subject: Re: [IxDA Discuss] Documenting interaction design
> > specification
> >
> >
> > We have also begun to experiment with a wiki for the reasons you
> > stated.
> >
> > For drawings we have used Visio. Because Visio has such
> > customization and automation ability, it has been the best so far.
> > If you dig in and create some custom templates and stencils, then
> > you can really move fast.
> >
> > As an aside, I just figured out how to create glue points for all
> > objects in the stencils. All of the widgets have one. This allows
> > me to glue the labels to the form elements and the form elements to
> > each other. When you building the UI everything snaps into place
> > with perfect and even spacing.
> >
> > We have been using an object oriented approach to our wireframes
> > and specs (a description of which will be out on our blog after the
> > holidays). But this approach allows you to easily deal with
> > complexity.
> >
> > We looked at some of the prototyping and specing tools out (Axure,
> > iRise, ProcessView Composer), but have not found any that can
> > handle a great deal of complexity.
> >
> > For example, one of our clients has a page within the booking
> > process that is made up of 12 modules. Not all modules will always
> > be displayed, some will be displayed based on the role you play.
> > The form they can take on can be different based on your role,
> > actions you did on a prior page, actions you have taken during a
> > prior session, or actions you are taking on that page now. When you
> > do the math, you end up with over 14,000,000 possible states to
> > that page. I have not found any of the prototyping or specing
> > tools that can handle this.
> >
> > Nick Iozzo
> > Principal User Experience Architect
> >
> > tandemseven
> >
> > 847.452.7442 mobile
> >
> > niozzo at tandemseven.com
> > http://www.tandemseven.com/
> >
> >
> >
> >
> > From: Michael Tuminello
> > Sent: Fri 12/28/2007 8:03 AM
> > To: IxDA list
> > Subject: Re: [IxDA Discuss] Documenting interaction design
> > specification
> >
> >
> > I like wiki. Wiki and mostly Fireworks, because it does both
> vector
> > and bitmap, and exports to a number of formats (and the frames and
> > pages are very handy for working with graphic screens that change
> > only partially - think states of an app, or webpages). For
> diagrams
> > I sometimes use Keynote or Omni Graffle. I will also
> occasionally do
> > an animated demo in flash.
> >
> > some of the things I like about using a wiki:
> >
> > versioning - mediawiki saves all the old versions so I can rollback
> > or just diff against an old version
> > easily accessible to everyone
> > only one copy of the doc, and the most current one is always in the
> > same place
> >
> > there are a number of things that are not great (must upload images
> > rather than cut and paste, restricting access can be a pain...) but
> > overall I am a wiki-holic.
> >
> > I also find that thinking in either an outline format or a numbered
> > list format (common wiki formats, at least on mediawiki) is
> > surprisingly helpful. specifications are not the kind of thing that
> > you want to make more verbose than necessary.
> >
> > HTH -
> >
> > MT
> >
> >
> > On Dec 28, 2007, at 12:40 AM, Sachendra Yadav wrote:
> >
> >> What tools do you use for documenting interaction design
> >> specification.
> >>
> >> I create the interaction model for screens and the flow diagrams
> and
> >> in MS Visio and import them in MS Word where the interaction model
> >> and
> >> flows are described in detail.
> >>
> >> Is there a better, more efficient way to do this?
> >>
> >> Cheers
> >> Sachendra
> >> ________________________________________________________________
> >> *Come to IxDA Interaction08 | Savannah*
> >> February 8-10, 2008 in Savannah, GA, USA
> >> Register today: http://interaction08.ixda.org/
> >>
> >> ________________________________________________________________
> >> Welcome to the Interaction Design Association (IxDA)!
> >> To post to this list ....... discuss at ixda.org
> >> Unsubscribe ................ http://www.ixda.org/unsubscribe
> >> List Guidelines ............ http://www.ixda.org/guidelines
> >> List Help .................. http://www.ixda.org/help
> >
> > ________________________________________________________________
> > *Come to IxDA Interaction08 | Savannah*
> > February 8-10, 2008 in Savannah, GA, USA
> > Register today: http://interaction08.ixda.org/
> >
> > ________________________________________________________________
> > Welcome to the Interaction Design Association (IxDA)!
> > To post to this list ....... discuss at ixda.org
> > Unsubscribe ................ http://www.ixda.org/unsubscribe
> > List Guidelines ............ http://www.ixda.org/guidelines
> > List Help .................. http://www.ixda.org/help
> > ________________________________________________________________
> > *Come to IxDA Interaction08 | Savannah*
> > February 8-10, 2008 in Savannah, GA, USA
> > Register today: http://interaction08.ixda.org/
> >
> > ________________________________________________________________
> > Welcome to the Interaction Design Association (IxDA)!
> > To post to this list ....... discuss at ixda.org
> > Unsubscribe ................ http://www.ixda.org/unsubscribe
> > List Guidelines ............ http://www.ixda.org/guidelines
> > List Help .................. http://www.ixda.org/help
>
> ________________________________________________________________
> *Come to IxDA Interaction08 | Savannah*
> February 8-10, 2008 in Savannah, GA, USA
> Register today: http://interaction08.ixda.org/
>
> ________________________________________________________________
> Welcome to the Interaction Design Association (IxDA)!
> To post to this list ....... discuss at ixda.org
> Unsubscribe ................ http://www.ixda.org/unsubscribe
> List Guidelines ............ http://www.ixda.org/guidelines
> List Help .................. http://www.ixda.org/help
>

29 Dec 2007 - 12:08pm
mtumi
2004

Oh - regarding having something to share, although I probably can't
share any docs, I don't see any harm in sharing the table of contents
from the top of the wiki page (this is automatically generated by
mediawiki, and they are anchor links).

It looks like in the end even breaking out menus and preferences into
a separate page did not go over well with the developers, as I can
see they have been added back in here. I've added a few spaces to
make it easier to read. Media wiki indents the items, but I'm not
going to take the time to replicate that. :-)

this is for an instant messaging app that also has VoIP and
integrates with a school CMS (hence the "semester transition" item at
the end)

Michael

1 Summary of changes from 1.0
1.1 possibly deferred
2 Related Docs
3 Overview
4 Scenarios
5 Non-Goals
6 Download and Installation
6.1 Installation
7 Sign in
7.1 Sign in window resizing behavior
8 Sign out/disconnect
9 Error reporting
9.1 Error text
9.2 Debug and connection logs
10 Multiple Login/Multiple Launch

11 Dock/Systray/Taskbar behavior
11.1 OS X
11.2 Windows

12 Notifications
12.1 Overview
12.2 General Behavior and Appearance
12.3 Animation

13 Menus
13.1 OS X
13.1.1 Menu Bar
13.1.1.1 Apple
13.1.1.2 Pronto
13.1.1.3 File
13.1.1.4 Edit
13.1.1.5 View
13.1.1.6 Status
13.1.1.7 Contacts
13.1.1.8 Window
13.1.1.9 Help
13.1.2 Contextual Menus
13.1.2.1 Contact List
13.1.2.1.1 Group selected
13.1.2.2 Dock
13.2 Windows
13.2.1 Contact List
13.2.1.1 Pronto
13.2.1.2 Contacts
13.2.1.3 View
13.2.1.4 Help
13.2.2 Message Window
13.2.2.1 File
13.2.2.2 Edit
13.2.2.3 Contact
13.2.2.4 Help
13.2.3 Contextual Menus
13.2.3.1 System Tray
13.2.3.2 Message window content
13.3 Context-specific Menu States
13.3.1 When Signed Out
13.3.1.1 Windows - contact list
13.3.1.2 Windows - message window
13.3.1.3 OS X
13.3.2 Classmates tab active
13.3.3 Group chat active

14 Updates
14.1 Forced update
14.2 Update requirements for lab installation

15 Sounds

16 Events
16.1 Contact Sign on
16.2 Contact Sign off
16.3 Message Received
16.4 Background Message Received
16.5 First Message Received
16.6 Message Sent
16.7 Connect
16.8 Incoming call
16.9 Outgoing call
16.10 Call busy
16.11 Call accepted
16.12 Call declined
16.13 Call cancelled
16.14 Call error
16.15 Call Start
16.16 Call End
16.17 Call Timeout
16.18 Call Missed
16.19 Call Not Answered
16.20 Incoming Group Chat Invite
16.21 Outgoing Group Chat Invite
16.22 Group chat accepted
16.23 Group chat declined
16.24 Group chat connection error
16.25 Join group call
16.26 Leave group call
16.27 (datestamp)
17 IM new message events
17.1 Tab-taskbar new message behavior
18 Offline Communication

19 Non-menu keyboard commands
19.1 General
19.2 Message Window
19.3 Contact List
20 Titlebar

21 Preferences
21.1 General
21.2 Appearance
21.3 Profile
21.4 Status
21.5 Alerts
21.6 Audio
21.7 Privacy

22 Status
22.1 Custom status messages
22.2 status in dock/taskbar
22.3 Details on provided status options
22.4 Blocking and Invisibility
23 Contact List
23.1 Overview
23.2 Manipulating contacts
23.2.1 Moving classmates to contacts
23.2.2 Adding Contacts
23.2.3 Moving contacts inside the contact list
23.2.4 Removing contacts from the contact list
23.2.5 Duplicates in lists
23.2.6 Contact selection
23.2.7 Drag and drop

23.3 Group management
23.4 Find in list
23.5 Link to CMS
23.6 Contact List display details
23.6.1 Show Number of contacts
23.6.2 Show blocked contacts
23.6.3 Indicate teacher/TA role
23.6.4 Tab ordering
23.7 Contact list profiles
23.8 Adding Contacts who are not Classmates

24 Message Window
24.1 Note on drawer windows
24.2 Chat formatting
24.3 Tab behavior
24.4 Typing indicator
24.5 Emoticon selection

25 Calling
25.1 Menus
25.2 Workflows from message window
25.2.1 Basic
25.2.2 Variants
25.2.3 Call-in-progress scenarios
25.2.4 Error messages
25.2.5 Initating a call from a menu
25.3 Event messages
25.4 Getting an incoming call
25.5 Audio chat invites
25.6 Calling someone who is busy on another call
25.7 Calling and multiple message windows
25.8 Calling from the group chat window
25.9 Group chat call in-progress scenarios
25.10 Simultaneous calling

26 Group Chat
26.1 Overview
26.1.1 Menus
26.1.2 Group chat invites
26.1.3 Adding users to group chat
26.1.4 Group chat and online/offline status
26.1.5 Profiles and group chat

27 Chat logging
27.1 Overview
27.1.1 Menus
27.2 Location of files

28 Profiles
28.1 Overview
28.2 Contact List
28.2.1 Profile rollover
28.3 Notifications
28.4 Message Window
29 UI
30 Misc
30.1 Semester Transition

On Dec 28, 2007, at 11:33 AM, jorge.marquezm at gmail.com wrote:

> We have been experimenting using dokuwiki, an opensource wiki. But
> requieres an aditional effort of customizing the template for the
> wiki.
>
> Which wiki do you use to use? Do you have any online examples of
> documenting Interaction design using wiki?
>
> Jorge Marquez
> Usability consultant at everis
>

31 Dec 2007 - 9:28am
vutpakdi
2003

Sachendra Yadav wrote:
> What tools do you use for documenting interaction design specification.
>
I use Canvas from ACD Systems. I created a IxD doc template that I
use. I create the wireframes and mockups (depending on what is needed)
directly within Canvas on the appropriate "page" of the document.
Annotations and notes go to the right of the wireframes. Common
elements go on layers on the Master Page for the document (and Master
Page layers get turned on and off for individual pages as needed).

I use the tabloid page size (11" x 17") so that I can draw the
wireframes at 100% scale with plenty of room for the notes an
annotation. The printer/copier combos that we have at work have tabloid
paper loaded, and Acrobat Reader will scale the document when printing
if the user prints on Letter sized paper (the text is still readable).
On screen viewing can be at a reduced scale or 100% scale (so the
wireframes look the same size as they should appear when implemented).

I also add hyperlnked areas (graphic elements and text) to the
wireframes for buttons and such so that when I save as a PDF, the
document supports what I call "limited clickable navigation" which can
give a reader a limited feel of what going through the mockup and
clicking on buttons, menus, tabs, and such would feel like.

Ron

Syndicate content Get the feed