Use Namespace/Package Documentation to Give Overviews [DI3] [WHAT] [WHY] [WHERE]

Tip DI3

Namespaces/packages often represent “subsystems” or other groups of related functionality. When documenting them, provide an overview that gives a reader a good understanding of the purpose and contents of the namespace/package. If there is particularly important functionality, usage guidelines, or design/maintenance notes, you can document those too.

Namespace/package documentation is also a great way to give top-down overviews that help with understanding large software systems.