iiuniversitet.ruЦентр обучения нейросетямОткрыть каталог

Техническая документация

Пишет README, документацию к API, ранбуки и архитектурные документы для нужной аудитории.

СкиллAnthropicClaudeApache-2.0Загрузить архив в ClaudeПроверка не требуется
Скачать на русскомОригинал на английском (архив)Источник ↗
Что делает
Пишет README, документацию к API, ранбуки и архитектурные документы для нужной аудитории.
Когда брать
Когда нужен технический текст: README, описание API, инструкция для дежурных или руководство для новичков.
Пример запроса
Напиши README для моего проекта: что это, как запустить за пять минут и как помочь в разработке.

Входит в плагин engineering. В Cowork и Claude Code можно поставить плагин целиком.

Как включить

  1. Нажмите «Скачать на русском» и сохраните архив.
  2. В Claude откройте Настройки → Capabilities → Skills → Upload skill и выберите архив.
  3. Включите скилл переключателем.
Для терминала

Распакуйте архив и положите папку documentation в ~/.claude/skills/. Файл SKILL.md должен лежать внутри этой папки.

Текст

---
name: documentation
description: Написание и поддержка технической документации. Запускай по фразам «напиши документацию к», «задокументируй это», «создай README», «напиши ранбук», «руководство по адаптации», а также когда пользователю нужна помощь с любым техническим текстом — документацией к API, архитектурными документами или операционными ранбуками.
---

Техническая документация

Пиши понятную и удобную в сопровождении техническую документацию для разных аудиторий и задач.

Виды документов

README

  • Что это и зачем существует
  • Быстрый старт (меньше 5 минут до первого успеха)
  • Настройка и использование
  • Руководство для участников проекта

Документация к API

  • Справочник по методам с примерами запросов и ответов
  • Аутентификация и коды ошибок
  • Лимиты запросов и постраничная выдача
  • Примеры для SDK

Ранбук

  • Когда использовать этот ранбук
  • Предварительные условия и нужные доступы
  • Пошаговая процедура
  • Шаги отката
  • Путь эскалации

Архитектурный документ

  • Контекст и цели
  • Общий замысел с диаграммами
  • Ключевые решения и компромиссы
  • Потоки данных и точки интеграции

Руководство по адаптации

  • Настройка окружения
  • Ключевые системы и как они связаны
  • Типовые задачи с пошаговыми примерами
  • К кому с каким вопросом идти

Принципы

  1. Пиши для читателя — кто это будет читать и что ему нужно?
  2. Начинай с самого полезного — не прячь главное
  3. Показывай, а не рассказывай — примеры кода, команды, скриншоты
  4. Держи актуальным — устаревшая документация хуже, чем её отсутствие
  5. Ссылайся, а не дублируй — отсылай к другим документам вместо копирования

Перевод: iiuniversitet. Оригинал: https://github.com/anthropics/knowledge-work-plugins/tree/main/engineering/skills/documentation, лицензия Apache-2.0. Изменения: перевод на русский язык.

Оригинал на английском 
---
name: documentation
description: Write and maintain technical documentation. Trigger with "write docs for", "document this", "create a README", "write a runbook", "onboarding guide", or when the user needs help with any form of technical writing — API docs, architecture docs, or operational runbooks.
---

# Technical Documentation

Write clear, maintainable technical documentation for different audiences and purposes.

## Document Types

### README
- What this is and why it exists
- Quick start (< 5 minutes to first success)
- Configuration and usage
- Contributing guide

### API Documentation
- Endpoint reference with request/response examples
- Authentication and error codes
- Rate limits and pagination
- SDK examples

### Runbook
- When to use this runbook
- Prerequisites and access needed
- Step-by-step procedure
- Rollback steps
- Escalation path

### Architecture Doc
- Context and goals
- High-level design with diagrams
- Key decisions and trade-offs
- Data flow and integration points

### Onboarding Guide
- Environment setup
- Key systems and how they connect
- Common tasks with walkthroughs
- Who to ask for what

## Principles

1. **Write for the reader** — Who is reading this and what do they need?
2. **Start with the most useful information** — Don't bury the lede
3. **Show, don't tell** — Code examples, commands, screenshots
4. **Keep it current** — Outdated docs are worse than no docs
5. **Link, don't duplicate** — Reference other docs instead of copying

Источник: anthropics/knowledge-work-plugins / engineering / documentation ↗. Ссылка проверена 2026-10-10.

Похожие