본문으로 건너뛰기
cccskills
무료GitHub에 공개

cognitive-doc-design

Structure guides, READMEs, design documents, and pull request descriptions so readers can find answers quickly. Put outcomes first, introduce details gradually, and use examples, tables, and checklists to support understanding and review.

한국어 요약은 준비 중입니다. 영어 요약을 표시하고 있습니다.

원문원문 설명 보기

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

설치 방법 보기

이럴 때 유용합니다

  • Reorganizing a long or dense README
  • Writing an onboarding guide for new contributors
  • Making a pull request's review steps clear
  • Structuring architecture or workflow documentation

포함된 파일(1)

  • SKILL.md2.3 KB

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

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

리뷰

아직 리뷰가 없습니다. 사용해 본 소감을 남겨 주세요.

댓글

로그인 없이 쓸 수 있습니다. 사용 후기, 질문, 작동하지 않은 환경 등을 편하게 남겨 주세요.

아직 댓글이 없습니다. 첫 댓글을 남겨 보세요.

보내면 바로 공개됩니다. 이메일 주소나 전화번호 같은 개인 정보는 쓰지 마세요. URL은 2개까지입니다.

0 / 1,000자

이 양식은 reCAPTCHA로 보호되며 Google 개인정보처리방침 및 서비스 약관이 적용됩니다.

같은 저장소의 스킬

branch-pr

무료

Prepare pull requests by checking approved issue links, change-type labels, and required automated checks. Draft the repository’s PR template using observed test results, while leaving commits, pushes, PR creation, and merging under human control.

한국어 요약은 준비 중입니다. 영어 요약을 표시하고 있습니다.

  • Preparing a branch for review
  • Drafting a PR linked to an approved issue
  • Checking required CI before declaring a PR merge-ready
Gentleman-Programming/gentle-ai7.9천2026년 10월 18일 업데이트

Split changes exceeding 400 lines into linked pull requests with clear boundaries and dependencies. Choose a chain structure, keep tests and documentation with each work unit, and document review order, verification plans, and justified size exceptions.

한국어 요약은 준비 중입니다. 영어 요약을 표시하고 있습니다.

  • Splitting a change that exceeds 400 lines
  • Planning PRs that can merge independently
  • Coordinating a feature through a draft tracker PR
Gentleman-Programming/gentle-ai7.9천2026년 10월 18일 업데이트

Draft clear, considerate comments for code reviews, issue replies, and team updates. Put the actionable point first, explain technical reasons when needed, and give a concrete next step while matching the conversation’s language.

한국어 요약은 준비 중입니다. 영어 요약을 표시하고 있습니다.

  • Requesting a code change with a clear reason
  • Replying to a contributor’s issue
  • Writing a brief asynchronous team update
Gentleman-Programming/gentle-ai7.9천2026년 10월 18일 업데이트

Create and verify gentle-ai journeys, which are scripted sequences of product actions. Check their declarations separately from actual execution, review outdated expectations after behavior changes, and record execution results for pull requests.

한국어 요약은 준비 중입니다. 영어 요약을 표시하고 있습니다.

  • Adding a product operation journey
  • Updating expectations after behavior changes
  • Reproducing a bench failure from CI
Gentleman-Programming/gentle-ai7.9천2026년 10월 18일 업데이트

Prepare Gentle AI changes for review by linking approved issues, following branch and commit naming rules, and drafting pull requests with observed test results. Check change size and required automated checks before claiming readiness.

한국어 요약은 준비 중입니다. 영어 요약을 표시하고 있습니다.

  • Preparing a branch for a fix or feature
  • Drafting a pull request linked to an approved issue
  • Organizing test results and reviewer notes
Gentleman-Programming/gentle-ai7.9천2026년 10월 18일 업데이트

Split large code changes into linked pull requests, each with a focused scope. Organize their order, dependencies, and verification steps so reviewers can assess one unit of work at a time.

한국어 요약은 준비 중입니다. 영어 요약을 표시하고 있습니다.

  • Splitting a pull request with more than 400 changed lines
  • Planning the review order for dependent changes
  • Integrating a feature through a shared branch
Gentleman-Programming/gentle-ai7.9천2026년 10월 18일 업데이트

Gentleman-Programming의 스킬 모두 보기

이 스킬의 문제 신고