cognitive-doc-design

Structures documentation to reduce cognitive load for readers and reviewers.

Updated Mar 7, 2026
One-click install
npx skills add https://github.com/albersg/dotfiles --skill cognitive-doc-design-albersg
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: cognitive-doc-design
Source: https://github.com/albersg/dotfiles/tree/main/dotfiles-opencode/.opencode/skills/cognitive-doc-design
Command: npx skills add https://github.com/albersg/dotfiles --skill cognitive-doc-design-albersg

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Long, dense, or poorly organized documentation forces readers and PR reviewers to reconstruct context themselves, slowing comprehension and increasing review fatigue. This Skill applies cognitive-load principles so docs are scannable, memorable, and easy to verify. ## Core Features & Use Cases - Cognitive Patterns: Applies rules like leading with the answer, progressive disclosure, chunking, signposting, and recognition over recall. - Default Document Template: Provides a reusable Markdown structure with a quick path, details table, checklist, and next step. - PR Review Guidance: Makes review paths explicit by stating scope, linking chained PRs, and using acceptance checklists. - Use Case: When writing an architecture RFC or a PR description, use this Skill to restructure the content so reviewers can verify intent without reading every line. ## Quick Start Rewrite my PR description using the cognitive-doc-design skill so reviewers can scan it quickly.

Frequently Asked Questions about cognitive-doc-design

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write documentation that is easier to scan?▼

Lead with the answer or decision first, then add context. Use progressive disclosure by starting with the happy path, chunk related information into small sections, and prefer tables, checklists, and examples over long prose.

How to structure a PR description for faster code review?▼

State what to review first, declare what is intentionally out of scope, and link previous and next PRs when work is chained. Keep each section focused on one decision and use checklists for acceptance criteria and verification.

What is progressive disclosure in technical writing?▼

Progressive disclosure means presenting the happy path first, then layering in details, edge cases, and references. Readers get the essential outcome immediately and only dig deeper when they need to.

How can I check if my PR is too large to review?▼

Run gh pr view <PR_NUMBER> --json additions,deletions,changedFiles to inspect the changed-line count. Large diffs increase cognitive load, so consider splitting the work into smaller chained PRs.

When should I not use a fixed documentation template?▼

Skip the default structure when the repository already provides a stronger template or convention. The cognitive patterns still apply, but consistency with existing project docs takes priority over imposing a new format.