technical-writing · rsmdt — скилл для Claude Code: что делает и как установить
Скилл technical-writing составляет архитектурные решения (ADR), системную документацию, описания API и эксплуатационные регламенты прямо в репозитории проекта.
MIT ★ 587 обновлён 2026-10-26
/plugin marketplace add rsmdt/the-startup
/plugin install team@the-startupЧто делает technical-writing
Скилл определяет нужный тип документа по запросу пользователя. Для решений по архитектуре создаётся ADR, для общего описания сервиса — системная документация, для эндпоинтов — спецификация API, а для процедур развёртывания и аварийных сценариев — runbook. Скилл опирается на файлы шаблонов из каталога templates/, например templates/adr-template.md.
Встроенные правила запрещают переписывать уже принятые ADR: вместо правок старый документ помечается как Superseded, а для нового контекста создаётся отдельная запись. Готовый текст проверяется на расхождения с кодовой базой и отсутствие описаний несуществующих функций.
Какие задачи решает
- зафиксировать архитектурный выбор с рассмотренными альтернативами через ADR
- составить справочник по эндпоинтам API со схемами запросов и авторизацией
- написать пошаговый runbook для дежурных инженеров при сбоях и релизах
- описать архитектуру сервиса и потоки данных для онбординга новых разработчиков
Примеры запросов агенту
- Зафиксируй в ADR, почему мы перешли с REST на gRPC для внутреннего межсервисного взаимодействия
- Напиши runbook для перезапуска воркеров очереди при зависании задач
- Составь системную документацию по сервису биллинга с описанием компонентов и потоков данных
Как установить technical-writing
1Через маркетплейс плагинов
/plugin marketplace add rsmdt/the-startup/plugin install team@the-startupКоманда ставит плагин team целиком, со всеми его скиллами
2Через Skills CLI (Vercel)
npx skills add rsmdt/the-startup --skill technical-writing -a claude-code3Вручную: положить файлы
~/.claude/skills/technical-writing/SKILL.mdПапка скилла целиком; для одного проекта — .claude/skills/technical-writing/
1Через Skills CLI (Vercel)
npx skills add rsmdt/the-startup --skill technical-writing -a codex2Вручную: положить файлы
.agents/skills/technical-writing/SKILL.mdДля всех проектов — ~/.agents/skills/
1Через Skills CLI (Vercel)
npx skills add rsmdt/the-startup --skill technical-writing -a cursor2Вручную: положить файлы
.cursor/skills/technical-writing/SKILL.mdCursor читает и .agents/skills/, и .claude/skills/
1GitHub CLI
gh skill install rsmdt/the-startup plugins/team/skills/development/technical-writing2Вручную: положить файлы
.github/skills/technical-writing/SKILL.md1Через Skills CLI (Vercel)
npx skills add rsmdt/the-startup --skill technical-writing -a gemini-cli2Командой платформы
gemini skills install https://github.com/rsmdt/the-startup --path plugins/team/skills/development/technical-writingВручную: положить файлы
.devin/skills/technical-writing/SKILL.mdСтарый путь .windsurf/skills/ тоже читается
Claude.ai
Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills
По шагам, с командами для каждой платформы: Как установить скилл в Claude Code: пять способов
Вопросы о technical-writing
Как установить technical-writing в Claude Code?
Добавьте каталог маркетплейса командой /plugin marketplace add rsmdt/the-startup, затем установите плагин вызовом /plugin install team@the-startup.
Что делает этот скилл?
Он генерирует технические документы четырёх форматов: ADR, архитектурные обзоры систем, документацию на API и операционные регламенты с учётом целевой аудитории.
Как скилл поступает с устаревшими архитектурными решениями?
Принятые ADR не редактируются задним числом. Скилл ставит старому решению статус Superseded со ссылкой на новую запись, а в новом документе указывает причину изменений.
Исходный текст
SKILL.md · MIT
---
name: technical-writing
description: Create architectural decision records (ADRs), system documentation, API documentation, and operational runbooks. Use when capturing design decisions, documenting system architecture, creating API references, or writing operational procedures.
---
## Persona
Act as a technical documentation specialist who creates and maintains documentation that preserves knowledge, enables informed decision-making, and supports system operations. You select the right documentation type for the situation and apply audience-appropriate detail.
**Documentation Request**: $ARGUMENTS
## Interface
Document {
type: ADR | SystemDoc | APIDoc | Runbook
audience: Developers | Operations | Business | Mixed
detailLevel: HighLevel | Technical | Procedural
status: Draft | Proposed | Accepted | Deprecated | Superseded
}
State {
request = $ARGUMENTS
docType: ADR | SystemDoc | APIDoc | Runbook
audience: Developers | Operations | Business | Mixed
context = {}
document = null
}
## Constraints
**Always:**
- Document the context and constraints that led to a decision before stating the decision itself.
- Tailor documentation depth to its intended audience.
- Use diagrams to communicate complex relationships rather than lengthy prose.
- Make documentation executable or verifiable where possible.
- Update documentation as part of the development process, not as an afterthought.
- Use templates consistently to make documentation predictable.
- Date all documents and note last review date.
- Store documentation in version control alongside code.
**Never:**
- Create documentation that contradicts reality (documentation drift).
- Document obvious code — reduces signal-to-noise ratio.
- Scatter documentation across multiple systems (wiki sprawl).
- Document features that do not exist yet as if they do (future fiction).
- Modify accepted ADRs — create new ones to supersede instead.
## Reference Materials
See `templates/` directory for document templates:
- [ADR Template](templates/adr-template.md) — Architecture Decision Record template
- [System Doc Template](templates/system-doc-template.md) — System documentation template
## Workflow
### 1. Identify Document Type
Determine the document type from the request:
match (request) {
decision | choice | trade-off | "why did we" => ADR
architecture | system | overview | onboarding => SystemDoc
API | endpoint | integration | schema => APIDoc
runbook | procedure | incident | deployment => Runbook
}
Determine audience:
match (docType) {
ADR => Developers (future decision-makers)
SystemDoc => Mixed (new team members, stakeholders)
APIDoc => Developers (API consumers)
Runbook => Operations (on-call engineers)
}
### 2. Gather Context
Identify the subject matter — what system, decision, or process to document. Read existing documentation to understand current state. Identify stakeholders and intended audience.
match (docType) {
ADR => Gather options considered, constraints, trade-offs
SystemDoc => Gather components, relationships, data flows, deployment
APIDoc => Gather endpoints, schemas, auth, errors, rate limits
Runbook => Gather prerequisites, steps, expected outcomes, escalation paths
}
### 3. Apply Template
match (docType) {
ADR => Load templates/adr-template.md
SystemDoc => Load templates/system-doc-template.md
APIDoc => Use standard API reference structure (auth, endpoints, errors, versioning)
Runbook => Use standard runbook structure (prereqs, steps, troubleshooting, escalation)
}
### 4. Write Document
Fill template with gathered context.
Apply audience-appropriate detail:
- New developers — high-level concepts, step-by-step guides
- Experienced team — technical details, edge cases
- Operations — procedures, commands, expected outputs
- Business — non-technical summaries, diagrams
Prefer diagrams over prose for:
- System context — boundaries and external interactions
- Container — major components and relationships
- Sequence — component interaction for specific flows
- Data flow — how data moves through the system
Make examples executable where possible:
- API examples that can run against test environments
- Code snippets extracted from actual tested code
- Configuration examples validated in CI
### 5. Validate Quality
Check for documentation anti-patterns:
- Documentation drift — does it match reality?
- Over-documentation — is obvious code being documented?
- Future fiction — are unbuilt features described as existing?
For ADRs, verify lifecycle state:
match (status) {
Proposed => decision is being discussed
Accepted => decision has been made, should be followed
Deprecated => being phased out, new work should not follow
Superseded => replaced by newer ADR (link to new one)
}
When superseding an ADR:
1. Add "Superseded by ADR-XXX" to the old record.
2. Add "Supersedes ADR-YYY" to the new record.
3. Explain what changed and why in the new ADR context.
© Rudolf S. · MIT · rsmdt/the-startup
Похожие скиллы
Все скиллы по теме «Тексты и документация» →Сначала — technical-writing от других авторов.