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

diataxis

Classify, write, and audit documentation per Diátaxis (diataxis.fr) — the four-quadrant method (tutorials · how-to guides · reference · explanation). Encodes the compass as a decision procedure, each quadrant's contract as hard rules, and an executable mixed-mode audit. Project-agnostic; the per-repo doc-location mapping lives in a repo rule of the project's own (kolu: `.apm/instructions/diataxis.instructions.md`). Use when writing any user-facing doc, structuring a docs site, or auditing existing docs for mixed modes.

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

설치 방법 보기

포함된 파일(1)

  • SKILL.md7.6 KB

SKILL.md(원문)

설치하기 전에 에이전트에게 전달되는 지시 내용을 확인할 수 있습니다.

Diátaxis — classify, write, audit

Diátaxis's claim: documentation fails when one page serves two masters. Every doc serves exactly ONE of four needs, derived from two axes — is the reader acquiring skill (study) or applying it (work)? do they need action (practical steps) or cognition (knowledge)? One doc, one quadrant, always; other modes are LINKS, never inlined sections.

Provenance: the compass and the four contracts quote/paraphrase diataxis.fr (Procida); the SMELLS lists, the entry template, the audit, and the writing procedure are THIS SKILL's operationalization — useful, but do not cite them as Diátaxis. (Diátaxis is the needs-grounded, iterative successor of the older Divio four-types system.) Foundation the method stands on: documentation serves USER NEEDS, not the machinery — the four types enumerate practitioner needs: tutorials answer "can you teach me to…?", how-tos "how do I…?", reference "what is…?", explanation "why…?".

The compass (two questions, one quadrant — a doubt-resolver, applicable to a whole doc OR a single sentence)

serves ACTION (practical)serves COGNITION (theoretical)
ACQUISITION (study — the reader is learning)TutorialExplanation
APPLICATION (work — the reader is doing their job)How-to guideReference

