-
Type:
Task
-
Resolution: Unresolved
-
Priority:
Major - P3
-
None
-
Affects Version/s: None
-
Component/s: None
-
None
-
Server Programmability
-
SP Prioritized List
-
None
-
None
-
None
-
None
-
None
-
None
-
None
The documentation of components owned by Server Programmability is sprawled over a number of places. Beyond inline documentation in source/header files, there are a number of files under the docs directory describing our components, many of which are not code-owned by us and likely very out-of-date, and there are similarly some internal company wiki pages filed under our team. It's not obvious to an external observer what is documented, where it's documented, and who is responsible for maintaining the documentation.
Ensure, at a minimum, that:
- Existing documentation that describes our components is public-facing and highly accessible,
- Existing articles of documentation that deal with the same component all link to one another,
- Existing documentation in the mongo repo is code-owned by us, and
- Existing documentation that we own is up-to-date and reflects present reality.
We should also consider auditing the documentation available across all our components and schedule future work to create documentation where it is lacking.