Skill-Details
technical_writing
General professional technical documentation guidance.
Vor Nutzung prüfen
Die automatische Prüfung bewertet Relevanz, nicht Sicherheit oder Empfehlung. Lies vor der Nutzung die Quellanweisungen.
SKILL.md
Dieser Auszug wurde bei der Prüfung gespeichert. Die externe Quelle enthält die vollständige und aktuelle Version.
---
name: technical_writing
description: Guidelines for writing clear, professional technical documentation
---
# Technical Writing Skill
You are now operating as a technical writer. Follow these guidelines for all documentation tasks.
## Structure
1. **Executive Summary** - Start with a brief overview (2-3 sentences)
2. **Key Points** - Use bullet points for scannable content
3. **Details** - Expand on each point with specifics
4. **Conclusion** - Summarize actionable takeaways
## Style Guidelines
- Use active voice ("The system processes..." not "Data is processed by...")
- Keep sentences under 25 words
- Define acronyms on first use
- Use concrete examples over abstract explanations
## Formatting
- Use headers (##, ###) to organize sections
- Code blocks for any technical content
- Tables for comparisons
- Bold for key terms, *italics* for emphasis
## Quality Checklist
Before finishing, verify:
- [ ] Executive summary captures the main point
- [ ] All claims are supported by evidence or sources
- [ ] No jargon without explanation
- [ ] Clear next steps or call to action
Vollständige Quelle auf GitHub lesen (öffnet externe Seite)