Details
-
Bug
-
Resolution: Fixed
-
Minor
-
3.0.x
-
*Location*: http://docs.couchbase.com/admin/admin/Views/views-writing.html
*User-Agent*: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/44.0.2403.130 Safari/537.36
*Referrer*: http://docs.couchbase.com/admin/admin/Views/views-intro.html
*Screen Resolution*: 1680 x 1050
*Location*: http://docs.couchbase.com/admin/admin/Views/views-writing.html *User-Agent*: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/44.0.2403.130 Safari/537.36 *Referrer*: http://docs.couchbase.com/admin/admin/Views/views-intro.html *Screen Resolution*: 1680 x 1050
Description
There are a lot of grammatical errors and ill-formed sentences in the documentation which can really discredit your product!
Just several example to illustrate my point:
(Ctrl+F to find the following example in the documentation )
- you can choose whether to the reduce the...
- For information on how to write map functions, and how the output of the map function affects and supports searching. This is not a complete sentence! It makes a reader confused!
- mapping between the input fileds of the individual objects stored whithin Couchbase to the information ouput when the view is accessed. "mapping between sth. to sth"? It should be "mapping between sth. and sth".
- This can be useful when you want to supporting...
- if you elect to output fields in from the source JSON..,
and so on...
I hope that your team can really pay attention to these details and try to publish something credible. Because most of the developper will not dig into the source code to know how it works but read your documentation, if this is something ill-formed, I don't think the developer will continue to use your product. As far as I know, some similar NoSQL database like MongoDB, they have documentations of high quality!
Reporter: Xingxian LI
E-mail: glixingxian@gmail.com