Uploaded image for project: 'C++ Driver'
  1. C++ Driver
  2. CXX-2827

Improve API Documentation for C++ Driver

    XMLWordPrintableJSON

Details

    • Icon: Epic Epic
    • Resolution: Unresolved
    • Icon: Unknown Unknown
    • None
    • None
    • API Documentation
    • None
    • 0
    • 0
    • 0
    • 100

    Description

      Summary

      Users often report that the API docs for C++ driver is incomplete, poor to navigate/search and missing information and examples. This project aims to overhaul the API docs to solve the aforementioned problems.

      Motivation

      Who is the affected end user?

      Who are the stakeholders?

      How does this affect the end user?

      Are they blocked? Are they annoyed? Are they confused?

      How likely is it that this problem or use case will occur?

      Main path? Edge case?

      If the problem does occur, what are the consequences and how severe are they?

      Minor annoyance at a log message? Performance concern? Outage/unavailability? Failover can't complete?

      Is this issue urgent?

      Does this ticket have a required timeline? What is it?

      Is this ticket required by a downstream team?

      Needed by e.g. Atlas, Shell, Compass?

      Is this ticket only for tests?

      Is this ticket have any functional impact, or is it just test improvements?

      Cast of Characters

      Engineering Lead:
      Document Author:
      POCers:
      Product Owner:
      Program Manager:
      Stakeholders:

      Channels & Docs

      Slack Channel

      [Scope Document|some.url]

      [Technical Design Document|some.url]

      Attachments

        Activity

          People

            Unassigned Unassigned
            rishabh.bisht@mongodb.com Rishabh Bisht
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated: