In Struts in Action, as with many text books, we included "Developer information" at the foot of a section or chapter as appropriate. So first, we covered the "user" material and then we covered the "developer" material, without creating two content streams. I don't see that mixing the two is a bad thing, or that separating the two is a good thing. Users do need to know that the framework is extensible, even if they don't want to extend it today.
I would agree it would be helpful to add more "Developer information" to the project documentation, by adding pages for "Writing Interceptors" and "Writing Actions". * http://struts.apache.org/2.x/docs/guides.html People who don't want to write such things now, can just skip past those pages, until the occasion arises. Once place where I'd say we could use a separate guide is where we get into internal components, like the ObjectFactory and ActionMappers, which could be push into a separate "Architects Guide". * http://struts.apache.org/2.x/docs/architects-guide.html I would also agree that the bootstrap tutorial should be extended to include a CRUD tutorial. After a longer tutorial, I believe any reasonable person could read and understand the rest of the documentation. -Ted. On 2/14/07, Philip Luppens <[EMAIL PROTECTED]> wrote:
I understand we don't want duplicated docs, but at the moment, we have to realize our Developers Guide is a mix of a Users Guide, Developers Guide and Reference Guide. If we take the following 'definitions' into account: - Developers: in-depth architecture, creating and extending Interceptors, Results, Validators, Themes, Templates, Plugins, .. - Users: explain the high level architecture, create Actions, create Views, configuration of the webapp (struts.xml, using annotations, mapping, ..), .. - Reference: contains the explanation and docs for each Validator, Interceptor, Result, Annotation, .. by using the snippet macro. I believe we can rearrange the docs fairly easily based on the list above (I understand it would mean a lot of work - but I'm ok with that and willing to step up for it). The amount of duplicated docs should be reduced to a minimum. Otoh, we could keep the current Developers Guide, and just provide an 'easy' outline or view for users that links to the current Developers Guide. Thoughts ? Phil
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
