Requirements
- Target platform
- OpenClaw
- Install method
- Manual import
- Extraction
- Extract archive
- Prerequisites
- OpenClaw
- Primary doc
- SKILL.md
Tencent SkillHub ยท Content Creation
Diataxis Writing
Diataxis documentation framework practice guide. Provides diagnosis, classification, templates, and quality assessment for four documentation types (Tutorial...
skill openclawclawhub Free
Diataxis documentation framework practice guide. Provides diagnosis, classification, templates, and quality assessment for four documentation types (Tutorial...
โฌ 0 downloads โ
0 stars Unverified but indexed
Install for OpenClaw
Quick setup
- Download the package from Yavira.
- Extract the archive and review SKILL.md first.
- Import or place the package into your OpenClaw setup.
Package facts
- Download mode
- Yavira redirect
- Package format
- ZIP package
- Source platform
- Tencent SkillHub
- What's included
- CHANGELOG.md, README.md, SKILL.md, checklist/checklist-explanation.md, checklist/checklist-how-to.md, checklist/checklist-reference.md
Validation
- Use the Yavira download entry.
- Review SKILL.md after the package is downloaded.
- Confirm the extracted package contains the expected setup assets.
Install with your agent
Agent handoff
Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.
- Download the package from Yavira.
- Extract it into a folder your agent can access.
- Paste one of the prompts below and point your agent at the extracted folder.
New install
I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Then review README.md for any prerequisites, environment setup, or post-install checks. Tell me what you changed and call out any manual steps you could not complete.
Upgrade existing
I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Then review README.md for any prerequisites, environment setup, or post-install checks. Summarize what changed and any follow-up checks I should run.
Trust & source
Release facts
- Source
- Tencent SkillHub
- Verification
- Indexed source record
- Version
- 1.2.1
Provenance
- Publisher
- amumulam
- Source page
- View original listing
- Canonical URL
- Open canonical page
Documentation
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: TypeUser NeedDocument PurposeKey CharacteristicsTutorialAcquire skills (study)Provide learning experiencePractice-oriented, minimize explanation, concrete stepsHow-to GuideApply skills (work)Help complete tasksGoal-oriented, assume competence, handle real scenariosReferenceApply skills (work)Describe technical factsNeutral description, accurate and complete, structuredExplanationAcquire skills (study)Provide understanding contextDiscursive, allows opinions, provides context
Type Details
Tutorial: references/four-types.md#Tutorial How-to Guide: references/four-types.md#How-to Guide Reference: references/four-types.md#Reference Explanation: references/four-types.md#Explanation
Using the Diataxis Compass
When unsure about document type, use the compass tool: references/compass.md Ask two questions: Content Type: Is it action guidance (action) or cognitive knowledge (cognition)? User State: Is the user acquiring skills (acquisition/study) or applying skills (application/work)?
Use Case 1: Troubleshooting Records โ How-to Guide or Explanation
Troubleshooting records typically belong to: How-to Guide: If it's step-by-step guidance on "how to solve X problem" Explanation: If it's principle analysis on "why X problem occurred" Template: templates/template-troubleshooting.md
Use Case 2: Experience Summary โ How-to Guide or Explanation
Best Practices: How-to Guide (guidance on how to do things correctly) Lessons Learned: Explanation (explaining why certain approaches are wrong) Template: templates/template-best-practices.md
Use Case 3: Learning Notes โ Tutorial or Explanation
Learning Notes: Tutorial (if containing practical steps) Theory Summary: Explanation (if conceptual understanding) Template: templates/template-learning-notes.md
Use Case 4: Exploratory Sharing โ Explanation
Technical exploration, experiment records, and comparative analysis typically belong to Explanation. Template: templates/template-exploration.md
Checklists
Use checklists during and after writing: Tutorial: checklist/checklist-tutorial.md How-to: checklist/checklist-how-to.md Reference: checklist/checklist-reference.md Explanation: checklist/checklist-explanation.md
Quality Assessment
Use the Functional Quality and Deep Quality framework: references/quality-framework.md
Functional Quality
Accuracy, completeness, consistency, usability, precision
Deep Quality
Flow, fitting human needs, beauty, anticipating user needs
Common Mistakes
Avoid the following error patterns: references/common-mistakes.md Type Conflation - Mixing Reference content into Tutorial Misplacement - Writing Explanation as Tutorial Boundary Blur - Mixing too much explanation into How-to Structural Misalignment - Reference not reflecting product architecture
Language Style
Four types use different language styles: references/writing-language.md Tutorial: "We will...", "Notice...", "Now do X..." How-to: "If you want X, do Y", "Refer to X documentation for complete options" Reference: "X inherits Y", "Subcommands: a, b, c", "Must use X" Explanation: "The reason for X is...", "W is better than Z because..."
Output Methods
After completing the document, output using the user's chosen method:
Available Output Methods
Chat Message - Display directly in conversation (default) Feishu Document - Create/update Feishu document via MCP/mcporter (requires MCP feishu server) Local Markdown - Save as .md file (built-in support) GitHub Repo - Commit to code repository (requires MCP github or git) Other Platforms - User provides platform and MCP capabilities Important: For Feishu output, always use MCP/mcporter method, NOT channel tools.
Detect Available Tools
Use scripts/output-handler.py to auto-detect (script is in ./scripts/ relative to this skill file): python3 scripts/output-handler.py --detect
Tool Availability Check
After user selects output method, check if tool is available: Run output-handler.py --detect Check if selected tool is configured and available If not available: Inform user: "Selected output method [X] is not available" Suggest alternatives from available tools list Ask user to confirm alternative
Choose Output Method
Must ask user: "Document completed, how would you like to output?" Based on user selection: Chat โ Reply directly Feishu (MCP) โ Use mcporter to call Feishu MCP server node /path/to/mcporter/dist/cli.js call feishu doc.create '{"title":"...", "content":"..."}' # Note: mcporter path varies by installation, common paths: # - ~/.npm/_npx/*/node_modules/mcporter/dist/cli.js # - Or use: npx mcporter call feishu doc.create ... Local โ Call write tool or output-handler.py --output local GitHub โ Call output-handler.py --output github Other โ Ask user to provide MCP server information
Language Considerations
Output in the user's chosen language: If English โ Output in English If Chinese (ไธญๆ) โ Output in Chinese If other โ Confirm translation capabilities
Output Platform Details
Complete platform list and configuration methods: references/output-platforms.md PlatformRequired ToolsConfiguration DifficultyUse CaseChatNone-Quick replyFeishu (MCP)MCP feishu serverMediumTeam collaborationLocal MDwriteLowPersonal knowledgeGitHubMCP github/gitMediumTech blogNotionMCP notionMediumKnowledge baseGoogle DocsMCP googleHighGoogle ecosystem
Theoretical Framework
Complete Diataxis theory: Map Model: references/map.md Theoretical Foundations: references/four-types.md Quality Theory: references/quality-framework.md
Using Scripts (Optional)
Use the diagnosis script to automatically identify document types (script is in ./scripts/ relative to this skill): python3 scripts/diagnose.py <document content or file path> Skill Version: 1.0 Theory Source: https://diataxis.fr Author: Zhua Zhua (Created for Master)
Category context
Writing, remixing, publishing, visual generation, and marketing content production.
Source: Tencent SkillHub
Largest current source with strong distribution and engagement signals.
Package contents
Included in package
6 Docs
- SKILL.md
- CHANGELOG.md
- checklist/checklist-explanation.md
- checklist/checklist-how-to.md
- checklist/checklist-reference.md
- README.md