Oh, the dreaded option number 4... I'd say good luck.  It's a relatively
easy but time-eating task but not trivial at all.

To be honest, whenver I do a similar task, I end up rewriting the whole
thing.  I hope you're not tempted...


Kayjey



-----Oorspronkelijk bericht-----
Van: Mike Furmedge [mailto:mike(at)clockworx.co.uk]
Verzonden: donderdag 7 juni 2001 16:40
Aan: Klaas De Waele
CC: Hwg-Techniques@Hwg. Org
Onderwerp: RE: 



	Hi Klaas,

	I've got most of the documentation done now but a lot of it fell
more into
the category of 'What on EARTH is this doing here?!'

	I've decided that because the documentation needs doing before the
site can
be rebuilt I've concentrated on listing the functionality of the site rather
than the exact mechanics - i.e the purpose of the page rather than how it
fulfills that purpose.

	Thanks to all that offered suggestions,

Mike Furmedge
Web Developer
Clockworx Design
www.clockworx.co.uk
Tel: (+44) 01785 216150
Fax: (+44) 01785 216151

-----Original Message-----
From: Klaas De Waele [mailto:klaas(at)gracegraphics.be]
Sent: 06 June 2001 07:56
To: 'Mike Furmedge'
Subject: RE:


It depends on what they think is documenting.  If ther asp involved or php
or anything, you'll have to also comment the code in there.

Documenting a website is indeed a timeconsuming task but it's fairly easy.
In fact, what you should try to do is hand out answers to any of these
questions.

- Hey, what's that for?
- Hey, why did you do it that way?
- Hey, what's this thing doing here?


- Kayjey -


-----Oorspronkelijk bericht-----
Van: owner-hwg-techniques(at)hwg.org
[mailto:owner-hwg-techniques(at)hwg.org]Namens Mike Furmedge
Verzonden: dinsdag 5 juni 2001 17:35
Aan: Advanced HTML List
Onderwerp: RE:




	Hi All,

	I've got a pretty nasty task ahead of me and I was wondering if
anyone knew
of anything that may help.  I've got to document a large website that's been
patched repeatedly for a number of years and nobody has ever done any
documentation whatsoever on it.  I've never had to do something like this
before so I'm wondering what elements of it I should document?  If anyone
knows of any knowledgebase articles or anything or could point me at a good
example of a site-documentation then I'd be really grateful.....at the
moment I feel like I'm mapping russia with a compass and a tape-measure :(

	Any advice appreciated!

Mike Furmedge
Web Developer
Clockworx Design
www.clockworx.co.uk
Tel: (+44) 01785 216150
Fax: (+44) 01785 216151




 

• Web Designer Courses
• Off the Shelf Training Courses

HWG hwg-techniques mailing list archives, maintained by Webmasters @ IWA