Skip to content
Skills Library
Programming · Analysis

doc-gap

/doc-gap

Use this skill to analyze context sufficiency for documentation generation. Reads workspace/context-package.json and produces workspace/gap-report.json with severity-rated gaps and a proceed/gather-more/stop recommendation.

Repository
ai-helpers ↗
Licence
Apache-2.0
Last repository change
22.10.2026

Assessment and security

100/ 100Class: good
Format25 / 25
Frontmatter with name and description, valid name, description up to 1,024 characters, name matching the folder.
Discoverability25 / 25
Description explains when to use the skill, has a reasonable length and uses third person.
Content35 / 35
At least 150 words and at most 500 lines, headings, step lists, examples or code.
Hygiene15 / 15
No placeholders such as TODO, no Windows paths, with a licence.
Riskno signals detected in the scan
Files in this package
2
Scripts
0
HTML comments
0
URLs in SKILL.md
0
Deprecation

No signals detected. Repository changed on 22.10.2026, without references to retired models or APIs.

Licence

Apache-2.0, otwarta: można używać i zmieniać, z zachowaniem licencji i informacji o zmianach.

What it does and when to use it

Use this skill to analyze context sufficiency for documentation generation. Reads workspace/context-package.json and produces workspace/gap-report.json with severity-rated gaps and a proceed/gather-more/stop recommendation.

Arguments

/doc-gap [component-focus]
Original author description

Use this skill to analyze context sufficiency for documentation generation. Reads workspace/context-package.json and produces workspace/gap-report.json with severity-rated gaps and a proceed/gather-more/stop recommendation.

How it works

  1. Prerequisites
  2. Parse arguments
  3. Step 1: Read context package
  4. Step 2: Deterministic coverage checks
  5. Step 3: LLM assessment
  6. Step 4: Synthesize findings
  7. Step 5: Write gap report
  8. Output
  9. Gotchas
Original SKILL.md headings · 115 lines, 587 words
SKILL.md preview
---
name: doc-gap
description: >
  Use this skill to analyze context sufficiency for documentation generation.
  Reads workspace/context-package.json and produces workspace/gap-report.json
  with severity-rated gaps and a proceed/gather-more/stop recommendation.
argument-hint: "[component-focus]"
model: claude-sonnet-4-5
effort: medium
---

# doc-gap

Assess whether the gathered context is sufficient to produce quality documentation.

## Prerequisites

`workspace/context-package.json` must exist (produced by `doc-gather`).

## Parse arguments

`$ARGUMENTS` optionally contains a component name to focus the analysis on. If empty, analyze all components found in the context package.

Input validation:
- If a component name is provided, validate it against the component list in `workspace/context-package.json`.
- Accept only exact matches against known component names.
- If the component name is not found, halt with a clear error and do not run LLM assessment.

## Step 1: Read context package

Read `workspace/context-package.json` and extract:
- Ticket metadata (summary, components, fix_versions)
- List of gathered context files with their source types
- Product configuration (docs conventions)

## Step 2: Deterministic coverage checks

Perform these checks without LLM judgment:

1. **Component coverage**: For each component in the ticket, check if at least one context file from that component's repo exists.
2. **Documentation existence**: Check if existing documentation files are present in the context.
3. **API reference availability**: If the ticket involves API changes, check for CRD type definitions or API spec files.
4. **Source code presence**: Check if implementation source code is included.
5. **Architecture docs**: Check for architecture context files.

Record each check as a finding with pass/fail status.

## Step 3: LLM assessment

Read the gap analysis prompt from `${CLAUDE_SKILL_DIR}/prompts/gap-analysis.md`.

Construct an LLM prompt combining:
- The gap analysis prompt template
- Ticket metadata from the context package
- Summary of gathered files (file paths, source types, relevance scores)
- Content snippets from the highest-scored files (first 500 chars each, up to 20 files), after deterministic secret/PII redaction
- Results of deterministic checks from Step 2

