Examples of web application system documentation?

26 Apr 2006 - 2:55pm
8 years ago
2 replies
6899 reads
Patricia Mourthé
2005

Hi all,
Where could I find good examples of web application system documentation? Are there best practices and standards that I could rely upon?
We are customizing a web ordering (which we are proprietary) for a client and just delivered its system documentation (site maps, processes flows with notifications, high level interactions between web servers and databases, system structure description, and main screens descriptions – not at the object level but with emphasis on main functionalities). The client came back to us saying that this documentation does not work for them because it was at the user level and not the system level – programming/database architecture and logic – what he really needs.
We never had to provide this level of documentation to another client before and would like to know if it is a standard industry requirement we are unaware of or a requirement specific to the client.
Thank you in advance for the help and info.
Patricia

---------------------------------
New Yahoo! Messenger with Voice. Call regular phones from your PC and save big.

Comments

26 Apr 2006 - 2:56pm
Patricia Mourthé
2005

Hi all,
Where could I find good examples of web application system documentation? Are there best practices and standards that I could rely upon?
We are customizing a web ordering (which we are proprietary) for a client and just delivered its system documentation (site maps, processes flows with notifications, high level interactions between web servers and databases, system structure description, and main screens descriptions – not at the object level but with emphasis on main functionalities). The client came back to us saying that this documentation does not work for them because it was at the user level and not the system level – programming/database architecture and logic – what he really needs.
We never had to provide this level of documentation to another client before and would like to know if it is a standard industry requirement we are unaware of or a requirement specific to the client.
Thank you in advance for the help and info.
Patricia

---------------------------------
Celebrate Earth Day everyday! Discover 10 things you can do to help slow climate change. Yahoo! Earth Day

26 Apr 2006 - 5:48pm
Steve Baty
2009

Patricia,

I have to equivocate and say: "It depends on the project brief."

Is the client the one developing the application? If not, I don't think that
such documentation is necessary as an external deliverable. If they are,
then it is more understandable them asking for such documentation, although
I'm surprised in that case they wouldn't want to design that aspect of the
application itself.

So, what was the brief to you? From the sounds of things: "We are
customizing a web ordering..." - you should be focused on documentation of
the apparent customisation taking place. If that includes low-level database
customisation based on client input, then, again, I can understand their
wish for documentation.

Best Regards,

Steve Baty
Director, User Experience Strategy
Red Square

On 27/04/06, Patricia Mourthé <patriciamoh at yahoo.com> wrote:
>
> [Please voluntarily trim replies to include only relevant quoted
> material.]
>
> Hi all,
> Where could I find good examples of web application system
> documentation? Are there best practices and standards that I could rely
> upon?
> We are customizing a web ordering (which we are proprietary) for a
> client and just delivered its system documentation (site maps, processes
> flows with notifications, high level interactions between web servers and
> databases, system structure description, and main screens descriptions – not
> at the object level but with emphasis on main functionalities). The client
> came back to us saying that this documentation does not work for them
> because it was at the user level and not the system level –
> programming/database architecture and logic – what he really needs.
> We never had to provide this level of documentation to another client
> before and would like to know if it is a standard industry requirement we
> are unaware of or a requirement specific to the client.
> Thank you in advance for the help and info.
> Patricia
>
>
>
> ---------------------------------
> Celebrate Earth Day everyday! Discover 10 things you can do to help slow
> climate change. Yahoo! Earth Day
> ________________________________________________________________
> Welcome to the Interaction Design Association (IxDA)!
> To post to this list ....... discuss at ixda.org
> List Guidelines ............ http://listguide.ixda.org/
> List Help .................. http://listhelp.ixda.org/
> (Un)Subscription Options ... http://subscription-options.ixda.org/
> Announcements List ......... http://subscribe-announce.ixda.org/
> Questions .................. lists at ixda.org
> Home ....................... http://ixda.org/
> Resource Library ........... http://resources.ixda.org
>

Syndicate content Get the feed