Originally posted by pk55
Also noticed the Developer's Guide is gone. I don't remember if that happened during the earlier 5.x releases when you switched the Learning Resources or if it disappeared for 6.0 but I do think a single developer doc was way more useful than trying to search 150 pdfs/help files. Just my .02.
|
I'd like to weigh in on the single Developer Guide issue. It was retired for a number of reasons. Yes, it was technically difficult to maintain because, as it approached and passed 300, then 400, then 500 pages, it simply pushed the capabilities of the tools we used to maintain it. But far more importantly, its sheer size and volume of content created more subtle barriers to innovation and maintenance. Material that went into it would tend to stay in it, because it would simply get lost in the sea. Extra difficulty was added to the task of locating and updating all of the material on a given topic.
Atomizing the documentation makes it much easier both to add new and to update existing material. It also allows us, in our HTML menu over the Learning Resources, to cross-reference topics that cross boundaries. And while you may find it less convenient to search those Learning Resource directories than a single large document, the fact is that there are, and have been for quite some time, many highly pertinent resources that are not part of the Developers Guide or the individual topic documents into which it was atomized. One of those resources (such as a code solution or its cover document) might just be the one that gives you the answer you need and saves you many hours of wandering down blind alleys. We can add such resources as they are created, without waiting for someone to integrate them into a ponderous Developers Guide.
And the search tools provided by Windows keep getting better.
One additional effort we have undertaken, which you may not have noticed, is to begin creating code solutions to accompany the topic documents (formerly DevGuide chapters) that contain all code snippets quoted in the chapter. These snippets are embedded in a compilable and runnable context, so that (a) we can see quickly when they go out of date, and (b) you can exercise, tweak, and otherwise experiment with them while trying to internalize the material. You can see the first two instances of these "Topic Document Snippets" solutions accompanying the Business Object Persistence and Property Interceptors documents. Yes, of course, we could have done this while the Developers Guide was a single document, but I believe it to be quite helpful to have the related resources co-located and segregated from other resources; and something about atomizing the Developers Guide also made the snippets solution initiative a more approachable project. The chunks are more bite-sized, not just for us, but for you. It is my hope that, over time, we can remove many of the existing stand-alone code solutions in the Learning Resources by transplanting their relevant core material into a Topic Document snippets solution. Those have the great advantage of being much more tightly integrated with the main body of documentation; that, we hope, will make it easier for you to find code that addresses your concern of the moment, and to understand its place in the grand scheme of DevForce.
Hope you'll try the new paradigm out for a while before you pass final judgment!
Greg
Edited by GregD - 20-Apr-2010 at 9:04am