Theme
Description
Language documentation is an important element of being able to understand anything implemented in the language. Consequently, well written documentation must be provided before a language can see real-world use and become more than an academic prototype.
In regards to structure, documentation should ideally come from one source and follow a consistent layout to be easy to browse as uniform documentation structure improves speed.
Content users expect from documentation includes examples for common problems or how to use language elements they are looking up. Ideally, these examples or other code snippets can be ran and edited directly from the browser used to access the documentation without needing to use an editor or command line.
Representative Quotes
Python documentation is more understandable and more complete. There is not much examples of Jayvee code in the documentation and for new users it is hard to find what they want.
- S9
I experienced that before starting the work in Jayvee I need to read documentation very well.
- S20
One has to know what each class is doing, naming/doc is very important.
- S29
Documentation can be more clear with examples at the end of the website with an web interference to run it and see what is the possible output when we run a particular code snippet.
- S51