XPO documentation

23 May 2006

We have had feedback from many of our users about the quality of XPO documentation. Obviously this is always a very subjective thing, because people have different things in mind when looking at documentation:

  • New users look for quick introductions that let them get into the technology quickly
  • Advanced users need good coverage of complicated and specialized topics
  • All users need reference materials, 100% complete and accurate of course

And then there are the different approaches people take when reading documentation:

  • Read everything from the first to the last page. These people would like us to create printable documentation, so they can read it in bed.
  • Read detailed descriptions as well as sample code, but only for topics of special interest.
  • Find topics by keywords or fulltext search, expecting to find comprehensive sample code. Textual description are evil.

I’m sure this is an incomplete list, but it gives you an idea of how complex the task of creating “good” documentation is.

Anyway, I don’t want to go on about this. The real purpose of this post is to let you know that we’re actively working on the XPO documentation, and the first results of our efforts have now been made available in our online help section in the form of four new tutorials. Click this link to go there directly.

4 comment(s)
Renaud Bompuis
Thanks Oliver.
The old documentation was OK as a starting point but quickly lacked concrete real-life examples beyond how to construct your XPO classes.
XPO is a base infrastructure for projects using it meaning that how you use it in your application has more far reaching consequences than any other components.
Showing how XPO integrates in an application, with UI, with data validation, Security, etc in concrete terms is so important.

XPO can do lots and can be used in so many configurations that it's probably impossible to tackle all of them, but there are basic common and repetitive implementation details that would benefit from being discussed: while so many courses of action exist, not all are equal and putting us on the right track while avoiding pitfalls is certainly welcome.

All this makes it hard to please everyone... but know that all your efforts and that of the whole DX team are immensely appreciated!
23 May, 2006
Russ Painter
Thanks for your effort Oliver.  The documentation will certainly be appreciated.
25 May, 2006
the current documentation sucks badly,who did it? wanna hit that guy on the head with a big book,man..you need a manual style documentation for god sake you are suppose to market it so that its really easy to use and stuff like that,just obj.save() does not do it and showing that ok xpo can do this that i can already do with a database blaaaa how much *** does a developer has to wade through to like just get a task done,you need to do at least a pet shop sample webapp and fully featured win app to get this thing moving.please and also a PDF MANUAL that can be downloaded and printed !!!!!!!!!!!!!!!!!!! please allocate or hire someone to do these stuff so that others can use your product easily that wade through something heartless.Put some life into your orm software tell the developer what they can and cannot do with you xpo how do i know ??????????????????? i may come from a complex orm to your and find what the hell ????

Please cc this mail to your team
da troll
31 May, 2006
I need to print it, so are are there any PDF's available? Printing from the online docs omits the screenshots- maybe a browser problem but I vdon't care, because a PDF would solve all that.

1 June, 2006

Please login or register to post comments.