I like to: a) Write a sitemape (using http://www.omnigroup.com/applications/OmniGraffle/) and put colored background boxes of modules (i.e. app/front-end/ modules/) so you can clearly see on all the pages belonging to a module and it tends to segregate the sites functionality too so requirements of each page become clearer. b) Get an automated ER diagram made (Using http://www.malcolmhardie.com/sqleditor/ ) of the database'sDoctrine Entites, then move the tables around into their respective business domain or purpose again packages/ business domains (not the same set as controller modules) and the domains/packages should be colored background boxes (i.e. sfGuard plugin has its own package for role based access control for example. and is one of about a dozen packages that will make up a mid-sized R.I.A) c) Get some mockups of UI, Workflow forms [including a rendering of the form objects/classes that will need to be built to provide your controllers RESTfull actions], data-grids, template and look and feel (Using Balsamic Mockups, thanks for the tip from Jobeet chapter 2,) be sure you use the 960 grid super imposed or some layout convention/ framework your comfortable with. e) Design in UML,(Again in OmniGraffle) packages or business domain architecture, or important design patterns, which will include the business objects in lib/model that in lib/model/doctrine, (i.e. aren't entities) this will include factories if you have them, Custom Collection objects, Custom Composite objects (When ORM relationships arnt enough), API clients or servers, WorkFlow enabling objects ( Managers/Handlers, i.e. RegistrationManager/RegistrationHandler <- same meaning to me, just be consistent in naming, call them BackingBeans...if you like java notation)
All of these activities consist of "software documentation" without actually going and commenting code, you can get large or advance designs documented, and thus can be communicated. All the software tools above require a license, but sometimes you got to give before you can get, and I know that for each of those tools: a) you will be helping software engineers realize their entripenerial dreams leading you to some satisfaction. b) you will produce better results and faster thus leading to more satisfaction. c) The license are not that expensive if you are serious about software development or want to advance in R.I.A production with the right toolset (i.e along with your TextMate and Netbeans for PHP [latest version keeps getting better] or eclipse I.D.E) On Oct 30, 5:25 am, "Kropp, Henning" <[email protected]> wrote: > Yes I ment code documentation. Sorry, that i did not make my self clear. > > I am trying PhpDocumentor with not so much of a success and was > wondering if symfony offers any support. > > I am also coding with netbeans and would have liked an easy integration > like javadoc. > > Thanks > > Gareth McCumskey schrieb: > > > What do you mean by documentation? Code documentation for other > > developers? Usability documentation for end users? > > > If you mean code documentation you can use PHPDoc style comments above > > all your class methods etc that can then by automatically compiled > > into an API reference by many PHPDoc generation tools. > > > On Fri, Oct 30, 2009 at 2:12 PM, Kropp, Henning <[email protected] > > <mailto:[email protected]>> wrote: > > > Hi, > > > is there any support in symfony to support project documentation? What > > is best practice to document once symfony project? > > > Thank you very much > > Henning Kropp > > > -- > > Gareth McCumskey > >http://garethmccumskey.blogspot.com > > twitter: @garethmcc --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "symfony users" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [email protected] For more options, visit this group at http://groups.google.com/group/symfony-users?hl=en -~----------~----~----~----~------~----~------~--~---
