technical-writing · proffesor-for-testing — скилл для Claude Code: что делает и как установить
Скилл technical-writing задаёт правила технического текста: вести с пользы, подтверждать примерами и числами, резать лишние слова. Включается при написании постов, документации и туториалов.
MIT 209 установок ★ 533 обновлён 2026-11-04
npx skills add proffesor-for-testing/agentic-qe --skill technical-writing -a claude-codeЧто делает technical-writing
Скилл даёт структуру для блог-постов (хук, контекст, обещание — тело из 3-5 секций с одной идеей каждая — вывод с конкретным действием) и чек-лист перед публикацией: заголовок обещает конкретику, заявления подтверждены примерами, каждое число привязано к источнику. Отдельно разбирает, как писать для разработчиков, QA-инженеров и руководства — у каждой аудитории свой вход в текст и свой набор деталей.
Главное требование — никогда не выдумывать цифры: если число неизвестно, скилл велит ставить плейсхолдер [number?] и спрашивать, а не вставлять правдоподобное значение. Есть таблица слов на вылет (basically, leverage, very) и примеры трансформации канцелярских формулировок в конкретные. В комплект входят примеры интеграции с агентами qe-quality-analyzer и qe-api-contract-validator для генерации и проверки документации по коду — это часть набора agentic-qe, без него примеры с Task() и FleetManager не выполнятся.
Какие задачи решает
- переписать канцелярский текст в конкретные формулировки
- собрать структуру блог-поста с хуком и выводом
- проверить документацию по чек-листу перед публикацией
- убрать слова-паразиты и корпоративный жаргон из текста
- сгенерировать и проверить документацию по коду через агентов qe
Примеры запросов агенту
- Перепиши этот абзац README по принципам из скилла technical-writing
- Проверь черновик статьи по чек-листу из technical-writing перед публикацией
- Сгенерируй документацию для PaymentService.ts и проверь её на корпоративный жаргон
Как установить technical-writing
1Через Skills CLI (Vercel)
npx skills add proffesor-for-testing/agentic-qe --skill technical-writing -a claude-code2Вручную: положить файлы
~/.claude/skills/technical-writing/SKILL.mdПапка скилла целиком; для одного проекта — .claude/skills/technical-writing/
1Через Skills CLI (Vercel)
npx skills add proffesor-for-testing/agentic-qe --skill technical-writing -a codex2Вручную: положить файлы
.agents/skills/technical-writing/SKILL.mdДля всех проектов — ~/.agents/skills/
1Через Skills CLI (Vercel)
npx skills add proffesor-for-testing/agentic-qe --skill technical-writing -a cursor2Вручную: положить файлы
.cursor/skills/technical-writing/SKILL.mdCursor читает и .agents/skills/, и .claude/skills/
1GitHub CLI
gh skill install proffesor-for-testing/agentic-qe assets/skills/technical-writing2Вручную: положить файлы
.github/skills/technical-writing/SKILL.md1Через Skills CLI (Vercel)
npx skills add proffesor-for-testing/agentic-qe --skill technical-writing -a gemini-cli2Командой платформы
gemini skills install https://github.com/proffesor-for-testing/agentic-qe --path assets/skills/technical-writingВручную: положить файлы
.devin/skills/technical-writing/SKILL.mdСтарый путь .windsurf/skills/ тоже читается
Через Skills CLI (Vercel)
npx skills add proffesor-for-testing/agentic-qe --skill technical-writing -a opencodeClaude.ai
Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills
По шагам, с командами для каждой платформы: Как установить скилл в Claude Code: пять способов
Вопросы о technical-writing
Как установить technical-writing в Claude Code?
Выполните npx skills add proffesor-for-testing/agentic-qe --skill technical-writing -a claude-code, скилл появится в ~/.claude/skills/technical-writing/SKILL.md.
Что делает скилл technical-writing?
Задаёт структуру и правила для технических текстов: блог-постов, документации и туториалов — с акцентом на конкретные примеры вместо общих фраз и запретом на выдуманные цифры.
Чем отличается такой текст от обычного черновика?
Каждое число, срок и дата должны быть привязаны к источнику (трекер, бенчмарк, PR, релиз-ноут); если источника нет, скилл требует оставить плейсхолдер вместо правдоподобной цифры.
Исходный текст
SKILL.md · MIT
---
name: technical-writing
description: "Write clear, engaging technical content from real experience. Use when writing blog posts, documentation, tutorials, or technical articles."
category: communication
priority: medium
tokenEstimate: 800
agents: [qe-quality-analyzer, qe-api-contract-validator]
implementation_status: optimized
optimization_version: 1.0
last_optimized: 2025-12-03
dependencies: []
quick_reference_card: true
tags: [writing, documentation, communication, blogs, tutorials]
trust_tier: 1
validation:
schema_path: schemas/output.json
eval_path: evals/technical-writing.yaml
---
# Technical Writing
<default_to_action>
When writing technical content:
1. LEAD with value (what will reader learn/gain?)
2. SHOW, don't tell (specific examples, code, and numbers you measured or can source)
3. STRUCTURE for scanning (headers, bold, short paragraphs)
4. CUT ruthlessly (every sentence must earn its place)
5. BE honest about trade-offs
6. NEVER invent figures: every number, duration, and date traces to a source (tracker, benchmark, PR, release note). Missing a number? Write `[number?]` and ask, or describe what changed without one.
**Blog Post Structure:**
```markdown
# 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
```
**Before/After:**
❌ "We implemented a comprehensive testing strategy..."
✅ "We moved exploratory testing into sprint planning. QE now pairs with devs during story refinement."
</default_to_action>
## Quick Reference Card
### Core Principles
| Principle | Bad | Good |
|-----------|-----|------|
| **Lead with value** | "In today's landscape..." | "Here's what changed when we moved testing into refinement" |
| **Show, don't tell** | "We improved testing" | "Bugs found per sprint, before and after, from our tracker: [before]→[after]" |
| **Be specific** | "Performance improved" | "p95 response time before and after, with how and where it was measured" |
| **Honest trade-offs** | "This approach is best" | "TDD slowed our first features; here is what we got back, with the numbers we measured" |
| **Source every figure** | "Coverage jumped 40%" (from memory) | The figure plus where it came from, or no figure at all |
Bracketed values are placeholders for your own measured data. Never fill them with plausible-sounding numbers.
### Words to Cut
| 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 |
---
## Audience-Specific Writing
### For Developers
- Lead with code or concrete problem
- Show implementation details
- Discuss trade-offs and alternatives
- Link to repos or examples
### For QA/QE
- Start with testing challenge
- Show strategy, not just tools
- Include risk assessment
- Provide adaptable heuristics
### For Leadership
- Open with business impact
- Use metrics that matter
- Connect technical to outcomes
- Keep technical details concise
---
## Editing Checklist
Before publishing:
- [ ] Title promises something specific
- [ ] Opening hooks in 30 seconds
- [ ] Claims backed by examples
- [ ] Every number, duration, and date traced to a source (or removed)
- [ ] All unnecessary words cut
- [ ] Code examples tested and correct
- [ ] Takeaway crystal clear
- [ ] Would send to respected colleague
---
## Example Transformations
**Before:**
"We decided to implement a more comprehensive testing strategy that would allow us to catch bugs earlier in the development lifecycle."
**After:**
"We moved exploratory testing into sprint planning. QE now pairs with devs during story refinement, identifying risks before code is written."
---
**Before:**
"The benefits of this approach are numerous and include improved quality, faster feedback loops, and better team collaboration."
**After:**
"Three outcomes: bugs now surface during refinement instead of after merge, the regression suite stopped growing with every release, and developers ask QE for input during design." (Add figures only if you measured them, and say where they came from.)
---
## Agent Integration
```typescript
// 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");
```
---
## Agent Coordination Hints
### Memory Namespace
```
aqe/technical-writing/
├── generated-docs/* - Auto-generated documentation
├── reviews/* - Documentation review findings
└── templates/* - Reusable doc templates
```
### Fleet Coordination
```typescript
const docsFleet = await FleetManager.coordinate({
strategy: 'documentation',
agents: [
'qe-quality-analyzer', // Generate and review
'qe-api-contract-validator' // API doc accuracy
],
topology: 'sequential'
});
```
---
## Related Skills
- [bug-reporting-excellence](../bug-reporting-excellence/) - Technical bug writing
- [code-review-quality](../code-review-quality/) - Review documentation
---
## Remember
**You're not writing to impress.** You're writing to help people solve problems you've already solved. Be the colleague you wish you'd had.
**Write from experience.** Only write about what you've done in production. If exploring, say so.
© proffesor-for-testing · MIT · proffesor-for-testing/agentic-qe
Похожие скиллы
Все скиллы по теме «Тексты и документация» →Сначала — technical-writing от других авторов.