"Technical documentation" is a subjective thing in most web development
houses I've worked for. However, in my opinion, the need for and content of
technical documentation (part of the "deliverables", as referred to by some
people) needs to be part of the initial design, planning and discovery stage
for any given project. The scope of technical docs varies from project to
project and from developer to client as well. I have done projects where a
readme.txt file was all the customer required. On the other hand, I have
done projects where the technical documentation contained massive amounts of
instructions [user's manual], code, screen captures of individual screens,
etc. Also, keep in mind that a consistent comments policy within the code
templates can help to cut down on the amount of technical documentation as
well.
I don't mean to be vague with my answer but I don't think a question like
this can be answered in a definitive manner as each job/project/customer
comes with its own needs and requirements in my experience. I suppose the
main thing to keep in mind is how the contract is written. If the client
will end up owning the codebase and all the work, they may want more
in-depth documentation. If, on the other hand, the developer retains
ownership of the codebase and is only licensing it to a specific client,
there is less need of this kind of in-depth documentation.
Cheers,
--
David L. Rice
Web Development Consultant
[EMAIL PROTECTED]
Q: 177820
24/7 cell: 770.354.5953
----------------------------
> -----Original Message-----
> From: Erika Foster [mailto:[EMAIL PROTECTED]]
> Sent: Friday, April 28, 2000 10:53 AM
> To: [EMAIL PROTECTED]
> Subject: Re: Technical Documentation
>
>
> I'm interested in knowing what kind of documentation everyone
> provides their
> clients as well since I'm delivering my first product on
> Monday morning.
> Since no one has replied to this post, I'm wondering if
> anyone PROVIDES
> documentation??
>
> Erika
>
------------------------------------------------------------------------------
Archives: http://www.eGroups.com/list/cf-talk
To Unsubscribe visit
http://www.houseoffusion.com/index.cfm?sidebar=lists&body=lists/cf_talk or send a
message to [EMAIL PROTECTED] with 'unsubscribe' in the body.
