search

mysema / rdfbean

RDFBean - Object/RDF persistence for Java
19 stars 5 forks source link

Update documentation #21

Open marek-surek opened 11 years ago

marek-surek commented 11 years ago

There is necessity to update documentation with many examples for potential developers.

timowest commented 11 years ago

The documentation of an older release is available here http://source.mysema.com/static/rdfbean/1.4.8/reference/html/

I will update also the project wiki.

marek-surek commented 11 years ago
  1. I think that the documentation should be only at one place. It will be better to have only the generated documentation. The documentation on github should contain only link to the documentation.
  2. The generated documentation is from technical perspective sufficient. What is really needed is more examples and more "for dummies" explanations. E.g. I can read that there are 3 types of ID, but it would be nice to have deeper commentary about their usage scenarios. At the same time important passages like inv is read-only should be bolded. It will increase readability.
  3. I will include additional text. At the same time, parts which are not sufficiently (I don't understand them) I will mark with "???"
marek-surek commented 11 years ago

I updated documentation. As I mentioned earlier, I put ??? sign to places I was not sure or I was not familiar with.