一键导入
classify-diataxis
Classify documentation pages into their Diátaxis type and propose the diataxis_content_type frontmatter value, flagging pages that mix modes
用 Codex 或 Claude 帮你安装 复制这段 Prompt,粘贴到 Codex、Claude 或其他助手里,让它检查 Skill 页面并帮你完成安装。
菜单
Classify documentation pages into their Diátaxis type and propose the diataxis_content_type frontmatter value, flagging pages that mix modes
用 Codex 或 Claude 帮你安装 复制这段 Prompt,粘贴到 Codex、Claude 或其他助手里,让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
| name | classify-diataxis |
| description | Classify documentation pages into their Diátaxis type and propose the diataxis_content_type frontmatter value, flagging pages that mix modes |
| user-invocable | true |
| argument-hint | [file path, glob, or 'diff'] |
Decide which Diátaxis type a page is, and propose its
diataxis_content_type frontmatter value. This skill is the single source of truth
for the rubric — other skills and reviewers defer to it.
From $ARGUMENTS:
src/content/tutorials/**) → classify each matching articlediff → classify the article pages changed in the current working tree / branchIf no argument is given, ask what to classify. Skip _index.md list pages — they don't
carry the field.
Diátaxis splits docs along two axes: study vs. work (is the reader learning or doing a job?) and action vs. cognition (do they need steps or knowledge?). That yields four types:
tutorial (study + action) — a learning-oriented lesson. Takes a beginner by the
hand through steps to build confidence and familiarity; the learning experience matters
more than the end result. No options, no digressions, no explaining-why.how-to-guide (work + action) — a task-oriented recipe. Steps to solve a specific
real-world problem for someone who already knows the basics. Goal-focused, assumes
competence, may offer choices. Titles often start with a verb ("Configure…", "Expose…",
"Set up…", "Deploy…", "Migrate…").reference (work + cognition) — an information-oriented description. Dry, factual,
structured: CLI flags, command usage, CRD/chart schemas, config keys, annotation/label
lists, API fields. Describes the machinery; doesn't teach or explain why.explanation (study + cognition) — an understanding-oriented discussion. Concepts,
architecture, background, the "why", trade-offs. Read away from the keyboard. Titles often
"Introduction to…", "What is…", "How X works", "…concepts".Use none only for pages outside the framework (support, meta).
tutorialhow-to-guidereferenceexplanationtutorials/ folder holds many
how-to guides, some explanations, and some reference; overview/ is mostly explanation.
Classify by the page's dominant purpose and writing style.For each page report: path, proposed diataxis_content_type, confidence
(high / medium / low), whether it's mixed (and which other type(s) it carries), and a
one-line rationale. Then, unless told otherwise, set the diataxis_content_type field in the
frontmatter of each page, right after title.
This skill only touches frontmatter — there's no need to run /improve-style, and don't
change last_review_date when only setting the type (that's a mechanical change, not a
content review).
Understand and maintain how the CRD reference pages under /reference/platform-api/crd/ are generated — register a new CRD source repo, make sure every published CRD has an example CR, and fix pages that render without an example
Create a box on a Miro board for every row in a CSV inventory of pages (e.g. the output of the export-csv skill) — each box shows the page title as a clickable link to its URL, with the navigation path as a subline
Export a CSV inventory of all documentation pages (title, navigation path levels, and public URL) from the frontmatter of every Markdown file under src/content
Assess English readability of documentation pages (Flesch Reading Ease, Flesch-Kincaid grade, Gunning Fog, LIX), excluding generated content
Apply style fixes and run Vale prose linting on modified or added pages
Find documentation pages that need style improvements (long paragraphs, non-sentence-case headings, over-long shell code lines, and Vale findings)