doc-audit-and-close-workflow

A repeatable workflow for executing a batch of documentation, audit, or planning tasks. For each task, it audits the current state, creates a plan/report, commits the result, and closes the corresponding GitHub issue. The process is designed to be idempotent.

5 stars

Best use case

doc-audit-and-close-workflow is best used when you need a repeatable AI agent workflow instead of a one-off prompt.

A repeatable workflow for executing a batch of documentation, audit, or planning tasks. For each task, it audits the current state, creates a plan/report, commits the result, and closes the corresponding GitHub issue. The process is designed to be idempotent.

Teams using doc-audit-and-close-workflow should expect a more consistent output, faster repeated execution, less prompt rewriting.

When to use this skill

  • You want a reusable workflow that can be run more than once with consistent structure.

When not to use this skill

  • You only need a quick one-off answer and do not need a reusable workflow.
  • You cannot install or maintain the underlying files, dependencies, or repository context.

Installation

Claude Code / Cursor / Codex

$curl -o ~/.claude/skills/doc-audit-and-close-workflow/SKILL.md --create-dirs "https://raw.githubusercontent.com/vamseeachanta/workspace-hub/main/.agents/skills/development/doc-audit-and-close-workflow/SKILL.md"

Manual Installation

  1. Download SKILL.md from GitHub
  2. Place it in .claude/skills/doc-audit-and-close-workflow/SKILL.md inside your project
  3. Restart your AI agent — it will auto-discover the skill

How doc-audit-and-close-workflow Compares

Feature / Agentdoc-audit-and-close-workflowStandard Approach
Platform SupportNot specifiedLimited / Varies
Context Awareness High Baseline
Installation ComplexityUnknownN/A

Frequently Asked Questions

What does this skill do?

A repeatable workflow for executing a batch of documentation, audit, or planning tasks. For each task, it audits the current state, creates a plan/report, commits the result, and closes the corresponding GitHub issue. The process is designed to be idempotent.

Where can I find the source code?

You can find the source code on GitHub using the link provided at the top of the page.

Related Guides

SKILL.md Source

### Trigger

When a user provides a list of structured tasks that each involve:
1.  Auditing or analyzing a state.
2.  Creating or updating a documentation or plan file (e.g., `.md`).
3.  Committing the file to Git.
4.  Closing a corresponding GitHub issue.

This skill is ideal for cron jobs or scripted, multi-step administrative actions.

### Workflow

1.  **Parse Tasks:** Break down the user prompt into a list of discrete tasks. Each task should have an associated file path, content creation step, commit message, and issue number.

2.  **Iterate Through Tasks:** Execute the following steps for each task in the list, one by one. Do not proceed to the next task until the current one is complete.

3.  **Audit & Idempotency Check:** Before creating the file, check if it already exists using `read_file` or `search_files`. This is the most critical step to prevent re-doing work or overwriting existing progress.

4.  **Conditional File Creation:**
    *   **If the file does NOT exist:** Perform the necessary research steps (e.g., `search_files`, `read_file`) to gather context. Then, use `write_file` to create the specified document.
    *   **If the file already exists:** Do nothing. Acknowledge that this step has already been completed and move on. Do not overwrite the file.

5.  **Commit Changes:**
    *   Use `terminal` to execute `git add <file_path>`.
    *   Use `terminal` to execute `git commit -m "<commit_message>"`.
    *   **Note:** This command may fail or return a non-zero exit code if there are no changes to commit (i.e., if the file already existed). This is expected and should not be treated as an error. The workflow should continue.

6.  **Close GitHub Issue:**
    *   Use `terminal` to execute `gh issue close <issue_number> -c "<comment>"`.
    *   **Note:** This command may return a message indicating the issue is already closed. This is expected and should not be treated as an error.

7.  **Report Completion:** After completing all tasks, provide a summary report of the actions taken for each task, noting which steps were performed and which were skipped because they were already complete.

### Example Task Structure (from user prompt)

```
TASK 1: Mount Drive Resource Audit (#1776)
- Read docs/document-intelligence/ for mount drive docs
- Search for legal scan results: search_files pattern="legal" output_mode=files_only
- Create: docs/document-intelligence/mount-drive-audit.md covering resources...
- Commit: git add that file && git commit -m "doc-intel: mount drive resource audit (#1776)"
- Close: gh issue close 1776 -c "Mount drive audit completed..."
```

Related Skills

llm-wiki-audit-feedback-loop

5
from vamseeachanta/workspace-hub

Durable feedback loop for correcting llm-wiki pages without losing the correction to chat history. Use when (1) a human notices a wiki page is wrong, outdated, or contradicts a source, (2) processing the `audit/` inbox of a domain wiki, (3) reviewing what feedback has been resolved vs deferred, (4) needing to leave a comment on a specific text range that survives line- number drift. Implements the anchored-text audit file pattern from lewislulu/llm-wiki-skill, adapted for workspace-hub's domain-wiki layout under /mnt/local-analysis/llm-wiki/wikis/<domain>/. Extends the 5-op model (compile/ingest/query/lint) from research/llm-wiki with the missing `audit` op. Never silently delete feedback — rejected audits stay archived with rejection rationale.

digitalmodel-orcawave-orcaflex-proof-workflows

5
from vamseeachanta/workspace-hub

Class-level digitalmodel OrcaWave/OrcaFlex readiness, semantic-proof, fixture-proof, and closeout workflows.

pre-completion-cleanup-audit

5
from vamseeachanta/workspace-hub

Audit and dispose of session residue (orphan files, scratch dirs, sibling-repo state, locks, trash-stages) BEFORE claiming a task complete. Required gate before any agent says "all done", "task complete", or hands work back to user/orchestrator.

flywheel-closeout

5
from vamseeachanta/workspace-hub

Use this at the end of substantial repo or agent waves to convert evidence-backed lessons into proposed durable assets: skills, scripts, rules/checks, prompt templates, docs, or issues. Always use it when the user mentions flywheel, wave closeout, repo ecosystem learning, durable asset promotion, or learning-to-tools.

repo-mission-portfolio-audit

5
from vamseeachanta/workspace-hub

Audit the workspace-hub repo portfolio to extract each repo's mission, identify documentation gaps, and prioritize a plan/approval sequence with explicit LLM-wiki weighting for future issue triage.

provider-session-ecosystem-audit-and-exporters

5
from vamseeachanta/workspace-hub

Build and maintain cross-provider session-log audits for Codex, Codex, Hermes, and Gemini, including exporter design, normalization, and behavioral verification.

orcawave-orcaflex-readiness-audit

5
from vamseeachanta/workspace-hub

Audit the real readiness of digitalmodel OrcaWave/OrcaFlex spec-driven workflows by reconciling workspace-hub issues, source/tests, semantic-equivalence boundaries, and wiki synthesis gaps.

read-only-pre-implementation-audit

5
from vamseeachanta/workspace-hub

Systematic cross-check workflow to validate assumptions before TDD coding begins

portable-pattern-verification-workflow

5
from vamseeachanta/workspace-hub

Multi-package implementation with verification strategy for cross-platform configuration hardening

plan-gated-issue-validation-workflow

5
from vamseeachanta/workspace-hub

Systematic validation pattern for plan-approved GitHub issues with pre-existing deliverables

multi-year-tax-filing-verification-workflow

5
from vamseeachanta/workspace-hub

Verify and reconcile complex multi-form tax filings by cross-referencing source documents, identifying data dependencies, and validating line-by-line against authoritative records.

multi-file-tax-reconciliation-workflow

5
from vamseeachanta/workspace-hub

Systematic parallel review and reconciliation of multi-document tax filings with cross-reference validation