@ John: No no, I know that this wouldn't be the right place. :-) It's just that I want to exhaust all the standard possibilities for documentation that are built into cakephp, so that a later developer will be able to easily manage my codes.
On Thu, Jan 6, 2011 at 12:30 PM, John Andersen <j.andersen...@gmail.com> wrote: > By scratch - do you by that mean that you will gather the > requirements, make a specification, build an analysis model, build a > design model, implement the design, etc.? > Best wishes, > John > > On 4 Jan., 16:07, psybear83 <psybea...@gmail.com> wrote: >> Hey everybody >> >> I have to start a small CakePHP application from scratch. I want to do >> this in a highly professional way, which also means that I want to >> properly document the project. >> >> Besides documenting the sources properly, I'm wondering how to >> document other stuff centrally, e.g. business rules, requirements, >> purpose of the project etc.? Should this all be put into the README >> file? Or should I write Word documents and put them somewhere in the >> project (e.g. app/docs/)? >> >> Indeed, it would be very nice to be able to document everything within >> the sources and then compiling PHPDoc and having a complete >> documentation of the whole project. But though I basically know how to >> use PHPDoc, I don't know how to use it best or to what extent it can/ >> should be used. >> >> Maybe there's a good project somewhere in a SVN/GIT repository that I >> could take a look at and apply its documenting principles to my >> project? Or a best practices blog post about this topic? >> >> Thanks a lot for help >> Josh > > Check out the new CakePHP Questions site http://cakeqs.org and help others > with their CakePHP related questions. > > You received this message because you are subscribed to the Google Groups > "CakePHP" group. > To post to this group, send email to cake-php@googlegroups.com > To unsubscribe from this group, send email to > cake-php+unsubscr...@googlegroups.com For more options, visit this group at > http://groups.google.com/group/cake-php?hl=en > Check out the new CakePHP Questions site http://cakeqs.org and help others with their CakePHP related questions. You received this message because you are subscribed to the Google Groups "CakePHP" group. To post to this group, send email to cake-php@googlegroups.com To unsubscribe from this group, send email to cake-php+unsubscr...@googlegroups.com For more options, visit this group at http://groups.google.com/group/cake-php?hl=en
