메뉴
Diataxis documentation framework practice guide. Provides diagnosis, classification, templates, and quality assessment for four documentation types (Tutorial/How-to/Reference/Explanation).
기본적으로 소스를 먼저 확인하는 Prompt가 선택됩니다. 직접 명령으로 전환하거나 로컬 사본을 다운로드할 수도 있습니다.
설치 여부를 결정하기 전에 SKILL.md와 SkillsMP에 표시된 보조 파일을 읽어 보세요.
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
직접 명령은 검토 Prompt를 거치지 않습니다. 실행하기 전에 소스를 확인하세요.
npx skills add https://github.com/johnalbertini14-glitch/openclaw-skills --skill diataxis-writing명령은 한 줄로 유지됩니다. 복사하기 전에 가로로 스크롤해 전체 내용을 확인하세요.
로컬 사본을 원하시나요? SkillsMP에서 현재 제공할 수 있는 파일을 다운로드하세요.
Use this skill to create a Polymarket wallet for your agent and trade on prediction markets. Browse markets, place bets, manage positions — all without exposing private keys.
ClawSec suite manager with embedded advisory-feed monitoring, cryptographic signature verification, approval-gated malicious-skill response, and guided setup for additional security skills.
Automated daily security audits for OpenClaw agents with email reporting. Runs deep audits and sends formatted reports.
SOC 직업 분류 기준
SKILL.md 표시 중
| 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). |
When creating or refactoring documentation:
Before starting, ask the user:
Language Preference: "What language should this document be written in?"
Output Method: "After completion, how would you like to output this document?"
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:
For Feishu output via MCP:
/root/config/mcporter.json or ~/.mcporter/mcporter.json)If tool not available:
After confirming language, output preference, and tool availability:
Diataxis identifies four fundamentally different documentation types, corresponding to four user needs:
| Type | User Need | Document Purpose | Key Characteristics |
|---|---|---|---|
| Tutorial | Acquire skills (study) | Provide learning experience | Practice-oriented, minimize explanation, concrete steps |
| How-to Guide | Apply skills (work) | Help complete tasks | Goal-oriented, assume competence, handle real scenarios |
| Reference | Apply skills (work) | Describe technical facts | Neutral description, accurate and complete, structured |
| Explanation | Acquire skills (study) | Provide understanding context | Discursive, allows opinions, provides context |
When unsure about document type, use the compass tool: references/compass.md
Ask two questions:
Troubleshooting records typically belong to:
Template: templates/template-troubleshooting.md
Template: templates/template-best-practices.md
Template: templates/template-learning-notes.md
Technical exploration, experiment records, and comparative analysis typically belong to Explanation.
Template: templates/template-exploration.md
Use checklists during and after writing:
Use the Functional Quality and Deep Quality framework: references/quality-framework.md
Avoid the following error patterns: references/common-mistakes.md
Four types use different language styles: references/writing-language.md
After completing the document, output using the user's chosen method:
Important: For Feishu output, always use MCP/mcporter method, NOT channel tools.
Use scripts/output-handler.py to auto-detect (script is in ./scripts/ relative to this skill file):
python3 scripts/output-handler.py --detect
After user selects output method, check if tool is available:
output-handler.py --detectMust ask user: "Document completed, how would you like to output?"
Based on user selection:
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 ...
write tool or output-handler.py --output localoutput-handler.py --output githubOutput in the user's chosen language:
Complete platform list and configuration methods: references/output-platforms.md
| Platform | Required Tools | Configuration Difficulty | Use Case |
|---|---|---|---|
| Chat | None | - | Quick reply |
| Feishu (MCP) | MCP feishu server | Medium | Team collaboration |
| Local MD | write | Low | Personal knowledge |
| GitHub | MCP github/git | Medium | Tech blog |
| Notion | MCP notion | Medium | Knowledge base |
| Google Docs | MCP google | High | Google ecosystem |
Complete Diataxis theory:
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)