agentleFS
JuankCadavidJuankCadavid/akili-specs/.claude/skills/cognitive-doc-design/SKILL.md

cognitive-doc-design

Skill12 starsChanged 14 days agoMITView on GitHub

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

5 other projects use a version of this, 3 of them edited.

Adopted by

Most recently taken up by

Used with

Projects with it also use issue-creation and go-testing.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • Gentleman-ProgrammingSkill

    issue-creation

    Also in 3 projects that use this

  • alex-ilgayevSkill

    go-testing

    Handles all Golang testing tasks including running tests, writing new tests, and fixing test failures. Follows MCPSpy testing conventions with require for critical assertions and assert for non-critical ones.

    Also in 3 projects that use this

The file

We split this skill into the rules it gives an agent

5 rules. 5 are common, 0 are distinctive, and 0 are very specific to this project.

  • 5

    Common

    Most of the 5 edited versions we read keep these.

  • 0

    Distinctive

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Common:

    Use it especially for:

    line 17
  2. Common:

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

    line 50
  3. Common:

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

    line 81
  4. Common:

    Keep each section focused on one decision or unit of work.

    line 86
  5. Common:

    Use checklists for acceptance criteria and verification.

    line 87

“Common” is measured: kept by at least 6 in 10 of the 5 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
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.

AKILI-SPECS Integration

AKILI momentDocuments written with this skill
/akili-constitutiondocs/prd.md and the baseline docs
/akili-specifyrequirements.md, design.md, tasks.md
/akili-executePR descriptions and review notes (PR and Review Docs section below)
/akili-archiveThe archive summary and the Kaizen entry file under docs/specs/kaizen/

The AKILI templates in docs/specs/general-setup/ win over the default Documentation Shape below — apply the Critical Patterns inside their structure.

Boundary with caveman: this skill owns persistent artifacts (documents humans reread — PRDs, TRDs, specs, reports, PR descriptions); caveman owns transient agent output (inter-agent messages, progress narration in /akili-execute and /akili-test). Never apply caveman compression to a document this skill governs, and never pad transient chatter with document structure.

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

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.