Loading...
Loading...
Write clear, engaging technical content from real experience. Use when writing blog posts, documentation, tutorials, or technical articles.
npx skill4agent add proffesor-for-testing/agentic-qe technical-writing# Title (specific promise)
## Opening (2-3 paragraphs)
- Hook: The problem or insight
- Context: Why this matters
- Promise: What they'll learn
## Body (3-5 sections)
- One clear idea per section
- Support with examples/code/data
## Closing
- Key takeaway (1-2 sentences)
- Action reader can take| Principle | Bad | Good |
|---|---|---|
| Lead with value | "In today's landscape..." | "Here's how we cut bugs 60%" |
| Show, don't tell | "We improved testing" | "Bug detection: 12→47 per sprint" |
| Be specific | "Performance improved" | "Response time: 2.3s→180ms" |
| Honest trade-offs | "This approach is best" | "TDD slowed velocity 20%, reduced bugs 75%" |
| Kill | Reason |
|---|---|
| basically, actually, probably | Hedge words |
| leverage, synergy, paradigm | Corporate speak |
| very, really, quite | Unnecessary qualifiers |
| it should be noted that | Just note it |
// Generate documentation from code
const docs = await Task("Generate Docs", {
source: 'src/services/PaymentService.ts',
format: 'markdown',
includeExamples: true
}, "qe-quality-analyzer");
// Review documentation quality
const review = await Task("Review Docs", {
files: ['README.md', 'docs/api.md'],
checkClarity: true,
checkCodeExamples: true
}, "qe-quality-analyzer");aqe/technical-writing/
├── generated-docs/* - Auto-generated documentation
├── reviews/* - Documentation review findings
└── templates/* - Reusable doc templatesconst docsFleet = await FleetManager.coordinate({
strategy: 'documentation',
agents: [
'qe-quality-analyzer', // Generate and review
'qe-api-contract-validator' // API doc accuracy
],
topology: 'sequential'
});