Agreed!! As part of my work to get complex features on trunk I would like to take part in this as well. In general I find our geotools documentation to be quite confusing.
First off we have three wikis which i can infer are broken up like follows: GEOTDOC: User Guide GEOT: Developers Guide GEOTOOLS: The front end to both of the above Which I guess is not that confusing now that I have just figured it out :). However I am a bit concerned about the content of the users guide. Now this is just my opinion but its *way* to verbose, in many places it looks like a design document (talking about interface vs implementation, bit architecture diagrams, etc...). I think it would be way more effective if it was to the point and just a series of examples, basically a howto list: * How to reproject from one crs to another * How to read a shapefile * How to parse a gml document And the list goes on. Basically just a series of examples well organized into categories. Perhaps I am beating a dead horse here but I think on of the problem may be that the "User Guide" actually cators to two groups of users: * Those who want to do something quick and dirty * Those who want to do some advanced programming against geotools apis (like implement a datastore) Perhaps the second should be grouped into a "Programmers Guide". Anyways sorry if this brings your initial thread off topic Adrian, its more just a rant I have been meaning to do for a while. And I know this is not anything new as people (such as yourself) i believe think along a similar line. Its just that with this round of feature model work i will have an opportunity to do a good chunk of documentation so I would like to do it right. End-of-rant -Justin Adrian Custer wrote: > Hey Jody, > > Since you are the documentation extrodinaire, I wonder if we could > schedule a short documentation sprint to cleanup the Feature docs. We > have documentation in lots of places: > > Geoapi feature package > Geoapi Feature > Geoapi FeatureFactory > > Geotools feature package > Geotools Feature > Geotools FeatureFactory > Geotools FeatureCollection > Geotools FeatureType > > UserGuide Main (missing any feature page) > UserGuide FeatureType (refs to 19107 should be to 19109, no?) > UserGuide FeatureCollection > > I realize that we will have to re-do this for complex-feature but > perhaps it's worth the time making the 2.4.x series clean. This could > also lay the ground work for the next iteration. Anyhow, if you are game > to help with the info, I'm game to participate in the editing. I figure > in one hour or two we could have a pretty good foundation for this core > concept. > > Anyone else who felt like playing would, of course, be more than > welcome... :-) > > --adrian > > > ------------------------------------------------------------------------- > This SF.net email is sponsored by DB2 Express > Download DB2 Express C - the FREE version of DB2 express and take > control of your XML. No limits. Just data. Click to get it now. > http://sourceforge.net/powerbar/db2/ > _______________________________________________ > Geotools-devel mailing list > [email protected] > https://lists.sourceforge.net/lists/listinfo/geotools-devel > > !DSPAM:4007,468cd470150421137850744! > -- Justin Deoliveira The Open Planning Project http://topp.openplans.org ------------------------------------------------------------------------- This SF.net email is sponsored by DB2 Express Download DB2 Express C - the FREE version of DB2 express and take control of your XML. No limits. Just data. Click to get it now. http://sourceforge.net/powerbar/db2/ _______________________________________________ Geotools-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/geotools-devel
