Skip to content
cccskills
FreePublished on GitHub

doc-consistency

Normalizes documentation and examples for consistency in style, format, and accuracy. Ensures code matches existing patterns and documentation. Use when reviewing docs, examples, or writing new code that should follow established patterns.

The English summary is being prepared. Showing the original description.

See how to install

Files included (1)

  • SKILL.md2.1 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

Doc Consistency

Instructions

When Cleaning Existing Code/Docs

  1. Run git diff main...HEAD (or ask which files to inspect).
  2. Scan for these patterns:
    • Inconsistent docstring format (some have @param, some don't; some have @returns, some use prose).
    • Code examples that don't match the current API (outdated signatures, removed params, wrong imports).
    • Inconsistent example style (some use real values, some use placeholders like xxx; some include types, some don't).
    • README or docs sections that repeat information already obvious from code or other sections.
    • Mixed heading styles, list styles, or code block language tags across related docs.
    • Examples with hardcoded values that should be illustrative.
  3. Normalize to the project's existing conventions. When no convention exists, pick one style and apply it consistently.
  4. Preserve all substantive documentation. When in doubt, leave it.
  5. Provide a 1-3 sentence summary of what was normalized.

When Writing New Code

  1. Scan docs/examples/ or blueprints/ for structurally identical modules before writing. Match their structure, error handling patterns, and naming conventions.
  2. If a function signature or config changes, update the corresponding docs in the same turn.
  3. Never invent patterns not shown in reference files -- ask the user for a structural rule instead.

Example

Before:

## Usage

Install the package:
```
npm i my-lib
```

Then use it:
```js
const x = require('my-lib');
const result = x.doThing('abc123xyz', 42, true);
```

After:

## Usage

```bash
npm install my-lib
```

```ts
import { doThing } from 'my-lib';
doThing(input, options);
```

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

Distills enduring architectural decisions and design rationale from wave orchestration plans or historical git changes into structured, tracked Architecture Decision Records (ADRs). Use pre-wave to resolve active architectural constraints or post-wave to record enduring decisions in docs/decisions/.

The English summary is being prepared. Showing the original description.

AndrewBrown-USDA/aigb-skills-usda7Updated Oct 22, 2026

Create and maintain AGENTS.md files for project onboarding and grounding. Use when initialized in a new project, when project structure changes significantly, or when creating subfolder-level AGENTS.md files for complex monorepos.

The English summary is being prepared. Showing the original description.

AndrewBrown-USDA/aigb-skills-usda7Updated Oct 22, 2026

Audit and update an arbitrary codebase to follow the Code.mil federal open-source licensing model (MIT with 17 U.S.C. Section 105 disclaimers and INTENT.md), including CRAN/R package DESCRIPTION setup.

The English summary is being prepared. Showing the original description.

AndrewBrown-USDA/aigb-skills-usda7Updated Oct 22, 2026

Migrates ArcPy and ArcGIS Pro workflows to explicit, testable open-source Python geospatial workflows. Use when removing ArcPy dependencies, porting geoprocessing scripts, or documenting ArcGIS behavior that will not be migrated.

The English summary is being prepared. Showing the original description.

AndrewBrown-USDA/aigb-skills-usda7Updated Oct 22, 2026

Ultra-compressed communication mode that cuts output tokens while keeping technical accuracy. Levels: lite, full, ultra and the wenyan variants. Use for /caveman, "caveman mode", "talk like caveman", "be brief" or "less tokens".

The English summary is being prepared. Showing the original description.

AndrewBrown-USDA/aigb-skills-usda7Updated Oct 22, 2026

Review the changes since a fixed point (commit, branch, tag, or merge-base) along two axes - Standards (does the code follow this repo's documented coding standards?) and Spec (does the code match what the originating issue/spec asked for?). Runs both reviews in parallel sub-agents and reports them side by side. Use when the user wants to review a branch, a PR, work-in-progress changes, or asks to "review since X".

The English summary is being prepared. Showing the original description.

AndrewBrown-USDA/aigb-skills-usda7Updated Oct 22, 2026

See all skills by AndrewBrown-USDA

Report a problem with this skill