Well options are: - user manual, ordered intro to toolkit with explanations and background information (written in docbook) - user guide, provides example w/ context with no explanation - developers guide, this has process and some explanations (so it is probably the best fit)
Sounds like we should break out a design section for the developers guide, but we really should establish who your target audience for the "xml developers guide". If this document is not focused on users then is it needed :-D Jody > Hi Jody, > > Yeah, its definitley not documentation for users. My intended target is > to make it part of the xml developers guide. I just didn't have a good > place to put it. Any suggestions? > > > Jody Garnett wrote: > >> Hi Justin, been catching up on new content in the GEOSDOC space ... >> >> http://docs.codehaus.org/display/GEOTDOC/XML+Developers+Guide >> >> And it's first batch of content: >> http://docs.codehaus.org/display/GEOTDOC/0+Parser+Execution >> >> This material seems thus far to be more on the order of a design >> document, I really want to keep the user guide short/sweet with very >> little by way of explanation/justification. >> >> Normally for this kind of thing I would capture them as a series of >> articles (like we did with Factory/Interface questions). Kind of looks >> like you want more structure ... >> > Hmm, don't think that really works here. I need to have a complete > documentation that explains exactly what the parser does, not something > high level that explains what it can do. > >> What is da' plan man? >> >> Cheers, >> Jody >> >> !DSPAM:1004,4596204973414750375898! >> >> > > > ------------------------------------------------------------------------- Take Surveys. Earn Cash. Influence the Future of IT Join SourceForge.net's Techsay panel and you'll get the chance to share your opinions on IT & business topics through brief surveys - and earn cash http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV _______________________________________________ Geotools-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/geotools-devel
