please keep the docs up to date

[kukeltje]

In the past, it happened to often that the docs were out of date in relation to the code. Lets prevent this from happening again.

In chapter 5 of the devguide a ProcessFactory is mentioned, but that is not in the source anymore. Most likely the ProcessDefinitionBuilder is meant. In 5.5 the link to the api docs is not correct and a ProcessBuilder is also mentioned in one of the paragraphs.

I know it takes some additional time of the devs, but if these things are not correct, (potential) users are probably deterred since it takes to much time and docs are not correct.

[jbarrez]

Ronald,

I completely agree with you. Going over the docs is one of the things on my todo list for the near future.

[kukeltje]

The reason I posted this is that there have already been questions regarding this and since I did not spent a lot of time with jBPM 4 and certainly not the pvm part, it took me some additional time to figure this out.

In general I do want to compliment everybody for the (imo) good docs. At least the depth and completeness, which leaves the correctness ;-)

[kukeltje]

Going over the docs is one of the things on my todo list for the near future.

Don't forget the blogging ;-)

[tom.baeyens]

ronald, you are right (as usual :-)

last iteration (which i'm releasing now), devguide had already got an update. i managed to get half way through. but that is not enough.

i first focussed on the userguide. as that should describe enough to get going. all the devguide stuff is basically community without support.

i had a lot of material there but over time a lot went out of date. that will require a significant review. potentially shrinking the devguide docs to a level that we can maintain.

we'll work on it in the next release. thanks for pointing it out.

[kukeltje]

Great to hear.

Maybe it is an idea to at least mention the 'out-of-date' issue in the summary or 'known issues' of the docs so people know they can be out of date at this moment (up to the 4.0 release)