Docs Gap Map
Find the modules with real code but no nearby README or documentation, and get a coverage percentage.
Docs Gap scans a repository for the documentation work nobody has done yet: modules without docs, missing headings, TODOs, empty sections, bulky files, and orphaned documents.
- users onboarded
- 640+
- doc modules generated
- 18k+
- files indexed
- 2.1M+
- avg to first docs
- ~2 min
What does Docs Gap Map check?
- Directories and modules that carry source code but have no documentation
- Existing docs with missing headings, TODO markers, or empty sections
- Very large source files that are hard to document as a unit
- Malformed code fences and broken structure in existing markdown
How does Docs Gap Map work?
- 1.Paste a public repository URL.
- 2.ShipDocs maps the file tree against the documentation surface.
- 3.You get a prioritised gap list with file paths.
What do you get from Docs Gap Map?
- • A ranked backlog of documentation gaps with real paths
- • An estimate of the writing effort per gap
- • A fix path: generate the missing docs instead of writing them by hand
“I was spending 4 hours every sprint updating our internal documentation. ShipDocs indexed our monorepo in under 3 minutes, and the answers cite real files.”
Frequently asked questions
Does it check my existing docs too?
- Yes. Existing markdown is inspected for missing headings, TODOs, empty sections, and malformed code fences.
What counts as a documentation gap?
- A directory or module with source code but no page describing its responsibilities, entry points, and data flow.
Can ShipDocs close the gaps for me?
- Yes. Import the repository and ShipDocs writes a page per module, then keeps them current on every push.
More free tools and examples
- Repo Wrapped — Shareable stats card for any public repo: languages, hotspots, doc coverage.
- Onboarding Time Estimator — How long a new engineer needs to ship their first change in your repo.
- Dependency Time Bomb — Outdated, unmaintained and risky dependencies, ranked by upgrade pain.
- Dead Code Finder — Unused files, exports and dependencies that can safely be deleted.
- Production Readiness Audit — Tests, CI, error handling, secrets and deployment hygiene in one report.
- Architecture Diagram — A Mermaid diagram of modules and their real import relationships.
- Agent-Readiness Score — Score any docs URL 0–100 for LLM and coding-agent consumption.
- Repo Complexity Score — Cyclomatic complexity, nesting depth and the files that slow teams down.
All free developer tools · Live examples of generated documentation · How ShipDocs works
By The ShipDocs team · Reviewed