The source's own use: reach for it "when you think you are doing one thing but are troubled by doubt" — at document, section, or sentence level. If a doc can't answer both questions, it has no single reader (splitting it is this skill's procedure, not a source rule). Mixed modes blur toward map-NEIGHBOURS (tutorial↔ how-to, how-to↔reference, reference↔explanation, explanation↔tutorial) — the sharpest mixed-mode predictor.

The four contracts (hard rules, per quadrant)

Tutorial — a lesson: the reader learns by DOING, and YOU own their success

  • The reader is a beginner at THIS thing; you are the teacher and their success is your responsibility. One concrete path, start to visible result.
  • RULES: deliver visible results early and often; concrete and particular, not general and abstract; "ignore options and alternatives" (source's words) — one path, no branches; minimum necessary explanation, link to Explanation instead; must work every time for every reader (our test method: run it cold); first-person plural ("we are in this together"); keep a narrative of expectations ("You will notice that…"); encourage and PERMIT repetition — "sometimes it's the only teacher".
  • SMELLS: paragraphs of why; configuration choices offered; "you may want to"; steps that assume prior setup the tutorial didn't do.

How-to guide — a recipe: a COMPETENT user has a GOAL, get them to it

  • The reader already has the skill; they have a real-world task NOW.
  • RULES: name it "How to <achieve the goal>" (the goal, not the tool); a SEQUENCE of actions addressing the task, including its real-world variance (unlike a tutorial, forks for real conditions are fine); assume competence — no teaching, no concept-building; omit everything not needed for THIS task; completeness is measured by the task, not the machinery.
  • SMELLS: defining terms; explaining internals; covering every option "for completeness"; starting from installation when the goal is elsewhere.

Reference — a map: austere, complete FACTS about the machinery

  • The reader is working and needs to LOOK SOMETHING UP; certainty and consistency are the product.
  • RULES: describe, never instruct and never explain; structure mirrors the structure of the PRODUCT (code-mirroring is the auto-generated special case); consistent, standard patterns per entry (a uniform template like signature · description · constraints · examples is OUR operationalization); examples are encouraged as illustration; "wholly authoritative — truth and certainty, firm platforms on which to stand"; austere, neutral; auto-generation from source is a powerful way to keep it faithful.
  • SMELLS: "you should"; step sequences; design rationale; entries that exist only for some exports; prose that varies format entry to entry.

Explanation — understanding: the WHY, read away from the keyboard

  • The reader wants the bigger picture: design decisions, context, alternatives, connections, history. The only quadrant where opinion and discussion belong.
  • RULES: admit perspective ("the reason this is shaped so…"); make connections (to other parts, to prior art, to rejected designs); no instructions, no obligation to be complete; the source's test — the only docs it might make sense to read IN THE BATH, away from the product. (Our house addition, not Diátaxis: end at a real decision or trade-off — teaching without a point is a tour.)
  • SMELLS: step-by-steps; API tables; pretending neutrality about a choice the project deliberately made.

The audit (executable — run over an existing doc set)

For each doc under the target path, as parallel checks (a Workflow fan-out for large sets; direct reads for small ones):

  1. Classify: which quadrant does its title/frontmatter CLAIM? Which does the compass actually assign? Mismatch = finding.
  2. Mixed-mode detection, by marker: instruction verbs + numbered steps in Reference; rationale/"because"/design-history paragraphs in Tutorials and How-tos; API signatures/exhaustive tables in Explanation; options and branches in Tutorials. Each hit: quote the passage, name the quadrant it belongs to, propose the split (extract + cross-link — never delete the content).
  3. Coverage: for each major component in scope, which quadrants EXIST vs are MISSING — grounded in the map's "cycle of interaction": users mature from study to work and back, so reference-only fails newcomers and tutorial-only fails practitioners. Report the grid; per the process rule above, the grid PRIORITIZES, it does not mandate filling every cell.
  4. Disposition per Diátaxis's OWN process rule — the method "is not a plan": improve organically, in small responsive iterations; never create empty quadrant structures to fill later; every step in the right direction is worth publishing immediately. So: fix the worst blur first, one doc at a time; "recorded, next iteration" IS a valid disposition here (unlike code review) — but silent acceptance still isn't. Docs are "always complete, never finished".

Project overlay

Read the project's own Diátaxis overlay if it has one — the rule that records where each quadrant LIVES in that project (paths, site sections, frontmatter conventions), plus any project rules. In kolu that rule is .apm/instructions/diataxis.instructions.md. Missing overlay → classify/audit generically and SAY so.

Writing procedure (every new doc)

  1. Run the compass; state the quadrant (frontmatter or the doc's one-liner).
  2. Write to that quadrant's contract; when another mode wants in, LINK to it.
  3. Self-audit against the quadrant's SMELLS list before declaring done.

리뷰

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

댓글

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

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

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

0 / 1,000자

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

같은 저장소의 스킬

blog-post

무료

Write a kolu blog post grounded in the real build history — mine the Claude Code session logs behind a feature for the actual story (for large efforts, fan out over the transcripts with an ultracode workflow), draft it in the author's voice, and wire it into the Astro site. Use when asked to write a blog post or engineering essay about something that was built, especially one that should read as a narrative of what actually happened rather than invented marketing copy.

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

juspay/kolu822026년 10월 19일 업데이트

ci

무료

Run this repo's CI end-to-end — the kolu-specific procedure on top of the odu runner: the odu MCP front door, banned opt-out flags, linux-only platform pinning, venue-pool leasing, fail-fast surfacing, e2e timing evidence, and the green-gate. Triggers on "run CI", "drive CI", "re-run the pipeline", "close the red check", "warm the pool". Runner mechanics live in the `/odu` skill.

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

juspay/kolu822026년 10월 19일 업데이트

Launch the kolu dev server on two RANDOM free ports so it never collides with the running production `kolu.service`, remember the ports for the rest of the session, and tear down only the dev instance. Load before running the app locally — for evidence capture, driving a live kolu with the chrome-devtools MCP, or any `just dev` you'd otherwise run by hand. Triggers on "run kolu locally", "launch the dev server", "boot kolu", "drive a live kolu", "start the app to screenshot it", or before pointing chrome-devtools at a local kolu.

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

juspay/kolu822026년 10월 19일 업데이트

evidence

무료

Produce visual PR evidence — a screenshot or video — whenever a change has on-screen impact. Tests are never a substitute; a change can be backend by cause and visible by effect. Capture via the project's e2e harness on a pu box, or by driving a live kolu with the chrome-devtools MCP; host on a GitHub release and post a `## Evidence` comment. Triggers on "post evidence", "screenshot the change", "record a video of this", "show it working", "prove it", or finishing any change whose effect is visible on screen.

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

juspay/kolu822026년 10월 19일 업데이트

Create distinctive, production-grade frontend interfaces with high design quality. Use this skill when the user asks to build web components, pages, artifacts, posters, or applications (examples include websites, landing pages, dashboards, React components, HTML/CSS layouts, or when styling/beautifying any web UI). Generates creative, polished code and UI design that avoids generic AI aesthetics.

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

juspay/kolu822026년 10월 19일 업데이트

Audit an implementation against its plan with a hostile peer agent, debate findings to consensus, and drive fix waves until the auditor runs dry. Use when a done-claim needs verification the implementer cannot game ("hostile review", "adversarial audit", "is this PR faithful", "find the escape hatches") — the loop that beats the laziness bias with its own game theory.

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

juspay/kolu822026년 10월 19일 업데이트

juspay의 스킬 모두 보기

이 스킬의 문제 신고