[thelist] Re: A Different POV

P. Z. cliverping at hotmail.com
Wed Feb 6 10:33:01 CST 2002


[ Converted text/html to text/plain ]

I think one more thing might should be included in the list of things in
documentation should be: project team (with contact info).  I am updating a
web project which is done years ago, we couldn't find some source files
(photoshop images), and nobody has any contact info for this project. Great!
>
>
>Basic Documentation should have the following sections;
>Definitions - All terms that may not have an immediately
>recognizable
>meaning in this context.
>Scope of Work - An outline of what it will take to accomplish the
>core of
>this particular project. If it ain't in this scope, charge extra for
>it.
>Workflow Models - Descriptions of interfaces and where they go, what
>they
>do, and what the end result is. (i.e. User clicks on link, logs in,
>and is
>presented with an interface offering these choices. When he/she
>clicks on
>this choice he/she is presented with this information and these
>choices,
>and so on, and so on.)
>Back-End Information - Database tables (in detail), administrative
>passwords, etc.
>Milestone List (Project Tracking) - can be as simple as having a
>list of
>things which needs to be done, and a place to put the date of
>completion.
>Could have spots for the developer and the client to initial.
>Potential Mods/Adds for the Future -
>This is the place to identify things seen during the development
>process
>that can be improved, but would be considered "scope creep' if we
>just went
>ahead and did them.
>Also include flowcharts, data diagrams, workflow diagrams, etc.
>
>
>--
>For unsubscribe and other options, including
>the Tip Harvester and archive of thelist go to:
>http://lists.evolt.org Workers of the Web, evolt !

------------------------------------------------------------------------------
享用世界上最大的 Web 电子邮件系统 ―― MSN Hotmail。请您单击此处[1]

===References:===
  1. http://go.msn.com/bql/hmtag2_etl_CN.asp




More information about the thelist mailing list