[CXX-2827] Improve API Documentation for C++ Driver Created: 07/Feb/24  Updated: 07/Feb/24

Status: Needs Triage
Project: C++ Driver
Component/s: API Documentation
Affects Version/s: None
Fix Version/s: None

Type: Epic Priority: Unknown
Reporter: Rishabh Bisht Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Depends
Scope Cost Estimate: 0
Cost to Date: 0
Final Cost Estimate: 0
Cost Threshold %: 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]


Generated at Wed Feb 07 22:07:08 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.