skillZs
★ LIVE SKILL TAGS ★
>>> LIVE SKILLS INDEX <<<
* OPEN SOURCE *
NO LOGIN, NO TRACKING
※ REAL INSTALL DATA ※
← back to all skills
gentleman-programming/gentle-ai79 installs

cognitive-doc-design

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

How do I install this agent skill?

npx skills add https://github.com/gentleman-programming/gentle-ai --skill cognitive-doc-design
view source ↗

Is this agent skill safe to install?

  • Gen Agent Trust Hubpass

    This skill provides guidelines and templates for creating clear, outcome-oriented documentation and pull request descriptions. It includes standard developer commands for inspecting local changes and GitHub PR metadata. No security issues were identified.

  • Socketpass

    No alerts

  • Snykpass

    Risk: LOW · No issues

What does this agent skill do?

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

PatternRule
Lead with the answerPut the decision, action, or outcome first. Context comes after.
Progressive disclosureStart with the happy path, then add details, edge cases, and references.
ChunkingGroup related information into small sections. Keep flat lists short.
SignpostingUse headings, labels, callouts, and summaries so readers know where they are.
Recognition over recallPrefer tables, checklists, examples, and templates over prose that must be remembered.
Review empathyDesign 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

Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.

<a href="https://skillzs.dev/skills/gentleman-programming/gentle-ai/cognitive-doc-design">View cognitive-doc-design on skillZs</a>