As a recent post by The Great Vladimir reminds us, there are an enormous amount of valuable code snippets available in ThingWorx.
In my view, these built-in code snippets are a major part of the ThingWorx value proposition - however are mostly unusable as they do not have sufficient documentation and examples in order to a) know what they do, and b) be able to apply them to tasks in your own code.
My suggestion would be that SHORT documentation and examples be added within ALL of the code snippets. This way the snippets and their doc/examples are managed within the code and do not require a separate documentation section which may get out of date, needs translation, etc.
Here are some examples of what the documentation should include:
- What the snippet does
- Required and optional parameters
- Explanation of the parameters (what does the input data look like, what will be output)
- Example working code snippet with input data
Certain explanations on commonly used input parameters should also however be improved as the have been lacking in the past (query, filter, ...).
