Php Site Documentation

[phpprogrammer]

Hai,

I think PREPARING DOCUMENTATION IS ALSO A ONE IMPORTANT STAGE IN A PROJECT

Any one suggest some good sites which will give the steps/information for

HOW TO PREPARE DOCUMENTATION FOR A SITE/PROJECT

regards
bvsureshbabu

[planetsim]

I dont know any but i have done a couse that involved righting good manuals.. Had to eventually make one for Installing Linux etc...

But my advice is know your audience, speak there language (Dont give technical words to a programming newbie etc).. But saying that it can also depend on what the manual is for?

[phpprogrammer]

hai,

My question

how can We prepare DOCUMENTAION for a website

regards
bvsureshbabu

[superwormy]

Depends on what kinda documentation you want...

Here, our documentation is simply commenting our code.

At my other job, it's using PHPDoc or PHP Documentor to generate code, and commenting out stuff using the PHP Documentor code blocks.

[phpprogrammer]

hai,

before generating the protype we are going to analyse the project requirements, and the design phases

for designing we have to prepare a document for designing ie

which includes highleveldesigning,lowleveldesigning, drawing flow charts etc,,

is there any site which gives information for preparing documentation in the designing work

regards
bvsureshbabu