tech-doc

Draft, review, and finish Diátaxis tutorials, how-to guides, references, and explanations.

Updated Mar 18, 2026
One-click install
npx skills add https://github.com/pgoell/pgoell-claude-tools --skill tech-doc-pgoell
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: tech-doc
Source: https://github.com/pgoell/pgoell-claude-tools/tree/main/plugins/writing/skills/tech-doc
Command: npx skills add https://github.com/pgoell/pgoell-claude-tools --skill tech-doc-pgoell

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Technical documentation often mixes purposes, drifts in style, and ships with AI-sounding prose or broken code samples. This Skill runs a structured six-phase pipeline that produces Diátaxis-compliant technical docs with consistent style and multi-critic quality review. ## Core Features & Use Cases - Quadrant-aware pipeline: Separate intake, outline, draft, and review flows for tutorials, how-to guides, references, and explanations per the Diátaxis framework. - Eight-critic panel review: Parallel critics check style adherence, accessibility, inclusive language, code fidelity, future-feature promises, quadrant fit, admonitions, and a quadrant-specific critic, with automatic re-drafting on critical verdicts. - Style presets and finishing passes: Google, Microsoft, or house style preset directories drive wordlists and conventions, followed by AI-pattern detection, style enforcement, and terminology-consistency passes. - Use Case: Ask the assistant to write a tutorial for onboarding new users to your API; it interviews you for prerequisites and skill level, drafts the tutorial, runs eight critics, and delivers a polished draft with a glossary and finishing notes. ## Quick Start Ask the assistant to write a how-to guide for rotating API keys using the tech-doc skill and answer its intake questions.

Frequently Asked Questions about tech-doc

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write a Diátaxis tutorial with AI assistance?

Invoke the tech-doc skill with the tutorial quadrant. It interviews you for topic, prerequisites, skill level, and completion time, drafts a tutorial with expected-output blocks per step, then runs eight critics and three finishing passes before presenting the draft.

What is the difference between a how-to guide and a tutorial?

Tutorials are learning-oriented for beginners and include expected output and troubleshooting per step. How-to guides are task-oriented for competent readers, using terse numbered steps without celebration or teaching scaffolding. The skill enforces this distinction via a quadrant-fit critic.

Which style guides does the tech-doc skill support?

It supports Google, Microsoft, and a merged house preset, each stored as a directory of sidecar files covering voice, wordlists, procedures, admonitions, code samples, links, numbers, and API reference conventions. The default preset is house.

Can I resume an interrupted documentation draft?

Yes. The skill records progress in a state file keyed by working directory and detects existing artifacts like intake.md, outline.md, and draft.md. On the next run it offers to resume from the next incomplete phase or jump to a specific phase with the --phase flag.

What reference documentation types are supported?

Five schemas are included: function, cli-command, config, rest-endpoint, and error-codes. The draft phase populates the schema's required fields from source material, marking missing values as <unknown> rather than fabricating them.

What happens when a critic finds critical issues in a draft?

The orchestrator re-dispatches the draft agent with the consolidated critique injected as reviewer feedback, then re-runs the panel. After two failed iterations it asks whether to continue to finishing or pause for manual intervention.