Documentation for a database driven site

25 Jun 2007 - 11:55am
7 years ago
1 reply
337 reads
lachica
2006

Hello,

What types of documentation should I prepare on our website to orient a new
web developer? Could anyone refer me to templates or descriptions of best
practices?

We have a large ecommerce site powered by a database and additional
informational pages about the company. As a small company we only have a few
people involved with the site and have little formal documentation in place.

Thanks,
Julie

Comments

25 Jun 2007 - 6:06pm
Bruce Esrig
2006

Hi Julie,

My suggestions ... considering that you don't have a lot of formal
documentation ...

Perhaps you could find out what has to be installed in order to give a new
developer all the tools they need. Include some instructions on how to
configure the software that is installed.

Along the way, you can build an architectural view and narration that
explains why those tools are needed and how they support one another.

The architectural view presents the storage systems, presentation methods,
and communication methods that are supported. The narration explains what
has to be done at each phase of a typical development cycle.

If you need to explain how the site is built, specifically, that should be
very close to the sort of design documents that information architects
commonly produce. An explanation of site structure and a few sample page
templates, at a minimum. Add to that any special mechanisms that let things
happen on the site that wouldn't just happen by themselves if the engine
for the site were used in its default way.

Best wishes,

Bruce Esrig

At 12:55 PM 6/25/2007, lachica wrote:
>Hello,
>
>What types of documentation should I prepare on our website to orient a new
>web developer? Could anyone refer me to templates or descriptions of best
>practices?
>
>We have a large ecommerce site powered by a database and additional
>informational pages about the company. As a small company we only have a few
>people involved with the site and have little formal documentation in place.
>
>
>Thanks,
>Julie
>________________________________________________________________
>Welcome to the Interaction Design Association (IxDA)!
>To post to this list ....... discuss at ixda.org
>List Guidelines ............ http://beta.ixda.org/guidelines
>List Help .................. http://beta.ixda.org/help
>Unsubscribe ................ http://beta.ixda.org/unsubscribe
>Questions .................. list at ixda.org
>Home ....................... http://beta.ixda.org

Syndicate content Get the feed