Research and gap analysis

Research and gap analysis

Use this skill when you want a structured analysis of what is missing, incomplete, or out of sync in the repository.

Do not use this skill for

• Pre-release shipping checks, use release-readiness-review for those
• Fixing gaps you find, use the appropriate skill for the specific task
• Writing or updating docs, use docs-and-api-writer

Mission

Find the highest-value gaps in the project and describe them clearly.

This is useful for:

• repo audits
• pre-release gap checks
• planning the next implementation pass
• identifying missing docs, tests, or brand alignment

What to analyze

Code vs docs

Check for drift between implementation and documentation.

Docs vs brand

Check whether public and internal docs still reflect the SoulMap brand posture.

Tests vs risk

Check whether the riskiest behaviors are protected by tests.

Surface completeness

Check whether the repo has the supporting assets needed for the story it tells.

Examples:

• docs
• changelog
• packaging
• evals
• release guidance

Sources to check first

Always start with these before forming any opinion about what is missing:

• AGENTS.md, baseline SoulMap doctrine, safety contract, and shipped package guide
• docs/engineering/repo-contract.md, structural source of truth for all repo surfaces
• docs/engineering/safety-enforcement-matrix.md, evidence map for safety claims
• docs/engineering/maintenance-boundary.md, scope-control document
• skills/, shipped knowledge base (templates/ is internal-only, not shipped)
• src/soulmap/runtime/ and src/soulmap/devtools/, implementation: compare against docs and tests
• tests/, check for coverage gaps against the riskiest behaviors
• CHANGELOG.md, what has changed recently

Workflow

1. Scan the repo structure.
2. Read the central docs and policies first.
3. Inspect the highest-risk code and test surfaces.
4. Group missing pieces by severity and type.
5. Recommend the smallest high-value next steps.

Expected output

Findings

List the most important gaps first.

Why it matters

Explain the impact briefly.

Suggested next steps

Offer concise, practical follow-ups grounded in the repo's actual needs.

Writing rules

• Prefer concrete gaps over vague quality commentary.
• Do not pad the analysis with generic best practices.
• Distinguish clearly between current gaps and optional improvements.

Definition of done

The analysis should leave the team with:

• a clear picture of what is missing
• sensible prioritization
• grounded next steps instead of generic advice