Results for “diataxis”

Write, restructure, classify, and review documentation with the Diataxis framework. Use when the user asks to create, improve, audit, or reorganize documentation of any kind: knowledge bases, help centers, onboarding guides, process docs, manuals, runbooks, product or API docs, tutorials, how-to guides, references, explanations. Also use when the user mentions Diataxis, docs taxonomy, or documentation architecture, or asks why a document feels confusing. Also use for Simplified Technical English (ASD-STE100) or controlled-language rewrites of English technical docs. Not for marketing, legal, sales, press, or fiction writing unless the user wants a Diataxis-style analysis.

The English summary is being prepared. Showing the original description.

Create missing documentation for a feature, module, or whole project. Use Diataxis, a framework that separates tutorials, practical guides, reference information, and explanations, to organize documents around what readers need to learn or accomplish.

• Writing documentation for an undocumented feature
• Creating tutorials and practical guides
• Preparing module references and explanations

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.

The English summary is being prepared. Showing the original description.

Audit, classify, validate, and scaffold documentation using the Diataxis framework (Tutorials, How-to guides, Reference, Explanation). Use when user mentions "diataxis", "documentation framework", "quadrant", "doc audit", "doc coverage", "collapsed document", "tutorial vs how-to", "quadrant purity", "documentation types", or wants to classify docs by type.

The English summary is being prepared. Showing the original description.

Create, update, fix, or refine documentation using Diataxis framework and BMad Method style guide. Use when user asks to 'create a doc', 'update docs', 'fix docs style', 'refine docs', or 'improve docs writing'.

The English summary is being prepared. Showing the original description.

Compare release changes with project documentation, then update files such as README and CHANGELOG to reflect what shipped. The skill also checks architecture diagrams, maps missing documentation, and records remaining documentation work in the pull request.

• Updating project documentation after a release
• Checking architecture diagrams against shipped changes
• Polishing changelog entries and organizing TODOs

Create and organize API documentation, READMEs, onboarding guides, and architecture decision records that explain design choices. Structure content around readers’ tasks, with consistent terminology, complete code examples, and separate sections for instructions, reference details, and explanations.

• Writing a README with installation and quick-start instructions
• Documenting API parameters, return values, and errors
• Recording architecture decisions and their consequences

Write concise Diataxis docs for gh-aw with Starlight markdown conventions.

The English summary is being prepared. Showing the original description.

Creates evidence-based documentation following DIVIO/Diataxis principles. Use when writing tutorials, how-to guides, reference docs, or explanations.

The English summary is being prepared. Showing the original description.

DIVIO/Diataxis four-quadrant documentation framework - type definitions, classification decision tree, and signal catalog

The English summary is being prepared. Showing the original description.

Migrate Infrahub docs feature pages from the legacy topic+guide pair into a cleaner structure (single merged page, hub+spokes, or tutorial extraction). Supports both single-feature migrations (one feature like Profiles or Webhooks) and section-wide migrations (a whole section like Branches & Change Control with multiple features migrated together) when the team has agreed on a section-wide restructure plan. Trigger when the user names a specific feature or section to migrate (e.g. "let's migrate profiles", "start the Resource Manager migration", "do the entire Branches & Change Control section"). Each migration is its own branch off `demo/groups-diataxis-example`, its own PR back to that branch.

The English summary is being prepared. Showing the original description.

Diátaxis-driven documentation for AI coding agents: write, improve, or audit tutorials, how-tos, reference, explanation, and developer docs (README, CONTRIBUTING, ADRs). Detects the docs stack; gates on the outline before writing prose; verifies every claim against the code before it ships. Triggers on "absolute docs", "write docs", "write a tutorial", "write a README", "document this", "improve this doc", "audit our docs".

The English summary is being prepared. Showing the original description.

Analyze and improve existing documentation using Diataxis principles

The English summary is being prepared. Showing the original description.