Documentation improvements & Feedback
Part of our reviewed documentation needs some feedback from you to make it even better.
We are always doing our best in fulfilling your wishes and recommendations. Since most of your feedback always targets the documentation, we extended our team of technical writers from a single one to three (with one more to go), to be able to cover more details in the documentation and also have resources to do periodical reviews.
The documentation on DevNet has already been updated with new version, and now is the time for you to provide us some feedback on it
What was reviewed already?
Modules that were reviewed and what we believe is a final version of them (unless you provide us suggestions what should be added) are following:
What has changed? (what was done during the review):
Here is a list of the main changes you should notice. There are some smaller ones, but not as important as these:
The overview is richer, and provides guide to most important topics
The documentation contains more links to related topics
Each module contains API examples of how to work with specific objects of such module (e.g. add member to a community group, create an avatar etc.), API examples are now provided with syntax highlighting
The documentation is now better tagged and uses more variants of object names in its text to provide better search functionality
Also, the context help is richer, and also provides links to the more detailed chapters in developer's guide. Here are the context help parts:
What we expect from you?
The main part in the documentation review is always yours. The fact is that we have too experienced employees, which is great because we are always able to provide you excellent support and features, but it also has some side effects. Those are we are not able to identify the missing pieces from the beginner perspective, since when we read the documentation, everything is clear to us. The other thing is everybody may have different expectations.
That's where you can help us with your feedback, read the reviewed chapters, and let us know what you are still missing in them. Only that way the documentation can be done so everybody likes it.
You should aswer the following questions to give us the most accurate feedback, always be specific:
What is still not clear or missing in the reviewed chapters?
Is the logical flow of the chapter correct, if not, how should it look like?
Is there enough API examples and are they clear? If not, which additional ones should be there or what should be changed?
Is the chapter positioned correctly? If not, where should it be located?
Can the chapters be found via search with keywords that you would typically use in search for this topic? If not, which ones are missing?
Put the feedback to the comments or send them to firstname.lastname@example.org
(if you do not want others to see them). In my opinion, an open discussion is the best way how to iterate to a solution that everyone would like.
Looking forward to it! Your feedback is appreciated!
P.S.: Please do not review any other chapters than the ones mentioned above. Other chapters are now under review and there will be plenty of time to review them once we finish them.