Diataxis documentation framework practice guide. Provides diagnosis, classification, templates, and quality assessment for four documentation types (Tutorial/How-to/Reference/Explanation).
Standardmäßig ist der Prompt ausgewählt, der zuerst die Quelle prüft. Sie können zu einem direkten Befehl wechseln oder eine lokale Kopie herunterladen.
Quelldateien prüfen
Lesen Sie SKILL.md und alle von SkillsMP angezeigten Begleitdateien, bevor Sie sich für eine Installation entscheiden.
Mit Codex oder Claude installieren Kopieren Sie diesen Prompt, fügen Sie ihn in Codex, Claude oder einen anderen Assistant ein und lassen Sie die Skill-Seite prüfen und installieren.
Ein direkter Befehl überspringt den Prüf-Prompt. Prüfen Sie die Quelle, bevor Sie ihn ausführen.
Der Befehl bleibt in einer Zeile. Scrollen Sie horizontal, um ihn vor dem Kopieren vollständig zu prüfen.
Sie bevorzugen eine lokale Kopie? Laden Sie die Dateien herunter, die SkillsMP derzeit vorliegen.
Datei-Explorer
24 Dateien
SKILL.md wird angezeigt
SKILL.md
Quellanweisungen · Schreibgeschützte Vorschau
name
diataxis-writing
description
Diataxis documentation framework practice guide. Provides diagnosis, classification, templates, and quality assessment for four documentation types (Tutorial/How-to/Reference/Explanation).
Diátaxis Documentation Framework Practice
Quick Start
When creating or refactoring documentation:
Pre-Writing Questions (Must Ask)
Before starting, ask the user:
Language Preference: "What language should this document be written in?"
English / 中文 / Other
Output Method: "After completion, how would you like to output this document?"
Chat message (default)
Feishu document (via MCP/mcporter)
Local Markdown file
GitHub repository
Other platforms
Tool Availability Check (After User Selection)
After user selects output method, automatically check tool availability:
# Run auto-detection (script is in ./scripts/ relative to this skill)
python3 scripts/output-handler.py --detect
Check results:
✅ Tool available → Proceed with selected output method
⚠️ Tool not available → Inform user and suggest alternatives
For Feishu output via MCP:
Check if mcporter is installed
Check if MCP feishu server is configured (typically in /root/config/mcporter.json or ~/.mcporter/mcporter.json)
Test connection to Feishu MCP server
If tool not available:
Inform user: "Selected output method [X] is not available"
Suggest alternatives: "Available options: [list]"
Ask user to confirm alternative or configure tool
Writing Workflow
After confirming language, output preference, and tool availability:
Identify User Needs - Use the Diataxis Compass to determine document type
Select Template - Choose the corresponding template from templates/
Apply Checklist - Use the corresponding checklist during writing
Quality Assessment - Use the quality framework to evaluate the final draft
Execute Output - Output using the user's chosen method and language
Four Documentation Types
Diataxis identifies four fundamentally different documentation types, corresponding to four user needs: