Skip to content

KamiJeong/tech-bridge-book / .agents/skills/speckit-docguard-guard

speckit-docguard-guard

Verified

Run 19-validator quality gate with severity triage and actionable remediation

FileKindSize
SKILL.mdskill md2.4 KB
---
name: speckit-docguard-guard
description: Run 19-validator quality gate with severity triage and actionable remediation
compatibility: Requires spec-kit project structure with .specify/ directory
metadata:
  author: github-spec-kit
  source: docguard:commands/guard.md
---

# DocGuard Guard

Validate your project against its canonical documentation. Runs 160+ automated checks across 19 validators.

## User Input

```text
$ARGUMENTS
```

You **MUST** consider the user input before proceeding (if not empty).

## Execution

1. Run DocGuard guard validation:
```bash
npx --yes docguard-cli@latest guard $ARGUMENTS
```

2. Parse each validator's result and build a severity-ranked findings table.

3. **Triage by severity**:
   - **CRITICAL**: Structure, Security, Test-Spec failures → fix immediately
   - **HIGH**: Doc Sections, Drift, Changelog, Traceability → fix before commit
   - **MEDIUM**: Freshness, Docs-Coverage, Doc-Quality, Metrics → fix this sprint
   - **LOW**: TODO-Tracking, Schema-Sync, Spec-Kit, Metadata → fix when convenient

4. For each failing check, provide an **exact fix** — specific file, section, and content.

5. Re-run guard after fixes. Iterate until all checks pass (max 3 iterations).

## Validators (19 total)

| Validator | What It Checks |
|-----------|---------------|
| Structure | Required CDD files exist |
| Doc Sections | Canonical docs have required sections |
| Docs-Sync | External doc references are valid |
| Drift | `// DRIFT:` comments have DRIFT-LOG entries |
| Changelog | CHANGELOG.md is maintained |
| Test-Spec | TEST-SPEC.md matches actual test files |
| Environment | Environment docs and .env.example exist |
| Security | No hardcoded secrets, .gitignore configured |
| Architecture | Layer boundaries and diagrams present |
| Freshness | Docs updated after recent code changes |
| Traceability | Canonical docs linked to source code |
| Docs-Diff | Entity/route/field drift between code and docs |
| Metadata-Sync | Metadata headers are consistent |
| Docs-Coverage | All config files documented |
| Doc-Quality | Readability, IEEE 830 compliance |
| TODO-Tracking | TODOs are tracked |
| Schema-Sync | Schema documentation matches code |
| Spec-Kit | Spec quality (FR-IDs, sections) |
| Metrics-Consistency | Internal counts are accurate |

## Flags

- `--format json` — Output results as JSON
- `--dir <path>` — Run on a different directory
slack-gif-creatoranthropics/skillsKnowledge and utilities for creating animated GIFs optimized for Slack. Provides constraints, validation tools, and animation concepts. Use when users request animated GIFs for Slack like "make me a GIF of X doing Y for Slack."Stars: 198kUpdated Claude CodeCodexVerifiedInstall
ponytailDietrichGebert/ponytailLazy senior dev mode for any coding task: the smallest change that fully solves it, and a reply a busy human understands in one read.Stars: 194kUpdated Claude CodeCodexVerifiedInstall
ponytail-debtDietrichGebert/ponytailHarvest every shortcut: comment into one debt ledger, so deferrals get tracked instead of forgotten. One-shot report.Stars: 194kUpdated Claude CodeCodexVerifiedInstall
ponytail-debtDietrichGebert/ponytailList every `shortcut:` comment (and older `ponytail:` ones) as a debt ledger. One-shot report, changes nothing. Use for "ponytail debt", "what did ponytail defer", "list the shortcuts", /ponytail-debt.Stars: 194kUpdated Claude CodeCodexVerifiedInstall