Before prompt assembly, apply deterministic redaction to all snippets:
- Detect and mask secrets (API keys, tokens, passwords, private keys, kubeconfig credentials) with consistent placeholders (e.g., `<REDACTED_TOKEN_1>`).
- Mask PII fields (emails, phone numbers) unless explicitly required.
- Record redaction statistics (number of snippets scanned, items redacted by type) for inclusion in the gap report.

Ask the LLM to assess:
- Is the context sufficient to write accurate docs?
- What specific information is missing?
- What is the recommendation: proceed, gather-more, or stop?

## Step 4: Synthesize findings

Combine deterministic check results with LLM assessment into a unified gap report.

## Step 5: Write gap report

Write `workspace/gap-report.json` with this structure:

```json
{
    "recommendation": "proceed",
    "confidence": 0.82,
    "summary": "Context is sufficient for basic documentation...",
    "deterministic_checks": [
        {
            "check": "component_coverage",
            "status": "pass",
            "details": "Found context for 2/2 ticket components"
        }
    ],
    "gaps": [
        {
            "severity": "medium",
            "category": "examples",
            "description": "No sample YAML configurations found",
            "impact": "Documentation will lack concrete examples",
            "suggestion": "Check component repo for example/ directory"
        }
    ],
    "existing_coverage": [
        {
            "topic": "Model serving overview",
            "source": "modules/serving/pages/con_model-serving.adoc",
            "quality": "sufficient"
        }
    ],
    "analyzed_at": "2026-04-14T10:35:00Z"
}
```

Schema requirements:
- Required keys: `recommendation`, `confidence`, `summary`, `deterministic_checks`, `gaps`, `existing_coverage`, `analyzed_at`.
- `recommendation` MUST be one of: `proceed`, `gather-more`, `stop`.
- `confidence` MUST be a float in [0.0, 1.0].
- If schema validation fails, halt and return an error instead of writing a partial report.

## Output

Primary: `workspace/gap-report.json`
Report to caller: recommendation, confidence score, number of gaps by severity.

## Gotchas

- The `workspace/context-package.json` file must already exist (produced by `doc-gather`) — this skill will not create it.
- Component names must exactly match entries in the context package; partial or fuzzy matches are rejected.
- Snippets are redacted for secrets and PII before LLM assessment, so redaction artifacts in the gap report are expected, not errors.
Files in this package (2)
  • SKILL.md 5 KB
  • prompts/gap-analysis.md 3 KB

Versions

The database has no other skills named doc-gap.

Database snapshot: 13.11.2026 · package version 40f2f1509251 (SHA-256 digest of the entire package)

Downloads in the last 30 days: 0 · ranking

Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.

Similar skills

  • 100doc-gather
    Use when you need to gather context for a Jira ticket or PR. Resolves ticket metadata, clones relevant repos, collects candidate files, runs filtering pipeline, and produces workspace/context-package.json.
  • 100doc-pipeline
    Use this skill to orchestrate the full documentation pipeline. Sequences doc-gather, doc-gap, doc-validate, doc-review, and doc-generate skills based on the requested pipeline mode.
  • 100docs-gap
    Use when analyzing release branch changes for missing user-facing documentation. Compares the release branch against devel, filters for user-facing changes, scans v3-docs/docs/ for coverage, and produces a gap report (.md file) with prioritized documentation opportunities. Does…
  • 100research
    Investigate a codebase, compare tools or approaches, verify current external or library facts, and research failures before making a substantive technical recommendation. Use for sufficiency and gap reviews; ordinary edits with settled requirements do not need a research stage.
  • 86package-development
    Package registration. Use when adding a workspace package, making a private package publishable, renaming a package, or moving its workspace path.
  • 91workspace-membership
    Use when a package directory and the workspace's member list may disagree.

Feedback and reports

Your message goes to Bartosz Sokoliński. An email address is needed only for a reply. See the privacy policy.