本文へ移動
cccskills
無料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.

インストール方法を見る

含まれるファイル(1)

  • SKILL.md2.1 KB

SKILL.md(原文)

インストールする前に、エージェントに与えられる指示の中身を確認できます。

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);
```

レビュー

まだレビューはありません。使ってみた感想をお寄せください。

同じリポジトリのスキル

概要と使いどころ

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.

日本語の概要は準備中です。原文の説明を表示しています。

AndrewBrown-USDA/aigb-skills-usda52026年10月10日 更新

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.

日本語の概要は準備中です。原文の説明を表示しています。

AndrewBrown-USDA/aigb-skills-usda52026年10月10日 更新

caveman

無料

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".

日本語の概要は準備中です。原文の説明を表示しています。

AndrewBrown-USDA/aigb-skills-usda52026年10月10日 更新

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".

日本語の概要は準備中です。原文の説明を表示しています。

AndrewBrown-USDA/aigb-skills-usda52026年10月10日 更新

Reads Copilot conversation history and extracts executive-ready success stories. Use when the user asks to study prior Copilot sessions, summarize what was done before, mine evidence, or quantify time, cost, risk, and priority alignment from GitHub Copilot history in any workspace or repository.

日本語の概要は準備中です。原文の説明を表示しています。

AndrewBrown-USDA/aigb-skills-usda52026年10月10日 更新

Comprehensive investigation of complex multi-domain narratives (technology, theology, policy, finance). Systematically decouples factual claims from speculation through iterative verification, multi-source comparison, and contradiction resolution. Use for investigations requiring institutional knowledge, historical context, and handling of conflicting incentives.

日本語の概要は準備中です。原文の説明を表示しています。

AndrewBrown-USDA/aigb-skills-usda52026年10月10日 更新

AndrewBrown-USDA のスキルをすべて見る

このスキルの問題を報告する