AGENT SKILL

cognitive-doc-design

Design docs that reduce cognitive load. Trigger: writing guides, READMEs, RFCs, onboarding, architecture, or review-facing docs.

License 许可
Apache-2.0
最近更新
2026-07-13
Stars
★ 0
Forks
0

01 前言 Front Matter

name
cognitive-doc-design
license
Apache-2.0
metadata
{ "author": "gentleman-programming", "version": "1.0" }
description
Design docs that reduce cognitive load. Trigger: writing guides, READMEs, RFCs, onboarding, architecture, or review-facing docs.

03 SKILL.md 正文

When to Use

Load this skill when creating or editing documentation that people need to understand quickly, retain, or use during review.

Use it especially for:

  • PR descriptions and review notes.
  • Contributor or maintainer guides.
  • Architecture, workflow, or onboarding docs.
  • Any doc that currently feels long, dense, or hard to scan.

Critical Patterns

Pattern Rule
Lead with the answer Put the decision, action, or outcome first. Context comes after.
Progressive disclosure Start with the happy path, then add details, edge cases, and references.
Chunking Group related information into small sections. Keep flat lists short.
Signposting Use headings, labels, callouts, and summaries so readers know where they are.
Recognition over recall Prefer tables, checklists, examples, and templates over prose that must be remembered.
Review empathy Design docs so reviewers can verify intent without reconstructing the whole story.

Documentation Shape

Use this default structure unless the repo already provides a stronger template:

# <Outcome-oriented title>

<One paragraph: what changed, who it helps, and why it matters.>

## Quick path

1. <First action>
2. <Second action>
3. <Verification or expected result>

## Details

| Topic | Decision |
|-------|----------|
| <area> | <concise explanation> |

## Checklist

- [ ] <Reader can confirm this>
- [ ] <Reader can confirm that>

## Next step

<Link or action that continues the workflow.>

PR and Review Docs

When documenting a PR, reduce reviewer burnout by making the review path explicit:

  • State what to review first.
  • State what is intentionally out of scope.
  • Link the previous and next PR when work is chained.
  • Keep each section focused on one decision or unit of work.
  • Use checklists for acceptance criteria and verification.

Commands

# Check markdown files changed in the current branch
git diff --name-only -- '*.md'

# Inspect PR changed-line count for cognitive load
gh pr view <PR_NUMBER> --json additions,deletions,changedFiles

04 同仓库更多 Skills

janpereira-dev
janpereira-dev/skillsCurate

zustand-5

Zustand 5 state management patterns. Trigger: When managing React state with Zustand.

★ 0
janpereira-dev
janpereira-dev/skillsCurate

zod-4

Zod 4 schema validation patterns. Trigger: When using Zod for validation - breaking changes from v3.

★ 0
janpereira-dev
janpereira-dev/skillsCurate

work-unit-commits

Plan commits as reviewable work units. Trigger: implementation, commit splitting, chained PRs, or keeping tests and docs with code.

★ 0
janpereira-dev
janpereira-dev/skillsCurate

web-quality-audit

Comprehensive web quality audit covering performance, accessibility, SEO, and best practices. Use when asked to "audit my site", "review web quality", "run lighthouse audit", "check page quality", or "optimize my website".

★ 0
janpereira-dev
janpereira-dev/skillsCurate

web-artifacts-builder

Suite of tools for creating elaborate, multi-component claude.ai HTML artifacts using modern frontend web technologies (React, Tailwind CSS, shadcn/ui). Use for complex artifacts requiring state management, routing, or shadcn/ui components - not for simple single-file HTML/JSX artifacts.

★ 0
janpereira-dev
janpereira-dev/skillsCurate

vercel-react-view-transitions

Guide for implementing smooth, native-feeling animations using React's View Transition API (`<ViewTransition>` component, `addTransitionType`, and CSS view transition pseudo-elements). Use this skill whenever the user wants to add page transitions, animate route changes, create shared element animations, animate enter/exit of components, animate list reorder, implement directional (forward/back) navigation animations, or integrate view transitions in Next.js. Also use when the user mentions view transitions, `startViewTransition`, `ViewTransition`, transition types, or asks about animating between UI states in React without third-party animation libraries.

★ 0