Identify the Scope of a Namespace/Package [DI2] [WHAT]
Tip DI2
The first thing you should typically do when documenting a namespace/package is clearly identify the scope of what it contains. This helps paint a clear picture for both users and maintainers of code in the namespace/package.
See some examples of short namespace/package documentation that does this below. Note how:
What is contained in the namespace/package is identified.
Sometimes there are extra words to provide clarity beyond what can be concisely communicated in the namespace/package name itself (which may be shorter for readability of code where it is used).
Links can be helpful in clarifying intended scope or providing ways for readers to learn more.
