docs-vs-code-review

Compare Confluence documentation against cloned source code to identify mismatches.

3|7|Updated Nov 7, 2025
One-click install
npx skills add https://github.com/dimagi/dimagi-claude-workflows --skill docs-vs-code-review
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-vs-code-review
Source: https://github.com/dimagi/dimagi-claude-workflows/tree/main/plugins/connect-tech/skills/docs-vs-code-review
Command: npx skills add https://github.com/dimagi/dimagi-claude-workflows --skill docs-vs-code-review

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill removes the manual, error-prone work of comparing Confluence documentation to the actual source code and internal documentation standards by automatically finding inaccuracies, omissions, and actionable fixes across a root page and all child pages.

Core Features & Use Cases

  • Fetches full Confluence page trees and reads each page as markdown to capture exact claims, messages, and UI descriptions.
  • Infers and clones relevant repositories (Connect and CommCare mappings) and scans models, views, forms, tasks, import modules, and templates to verify concrete values like field names, CSV headers, status strings, icon classes, and notification templates.
  • Produces a prioritized, concise edit list that reports only items that need changing (severity-ordered), plus a short list of documentation quality gaps (missing sections, screenshots without captions, etc.).
  • Use Case: A support engineer supplies a Confluence root page and receives a focused list of doc edits that would prevent users from performing incorrect imports, misconfiguring features, or being misled by outdated UI steps.

Quick Start

Review the Confluence page at the supplied URL and return a prioritized, actionable list of documentation edits required to make the docs match the code.

Frequently Asked Questions about docs-vs-code-review

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I find mismatches between Confluence documentation and source code?

To find Confluence documentation mismatches, you need a tool that fetches page trees as markdown and compares documented claims against actual implementation by cloning inferred repositories and scanning models, views, forms, and templates.

How do I audit Confluence pages for outdated field names and UI steps?

Auditing Confluence pages for outdated field names involves fetching the full page tree, reading content as markdown, and verifying exact values like field names, CSV headers, and status strings against the actual source code repository.

Can I check CommConnect documentation accuracy by comparing it to repository code?

Yes, you can check CommCare or Connect documentation accuracy by cloning the relevant repositories and scanning import files, tasks, and templates to verify constants, notifications, and UI descriptions match the Confluence pages.

Do I need Atlassian cloud access to compare Confluence docs to source code?

Yes, Atlassian cloud access is required to fetch Confluence pages as markdown, and you also need permission to perform shallow git clones and file searches to verify the actual source code implementation.

What is the best way to generate a prioritized edit list for outdated Confluence documentation?

The best way to generate a prioritized edit list for outdated documentation is to compare Confluence root and child pages against cloned source code, producing a severity-ordered report of items that need changing plus documentation quality gaps.

Why does my Confluence documentation show incorrect import instructions for users?

Confluence documentation shows incorrect import instructions when documented claims diverge from the actual source code, requiring an automated comparison of page content against repository files to identify and fix the mismatches.