'ZF Patterns' Documentation Proposal

View: New views
2 Messages — Rating Filter:   Alert me  

'ZF Patterns' Documentation Proposal

by Carlton Gibson-2 :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

Hi all,

#
Before I start: I've done my CLA etc but can't find the 'submit a new  
proposal link' otherwise I'd have put this there. Can anybody help me  
here?

#
In the meantime can I solicit thoughts on adding a Zend Framework  
Design Patterns section to the documentation?

The same (or similar) questions very frequently come up, particularly  
on the MVC mailing list. A recent example might be how best to do  
sidebars and wigetised content.

Here there are several options: the ActionStack, Zend_View  
Placeholders, the Action View Helper and so on. There are different  
costs and benefits to using each of these solutions in different  
cases, and as well as an example, a design pattern could include a  
"use when ... " hint.

My example for this would be the Yahoo! Design Pattern Library (link  
below). I think it really adds something to the documentation—you  
could reconstruct the pattern examples from the manual but it is a  
nice extra.

Just quickly I would suggest the following as benefits:

  - Shows multiple components working together.

  - Allows the programmer's reference examples to remain simple (by  
moving complex but common cases to a pattern).

  - Smoother learning curve and better adoption/development of best  
practices.

References:
Yahoo! Design Pattern Library - http://developer.yahoo.com/ypatterns/

#
Somebody is probably going to tell me that this proposal already  
exists, in which case I'm happy to join up, but if not, is it  
something people think is a good idea? (If so—if I can work out how—
I'll write it up for the Wiki.)

Regards,
Carlton

Re: 'ZF Patterns' Documentation Proposal

by Joó Ádám :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

Would be a nice improvement.


Ádám