docs-expert

Reviews and advises on documentation structure, style, curation, and Mermaid diagrams.

Updated Jun 24, 2026
One-click install
npx skills add https://github.com/psmfd/pi-config --skill docs-expert-psmfd
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-expert
Source: https://github.com/psmfd/pi-config/tree/main/agent/skills/docs-expert
Command: npx skills add https://github.com/psmfd/pi-config --skill docs-expert-psmfd

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Documentation often suffers from inconsistent structure, verbose LLM-style prose, unclear audience targeting, and broken or non-rendering diagrams. This Skill provides read-only advisory expertise on documentation strategy, technical writing style, content curation, and Mermaid diagram authoring so teams produce clear, maintainable docs. ## Core Features & Use Cases - Structural and style review: Evaluates heading hierarchy, format choice (prose vs table vs list), tone, and audience targeting, while explicitly deferring domain policy substance to the relevant domain expert. - Plain-English pass: Detects and rewrites Claudish/LLM-prose anti-patterns (hedging stacks, filler transitions, jargon stacking, marketing adjectives) in persisted documentation artifacts under a strict rewrite contract that preserves facts, code blocks, and claim strength. - Mermaid diagram guidance: Advises on diagram type selection, syntax, theming, and rendering behavior across GitHub, GitLab, VS Code, Copilot chat, and Azure DevOps wikis. - Use Case: When reviewing a README or ADR, invoke this Skill to get structural findings, plain-English rewrites, and Mermaid fixes without it overstepping into the technical policy content owned by domain agents. ## Quick Start Ask the docs-expert skill to review your README or ADR for structure, plain-English style issues, and Mermaid diagram correctness.

Frequently Asked Questions about docs-expert

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

FAQPage Schema
How do I review documentation for structure and style issues?▼

Invoke the docs-expert skill against the document to get findings on heading hierarchy, format choice, tone, and audience targeting. It reports issues structurally and defers any domain policy substance to the relevant domain expert.

How to rewrite LLM-generated prose into plain English?▼

Apply the Claudish anti-pattern catalogue in references/style.md: remove hedging stacks, filler transitions, jargon stacking, and marketing adjectives. The rewrite contract requires preserving every fact, code block, heading structure, and claim strength.

Which Mermaid diagram type should I use for my documentation?▼

Use flowcharts for processes, sequence diagrams for request/response flows, state diagrams for lifecycles, and ER diagrams for data models. Keep diagrams under 20 nodes and label edges with the action or data being passed.

Does Mermaid render in Azure DevOps wiki pages?▼

Azure DevOps wiki renders Mermaid, but the bundled version trails the latest release by 6-12 months. Newer diagram types like mindmap, timeline, and sankey may not render, so stick to flowchart, sequence, class, state, ER, Gantt, and pie.

What are the limitations of the docs-expert skill?▼

It is read-only and never modifies files directly. It cannot rule on the substance of technical rules, conventions, or policies; that content is always deferred to the relevant domain expert, and it never drafts candidate policy text.