OpenClaw Document Completeness Checker Skill
Overview
This skill enables systematic auditing of OpenClaw tasks to verify that all required supporting documents have been generated before execution. It checks the filesystem against a comprehensive document type inventory, identifying gaps in skills, agent definitions, project documentation, issue files, orchestration docs, migration docs, schema definitions, trigger definitions, and adapter configurations.
Trigger Conditions
- User asks to "check document completeness" for a task
- User asks to "verify all docs exist" for a task
- User asks to "audit document generation" or "find missing documents"
- User asks to "validate task readiness" or "check if all docs are generated"
- User asks to "verify skill files exist" or "check agent documentation"
- User asks to "run document readiness check" before task execution
- User asks to "verify cross-references" in issue files
Execution Workflow
Step 1: Task Context Resolution
- Identify the task or issue being checked (by issue ID, project code, or description)
- Resolve the task's project path under
agent-companies-core/projects/
- Parse the issue file's YAML frontmatter to extract:
id — issue identifier
title — issue title
phase — task phase
status — current status
priority — task priority
Assigned Company & Agent — from body section
Required Skills — from body section
Dependencies — from body section
- Build a document requirement profile based on task type and phase
Step 2: Document Type Inventory
Check for the presence of each required document type:
| Document Type |
Path Pattern |
Required For |
| Issue File |
projects/{project-code}/issues/{issue-id}.md |
All tasks |
| Issue Generation Status |
projects/{project-code}/ISSUE-GENERATION-STATUS.md |
Multi-issue projects |
| Project Charter |
projects/{project-code}/PROJECT.md |
All projects |
| Agent Definition |
agents/{company}/agents/{agent-slug}/AGENTS.md |
Assigned agent |
| Agent Skill |
skills/{company}/skills/{skill-slug}/SKILL.md |
Each required skill |
| Company Definition |
companies/{company}/COMPANY.md |
Assigned company |
| Orchestration Doc |
orchestration/OVERVIEW.md |
Cross-agent tasks |
| Execution Tracker |
orchestration/EXECUTION-TRACKER.md |
Multi-step tasks |
| Risk Tracker |
orchestration/RISK-TRACKER.md |
High-risk tasks |
| Learning Integration |
orchestration/LEARNING-INTEGRATION.md |
Learning tasks |
| Migration Plan |
migration/CONCEPT-MAPPING.md |
Migration tasks |
| Schema Definition |
schema/create-tables.sql |
Database tasks |
| Trigger Definition |
triggers/TRIGGER-README.md |
Automation tasks |
| Adapter Config |
adapters/README.md |
Adapter tasks |
Step 3: Document Existence Verification
- For each required document type, check if the file exists at the expected path
- For existing files, verify they contain valid YAML frontmatter (where applicable)
- For existing files, check that frontmatter fields are populated (not empty)
- For existing files, verify required sections are present:
- AGENTS.md: Overview, When To Use, Core Procedures
- SKILL.md: Overview, Execution Workflow, Error Handling
- PROJECT.md: Project Overview, Scope, Objectives
- COMPANY.md: Company Overview, Agents, Services
- Issue files: Description, Acceptance Criteria, Required Skills
- Log each check result: ✅ Present, ⚠️ Present but incomplete, ❌ Missing
Step 4: Skill Completeness Check
- For each skill referenced in the task's
Required Skills section:
- Verify the SKILL.md file exists at
skills/{company}/{skill-slug}/SKILL.md
- Verify the skill has a
description field in its frontmatter
- Verify the skill has
related_skills and related_docs if applicable
- Check that the skill is assigned to the correct agent in the agent's AGENTS.md
- Report any missing or incomplete skill definitions
Step 5: Agent Readiness Check
- Verify the assigned agent's AGENTS.md exists
- Verify the agent has the required skills listed in its frontmatter
skills array
- Verify the agent has a valid
reportsTo field
- Verify the agent has a
description field
- Check that the agent's slug matches the directory name
- Report any agent documentation gaps
Step 6: Cross-Reference Validation
- Verify that issue file references (dependencies, related tickets) point to existing documents
- Verify that skill references in issue files point to existing SKILL.md files
- Verify that agent references in issue files point to existing AGENTS.md files
- Verify that company references point to existing COMPANY.md files
- Report any broken cross-references
Step 7: Report Generation
- Generate a completeness report with:
- Summary: Total required docs, present, incomplete, missing
- By Category: Skills, Agents, Projects, Companies, Orchestration, Schema, Triggers, Adapters
- Missing Documents: List of paths that need to be created
- Incomplete Documents: List of paths with missing content
- Broken References: List of cross-reference issues
- Save report to
reports/document-completeness/{task-id}-completeness-report.md
- Print summary with pass/fail status per category
Step 8: Collaboration Delegation
- Missing agent creation → delegate to
openclaw-ai-agent-creator
- Agent reconciliation → delegate to
openclaw-ai-agent-reconciler
- Documentation content generation → delegate to
documenter-qualityforge-documentation-specialist
- Skill file creation → delegate to
openclaw-ai-agent-creator
Input Parameters
| Parameter |
Type |
Required |
Description |
task_id |
string |
Yes |
Issue ID or task identifier (e.g., PROC-000) |
project_code |
string |
Yes |
Project code (e.g., 01900-procurement) |
agents_dir |
string |
No |
Path to agents directory (default: agent-companies-core/agents) |
projects_dir |
string |
No |
Path to projects directory (default: agent-companies-core/projects) |
skills_dir |
string |
No |
Path to skills directory (default: agent-companies-core/skills) |
companies_dir |
string |
No |
Path to companies directory (default: agent-companies-core/companies) |
output_report_path |
string |
No |
Path for completeness report output |
strict_mode |
boolean |
No |
If true, fail on any missing optional doc (default: false) |
Error Handling
- Task not found: Report error with available project codes
- Project directory missing: Report error and list available projects
- Malformed issue file: Log warning, attempt partial parsing, continue
- No required skills listed: Report warning, check agent's default skills
- Circular references: Detect and report, skip affected checks
- Permission denied: Log error with file path, continue with remaining checks
Skill Name: openclaw-ai-document-completeness-checker
Version: 1.0
Owner: openclaw-ai-document-completeness-checker
Created: 2026-05-01
1---2name: openclaw-ai-document-completeness-checker3description: >4 Audit OpenClaw tasks to verify that all required documents have been generated. Check for completeness of skills (SKILL.md), agent definitions (AGENTS.md), project docs (PROJECT.md), issue files, orchestration docs, migration docs, schema definitions, trigger definitions, and adapter configs. Report missing or incomplete documents with actionable paths.5triggers:6 - document completeness check7 - document generation audit8 - task readiness validation9 - missing document detection10 - skill file verification11 - agent documentation audit12 - cross-reference validation13 - pre-execution document check14 - document readiness report15 - verify all docs exist16metadata:17 source: https://skillmd.com/skills/construct-ai-primary/openclaw-ai-document-completeness-checker18---1920# OpenClaw Document Completeness Checker Skill2122## Overview2324This skill enables systematic auditing of OpenClaw tasks to verify that all required supporting documents have been generated before execution. It checks the filesystem against a comprehensive document type inventory, identifying gaps in skills, agent definitions, project documentation, issue files, orchestration docs, migration docs, schema definitions, trigger definitions, and adapter configurations.2526## Trigger Conditions2728- User asks to "check document completeness" for a task29- User asks to "verify all docs exist" for a task30- User asks to "audit document generation" or "find missing documents"31- User asks to "validate task readiness" or "check if all docs are generated"32- User asks to "verify skill files exist" or "check agent documentation"33- User asks to "run document readiness check" before task execution34- User asks to "verify cross-references" in issue files3536## Execution Workflow3738### Step 1: Task Context Resolution39401. Identify the task or issue being checked (by issue ID, project code, or description)412. Resolve the task's project path under `agent-companies-core/projects/`423. Parse the issue file's YAML frontmatter to extract:43 - `id` — issue identifier44 - `title` — issue title45 - `phase` — task phase46 - `status` — current status47 - `priority` — task priority48 - `Assigned Company & Agent` — from body section49 - `Required Skills` — from body section50 - `Dependencies` — from body section514. Build a document requirement profile based on task type and phase5253### Step 2: Document Type Inventory5455Check for the presence of each required document type:5657| Document Type | Path Pattern | Required For |58|--------------|--------------|--------------|59| **Issue File** | `projects/{project-code}/issues/{issue-id}.md` | All tasks |60| **Issue Generation Status** | `projects/{project-code}/ISSUE-GENERATION-STATUS.md` | Multi-issue projects |61| **Project Charter** | `projects/{project-code}/PROJECT.md` | All projects |62| **Agent Definition** | `agents/{company}/agents/{agent-slug}/AGENTS.md` | Assigned agent |63| **Agent Skill** | `skills/{company}/skills/{skill-slug}/SKILL.md` | Each required skill |64| **Company Definition** | `companies/{company}/COMPANY.md` | Assigned company |65| **Orchestration Doc** | `orchestration/OVERVIEW.md` | Cross-agent tasks |66| **Execution Tracker** | `orchestration/EXECUTION-TRACKER.md` | Multi-step tasks |67| **Risk Tracker** | `orchestration/RISK-TRACKER.md` | High-risk tasks |68| **Learning Integration** | `orchestration/LEARNING-INTEGRATION.md` | Learning tasks |69| **Migration Plan** | `migration/CONCEPT-MAPPING.md` | Migration tasks |70| **Schema Definition** | `schema/create-tables.sql` | Database tasks |71| **Trigger Definition** | `triggers/TRIGGER-README.md` | Automation tasks |72| **Adapter Config** | `adapters/README.md` | Adapter tasks |7374### Step 3: Document Existence Verification75761. For each required document type, check if the file exists at the expected path772. For existing files, verify they contain valid YAML frontmatter (where applicable)783. For existing files, check that frontmatter fields are populated (not empty)794. For existing files, verify required sections are present:80 - **AGENTS.md**: Overview, When To Use, Core Procedures81 - **SKILL.md**: Overview, Execution Workflow, Error Handling82 - **PROJECT.md**: Project Overview, Scope, Objectives83 - **COMPANY.md**: Company Overview, Agents, Services84 - **Issue files**: Description, Acceptance Criteria, Required Skills855. Log each check result: ✅ Present, ⚠️ Present but incomplete, ❌ Missing8687### Step 4: Skill Completeness Check88891. For each skill referenced in the task's `Required Skills` section:90 - Verify the SKILL.md file exists at `skills/{company}/{skill-slug}/SKILL.md`91 - Verify the skill has a `description` field in its frontmatter92 - Verify the skill has `related_skills` and `related_docs` if applicable93 - Check that the skill is assigned to the correct agent in the agent's AGENTS.md942. Report any missing or incomplete skill definitions9596### Step 5: Agent Readiness Check97981. Verify the assigned agent's AGENTS.md exists992. Verify the agent has the required skills listed in its frontmatter `skills` array1003. Verify the agent has a valid `reportsTo` field1014. Verify the agent has a `description` field1025. Check that the agent's slug matches the directory name1036. Report any agent documentation gaps104105### Step 6: Cross-Reference Validation1061071. Verify that issue file references (dependencies, related tickets) point to existing documents1082. Verify that skill references in issue files point to existing SKILL.md files1093. Verify that agent references in issue files point to existing AGENTS.md files1104. Verify that company references point to existing COMPANY.md files1115. Report any broken cross-references112113### Step 7: Report Generation1141151. Generate a completeness report with:116 - **Summary**: Total required docs, present, incomplete, missing117 - **By Category**: Skills, Agents, Projects, Companies, Orchestration, Schema, Triggers, Adapters118 - **Missing Documents**: List of paths that need to be created119 - **Incomplete Documents**: List of paths with missing content120 - **Broken References**: List of cross-reference issues1212. Save report to `reports/document-completeness/{task-id}-completeness-report.md`1223. Print summary with pass/fail status per category123124### Step 8: Collaboration Delegation125126- **Missing agent creation** → delegate to `openclaw-ai-agent-creator`127- **Agent reconciliation** → delegate to `openclaw-ai-agent-reconciler`128- **Documentation content generation** → delegate to `documenter-qualityforge-documentation-specialist`129- **Skill file creation** → delegate to `openclaw-ai-agent-creator`130131## Input Parameters132133| Parameter | Type | Required | Description |134|-----------|------|----------|-------------|135| `task_id` | string | Yes | Issue ID or task identifier (e.g., `PROC-000`) |136| `project_code` | string | Yes | Project code (e.g., `01900-procurement`) |137| `agents_dir` | string | No | Path to agents directory (default: `agent-companies-core/agents`) |138| `projects_dir` | string | No | Path to projects directory (default: `agent-companies-core/projects`) |139| `skills_dir` | string | No | Path to skills directory (default: `agent-companies-core/skills`) |140| `companies_dir` | string | No | Path to companies directory (default: `agent-companies-core/companies`) |141| `output_report_path` | string | No | Path for completeness report output |142| `strict_mode` | boolean | No | If true, fail on any missing optional doc (default: false) |143144## Error Handling145146- **Task not found**: Report error with available project codes147- **Project directory missing**: Report error and list available projects148- **Malformed issue file**: Log warning, attempt partial parsing, continue149- **No required skills listed**: Report warning, check agent's default skills150- **Circular references**: Detect and report, skip affected checks151- **Permission denied**: Log error with file path, continue with remaining checks152153---154155**Skill Name**: openclaw-ai-document-completeness-checker156**Version**: 1.0157**Owner**: openclaw-ai-document-completeness-checker158**Created**: 2026-05-01