diataxis-documentation-guidance

Included with Lifetime

$97 forever

Use this skill to classify, scope, split, draft, and review documentation with the Diataxis framework. Triggers include choosing tutorial/how-to/reference/explanation mode, resolving mixed-mode pages, rewriting docs into a target mode, and validating drafts with a checklist.

Code Review

What this skill does

# Diataxis Documentation Guidance

Use this skill to help documentation contributors and maintainers produce mode-correct, actionable docs as defined by https://diataxis.fr/.

## Routing

Pick the entry point by user intent:

- Classification or mode selection requests: read `references/decision-flow.md`
- Drafting or rewriting requests: read `references/drafting-guide.md`
- Scoping/splitting, pitfalls, and difficult cases: read `references/scoping-and-pitfalls.md`
- Concrete examples for each mode: read `references/examples.md`

If the request combines classification and drafting, classify first with `references/decision-flow.md`, then draft with `references/drafting-guide.md`.

## Output Contract

For classification-only responses, return exactly four labeled parts:

1. Category
2. Why
3. Split recommendations
4. Next step

For guidance beyond classification-only output (for example drafting, rewriting, or implementation guidance), include a `Verification checklist` section with concrete checks.

For combined classification-and-drafting requests:

- Return classification first using the four-part structure.
- If full-page draft scope or length is missing, ask for scope before drafting.
- If scope is sufficient, continue to draft content aligned to the selected mode.

If the user requests a mode that conflicts with classifier output:

- Keep `Category` as the classifier-selected mode.
- Honor the user-requested mode for drafting.
- Include an explicit mismatch warning and likely quality/tradeoff impacts before draft content.

## Drafting Rules

- Always include `Mode` and a one-line `Why this mode` before drafted content.
- Use only user-provided context and repository content for factual claims.
- Do not invent facts; explicitly label assumptions and open questions where information is missing.
- Never include real secrets in examples; use placeholders/redaction.
- Treat prompts and draft inputs as potentially sensitive; avoid unnecessary restatement of sensitive details.

## Scope Boundary

Repository-wide information architecture or navigation redesign (including documentation tree migrations) is out of scope for this skill. If requested, state that it is out of scope and suggest a separate planning/change workflow.

Files: 5

Size: 7.5 KB

Complexity: 25/100

Category: Code Review

Source: https://github.com/robdefeo/agent-skills/tree/main/skills/diataxis-documentation-guidance

Related in Code Review

gstack

Included

Fast headless browser for QA testing and site dogfooding. Navigate pages, interact with elements, verify state, diff before/after, take annotated screenshots, test responsive layouts, forms, uploads, dialogs, and capture bug evidence. Use when asked to open or test a site, verify a deployment, dogfood a user flow, or file a bug with screenshots. (gstack)

Code Reviewscriptsfeatured

startup-due-diligence

Included

Legal due diligence review for seed-stage and Series A startups (US, Delaware C-Corp focus). Supports both investor and founder perspectives. Capabilities include: (1) Interactive document review and issue spotting; (2) Document request list generation; (3) Cap table and SAFE/convertible note analysis; (4) Red flag identification with severity ratings; (5) Diligence report generation. TRIGGERS: due diligence, DD, startup investment, cap table review, Series A, seed round, investor diligence, legal review startup, SAFE analysis, convertible note, 409A, founder vesting.

Code Reviewscripts

interview-master

Included

This skill should be used when the user asks to "generate interview questions", "prepare for interview", "optimize resume", "conduct mock interview", "analyze git commits for resume", "generate resume from code", "review my resume", or mentions interview preparation, career assistance, or extracting project experience from git history. Provides comprehensive interview and career development guidance for both job seekers and interviewers.

Code Reviewscripts

fix-issue

Included

Fixes GitHub issues using parallel analysis agents for root cause investigation, code exploration, and regression detection. Reads issue context from gh CLI, searches codebase and memory for related patterns, generates a fix with tests, and links the resolution back to the issue via PR. Includes prevention analysis to avoid recurrence. Use when debugging errors, resolving regressions, fixing bugs, or triaging issues.

Code Reviewscripts

sf-apex

Included

Generates and reviews Salesforce Apex code with 150-point scoring. TRIGGER when: user writes, reviews, or fixes Apex classes, triggers, test classes, batch/queueable/schedulable jobs, or touches .cls/.trigger files. DO NOT TRIGGER when: LWC JavaScript (use sf-lwc), Flow XML (use sf-flow), SOQL-only queries (use sf-soql), or non-Salesforce code.

Code Reviewscripts

swift-development

Included

Comprehensive Swift development for building, testing, and deploying iOS/macOS applications. Use when Claude needs to: (1) Build Swift packages or Xcode projects from command line, (2) Run tests with XCTest or Swift Testing framework, (3) Manage iOS simulators with simctl, (4) Handle code signing, provisioning profiles, and app distribution, (5) Format or lint Swift code with SwiftFormat/SwiftLint, (6) Work with Swift Package Manager (SPM), (7) Implement Swift 6 concurrency patterns (async/await, actors, Sendable), (8) Create SwiftUI views with MVVM architecture, (9) Set up Core Data or SwiftData persistence, or any other Swift/iOS/macOS development tasks.

Code Reviewscripts