Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCS-5402

The documentation for C# driver is INCREDIBLY poor

    XMLWordPrintableJSON

Details

    • Icon: Improvement Improvement
    • Resolution: Done
    • Icon: Minor - P4 Minor - P4
    • 01112017-cleanup
    • None
    • None
    • None

    Description

      Please improve the documentation for the c# driver. Here is one page in particular - http://mongodb.github.io/mongo-csharp-driver/2.0/reference/driver/definitions/. I'm learning MongoDb and I find your documentation to be incredibly frustrating. You've got code examples that aren't even valid c# code and you make so many assumptions and leave so many blanks that you obfuscate what you're trying to teach. Just write out simple and COMPLETE code to illustrate your points. Naming is also VERY important. All of your tests use a mechanism called "CreateSubject<Person>" - What the heck is CreateSubject??? What does that even mean? Do you mean CreateQuery? CreateQuery MIGHT make some sense, if that's the intent, but CreateSubject makes no sense whatsoever in the english language.

      I'm led to believe that your english documentation was written by a non-native english speaker.

      It's so bad and has created so much frustration, that I just had to let you know. I wonder how many newbie Mongo users like myself have come to your documentation and just thrown up their hands in frustration, never to return. There are so many simple things you could change that would take so little effort it's shameful.

      Please feel free to contact me for more specific examples if you'd like.

      Attachments

        Activity

          People

            craig.wilson@mongodb.com Craig Wilson
            timhardy Tim Hardy
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:
              7 years, 29 weeks ago