skills.rest
Alountk
AlountkCOMMUNITY
Explore all skills by this author →
GitHub

cognitive-doc-design

Structures documentation to reduce cognitive load for readers and reviewers.

Updated Aug 5, 2026
Search Tags:#documentation#markdown#technical writing#readme#review#cognitive load#pr description
One-click install
npx skills add https://github.com/Alountk/Bloodbowl_Project --skill cognitive-doc-design-alountk
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: cognitive-doc-design
Source: https://github.com/Alountk/Bloodbowl_Project/tree/main/.opencode/skills/cognitive-doc-design
Command: npx skills add https://github.com/Alountk/Bloodbowl_Project --skill cognitive-doc-design-alountk

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Long, dense, or hard-to-scan documentation slows down readers and reviewers. This Skill applies cognitive-load principles so guides, READMEs, RFCs, onboarding docs, and PR descriptions are easier to understand, retain, and verify. ## Core Features & Use Cases - Cognitive Patterns: Applies six core rules including leading with the answer, progressive disclosure, chunking, signposting, and recognition over recall. - Default Document Template: Provides a reusable Markdown structure with quick path, details table, checklist, and next step sections. - PR Review Guidance: Reduces reviewer burnout by stating what to review first, what is out of scope, and linking chained PRs. - Use Case: When writing an architecture RFC that feels overwhelming, use this Skill to restructure it into a scannable format with a quick path, decision tables, and a verification checklist. ## Quick Start Ask the assistant to rewrite or restructure your documentation using the cognitive-doc-design skill to make it easier to scan and review.

Frequently Asked Questions about cognitive-doc-design

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

FAQPage Schema
How do I make technical documentation easier to read?▼

Apply cognitive-load patterns: lead with the answer or decision first, use progressive disclosure from happy path to edge cases, chunk content into small sections, and prefer tables and checklists over long prose.

How to write a PR description that reviewers can scan quickly?▼

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

What document structure works best for onboarding guides?▼

Use an outcome-oriented title, a one-paragraph summary, a numbered quick path, a details table, a verification checklist, and a next-step link. This default structure supports progressive disclosure and fast scanning.

When should I not use a fixed documentation template?▼

Skip the default template when the repository already provides a stronger or established template. The skill explicitly defers to existing repo conventions rather than overriding them.

How can I check which Markdown files changed in my branch?▼

Run git diff --name-only -- '*.md' to list changed Markdown files, and use gh pr view <PR_NUMBER> --json additions,deletions,changedFiles to inspect PR size for cognitive load.

Related Skills

Explore More Content & Communication Skills→
HeyItsGilbertHeyItsGilbert
1

rfc

Draft and manage structured RFCs with lifecycle states and ADR cross-linking.

Community
Advanced
akobryan1akobryan1
1

doc-coauthoring

Guide users through staged documentation drafting, refinement, and reader testing.

Community
Advanced
whoabuddywhoabuddy
2

check-docs

Validate README.md and CLAUDE.md for presence, accuracy, and link integrity.

Community
Intermediate
saajunaidsaajunaid

code-explainer

Explain code with Mermaid diagrams, analogies, and step-by-step walkthroughs.

Community
Intermediate