Documentation Planning Coverage Percent Checker
Audit documentation-plan target coverage and unresolved upper bound, not caller field completeness within already catalogued records or missing-as-documented assumptions.
Description
Documentation coverage needs an explicit target inventory.
Documentation coverage needs an explicit target inventory. Unassessed items create uncertainty in achieved coverage rather than automatically counting as documented or undocumented.1
Audit documentation-plan target coverage and unresolved upper bound, not caller field completeness within already catalogued records or missing-as-documented assumptions.
When to use Documentation Planning Coverage Percent Checker
Use this tool to audit documentation-plan target coverage and unresolved upper bound, not caller field completeness within already catalogued records or missing-as-documented assumptions.
Prepare the inventory, measurements or policy dates for the collection and reporting period. Confirm units, record order and any independently established thresholds or permissions.
How to use Documentation Planning Coverage Percent Checker and understand its results
- Prepare the inventory, measurements or policy dates for the collection and reporting period. Confirm units, record order and any independently established thresholds or permissions.
- Enter documentationTargetItemCounts, documentedItemCounts, unassessedTargetItemCounts using the field table and calculation rules, then run the tool.
- Read confirmedTargetCoveragePercent, possibleTargetCoverageUpperPercent, unassessedTargetCount. The explanation below defines the units, signs, ordering and any flags or placeholder values.
- If the tool reports an input issue, correct the values and run it again. Apply the stated assumptions when interpreting a successfully returned result.
| Input field | Meaning | Value type; see rules below | Requirement |
|---|---|---|---|
| documentationTargetItemCounts | Documentation target item counts | list of number | Required |
| documentedItemCounts | Documented item counts | list of number | Required |
| unassessedTargetItemCounts | Unassessed target item counts | list of number | Required |
Pair nonnegative integer target, documented and unassessed counts. Documented and unassessed subsets must be disjoint and their sum cannot exceed each target. The total target must be positive. Return pooled confirmed coverage, possible upper coverage and unassessed count using summed inventory counts rather than an average of group percentages.
Paired lists must be nonempty and have equal lengths.
confirmedPercent = 100 documented/target; upperPercent = 100(documented+unassessed)/target Units, indexing, boundary conditions and exceptional cases are defined in the calculation rules above.
| Output field | Meaning | Value type |
|---|---|---|
| confirmedTargetCoveragePercent | Confirmed target coverage percent | number |
| possibleTargetCoverageUpperPercent | Possible target coverage upper percent | number |
| unassessedTargetCount | Unassessed target count | number |
{
"input": {
"documentationTargetItemCounts": [
10,
20
],
"documentedItemCounts": [
5,
15
],
"unassessedTargetItemCounts": [
2,
0
]
},
"output": {
"confirmedTargetCoveragePercent": 66.66666666666667,
"possibleTargetCoverageUpperPercent": 73.33333333333333,
"unassessedTargetCount": 2
}
}Limitations and assumptions
The upper figure is a bound if every unassessed item proves documented, not an estimate that it will. Documentation quality and individual field completeness are outside this inventory-level calculation.
Numeric inputs must be finite. Follow the calculation-specific rules for overflow, underflow and exceptional cases. Numeric lists are limited to 100,000 entries; the rules above may require smaller limits. Missing required fields, extra fields, wrong value types and violations of the calculation rules are input errors.
Alternative or Complementary methods
Use Orphan Works Risk Tier Classifier: Map missing documented rights-search steps into caller weighted workflow risk tier; not an orphan-works legal status, diligent-search certification or permission to publish. For a complementary task, use More Product Less Process Backlog Reduction Percent Calculator: Reconcile backlog stock with new accessions, completed processing and separately removed scope, retaining signed net growth; scope removal is not counted as processing.
References
Similar or alternative tools
- Orphan Works Risk Tier Classifier
Map missing documented rights-search steps into caller weighted workflow risk tier; not an orphan-works legal status, diligent-search certification or permission to publish.
- More Product Less Process Backlog Reduction Percent Calculator
Reconcile backlog stock with new accessions, completed processing and separately removed scope, retaining signed net growth; scope removal is not counted as processing.