Documentation Specialist Skill

Скилл для технической документации: SRS, PRD, SDD и OpenAPI по шаблонам, обратная генерация из кода и аудит качества.

  • 55 ★ репозитория
  • Последний коммит
Скилл

Минимальный доступ

Почему такой уровень

  • Скилл читает код проекта и пишет документы в репозиторий.
Все причины и проверки

spillwavesolutions/document-specialist-skill

Установка

В терминале, через SkillFoxx CLI

npx skillfoxx add skills/documentation-specialist-skill

Определит агенты на машине, покажет уровень доступа и зафиксирует версию.

Другие способы установки

Доступ и проверки

Как мы проверяем

Минимальный доступИнструмент ничего не запускает и не ходит в сеть.

  • Скилл читает код проекта и пишет документы в репозиторий.

Это чужой код. Посмотрите файлы в репозитории перед установкой.

Что делает

Documentation Specialist превращает Claude Code в специалиста по программной документации и строится на прогрессивном раскрытии (PDA), чтобы тратить меньше токенов. Режим с нуля создает документы по шаблонам: SRS по IEEE 830, PRD, SDD по arc42, OpenAPI 3.0 и архитектурный обзор по C4. Режим обратной генерации собирает документацию из готового кода: для Spring Boot контроллеры превращаются в OpenAPI, сущности в ER-диаграммы, сервисы в SDD, а для инфраструктуры на Pulumi ресурсы идут в документы о развертывании. Третий режим проверяет качество: чек-листы, оценка полноты, сверка с практиками IEEE, OpenAPI и WCAG, рекомендации и автоматические исправления частых проблем. Вывод в Markdown, а DOCX и PDF получают через соседние скиллы. Диаграммы строятся в Mermaid, а PlantUML берется для вайрфреймов, диаграмм вариантов использования и ArchiMate.

Для кого. Разработчикам, техническим писателям и аналитикам, которым нужны требования, проектная и API-документация без ручной сборки шаблонов.

Подходит, если

  • Для платежной системы пишут SRS по стандарту IEEE 830.
  • Из контроллеров Spring Boot собирают спецификацию OpenAPI и схему базы.
  • Готовую документацию проверяют на полноту и получают список правок.
  • Для архитектуры строят диаграммы C4 в Mermaid.

Не подходит, если

  • Нужна маркетинговая или юридическая документация.
  • Проект на стеке, для которого отображение кода пока не готово.
  • Требуется готовый DOCX без установки соседних скиллов.

Пример запроса к агенту

Создай Software Requirements Specification для платежной системы по IEEE 830 и положи в docs/.

Ограничения

Полное отображение кода в документы сейчас есть для Spring Boot и Pulumi. FastAPI, Express.js, Django, Flask, Terraform, AWS CDK, React, Next.js, Vue.js, Python ETL и Airflow в README отмечены как планируемые. Для DOCX и PDF используются отдельные скиллы `docx` и `pdf`, для диаграмм `design-doc-mermaid` и `plantuml`. Лицензия в репозитории не указана, проверьте условия использования. Сгенерированные документы нужно вычитывать: скилл собирает их из кода и шаблонов, а не из знаний вашей команды.

Как отключить. Удалите папку `document-specialist-skill` из `~/.claude/skills/` или отключите плагин командами Claude Code. Созданные документы остаются в проекте.

Частые вопросы

Как поставить скилл в Claude Code?

Командами `claude plugin marketplace add SpillwaveSolutions/document-specialist-skill` и `claude plugin install document-specialist`. Можно также клонировать репозиторий в `~/.claude/skills`.

Какие документы создает скилл?

SRS по IEEE 830, PRD, SDD по arc42, спецификацию OpenAPI 3.0 и архитектурный обзор C4. Руководства пользователя и документы развертывания пока на уровне шаблонов.

Из какого кода можно собирать документацию?

Полностью отображены Spring Boot и Pulumi. Остальные фреймворки в README помечены как планируемые.

Работает ли в Codex и Cursor?

Да, в репозитории есть `.codex-plugin`, `.cursor-plugin` и корневой `plugin.json` по стандарту Agent Plugins 1.0.

Как поставить через Skilz?

Командой `skilz install SpillwaveSolutions_document-specialist-skill/documentation-specialist`.

Обсуждение

Вопросов и отзывов пока нет.

Скиллы

16 готовых скиллов для Cursor, Claude Code и Codex: диссертации, PDF и Office, схемы draw.io, документация проекта

СкиллРасширенный доступ3,2 тыс.Звезды репозитория

Четыре скилла для Claude Code и Codex: Word с правками, PDF с формами и OCR, PowerPoint из HTML, Excel с пересчетом формул.

ПлагинМинимальный доступ185Звезды репозитория
Официальный

Официальный набор скиллов «Золотых документов» WPS: Claude Code и Codex создают и правят облачные документы через kdocs-cli

СкиллШирокий доступ66Звезды репозитория

Скилл верстает по шаблонам резюме, одностраничники, письма, отчеты и слайды в PDF, PNG и PPTX и проверяет результат скриптами до выдачи

СкиллРасширенный доступ12,5 тыс.Звезды репозитория

Скилл рисует проверенные схемы архитектуры, процессов, последовательностей и потоков данных в один интерактивный HTML-файл

СкиллРасширенный доступ95,9 тыс.Звезды репозитория

Скилл для китайских технических текстов: правит документацию, интерфейсные строки и описания API, держит факты и проверяет выдачу линтером

СкиллМинимальный доступ1,6 тыс.Звезды репозитория

Коротко о README

Документация описывает версию 3.3.1, способы установки для четырех сред, три режима работы и примеры запросов. Заявлено сокращение расхода токенов на 44–72 процента относительно версии 1.0.

Бейдж для README

Исходный SKILL.md

---
name: "documentation-specialist"
description: |
  This skill should be used when creating professional software documentation (SRS, PRD, OpenAPI,
  SDD, architecture docs, user manuals, tutorials, runbooks) from templates (greenfield) or reverse-engineering
  documentation from existing code like Spring Boot or FastAPI (brownfield). Also handles documentation
  audits/reviews, format conversion (Markdown, DOCX, PDF), and diagram generation (Mermaid first: C4,
  sequence, class, ER, state, flowchart; PlantUML Salt for UI wireframes and leftover UML). Use when
  asked to "create documentation", "document my code", "write SRS", "generate PRD", "write DESIGN_DOC.md",
  "architecture document", "wireframe", or "documentation specialist".
version: "3.3.1"
allowed-tools: ["Read", "Write", "Edit", "Glob", "Grep", "Bash", "Skill"]
---

# Documentation Specialist Skill

## Quick Start

Software documentation creation, extraction, conversion, and diagramming capabilities.

**Capabilities:**
1. **Greenfield** - Create documentation from templates (SRS, PRD, SDD/DESIGN_DOC.md, architecture, OpenAPI, User Manuals, Tutorials, Runbooks)
2. **Brownfield** - Reverse-engineer documentation from code (Spring Boot, FastAPI)
3. **Audit** - Review and improve existing documentation
4. **Convert** - Transform formats (MD to DOCX to PDF)
5. **Diagram** - Mermaid first (C4, sequence, class, ER, state, flowchart). PlantUML Salt for UI wireframes. PlantUML for leftover UML (use case, timing, ArchiMate, nwdiag, WBS).

**Example Requests:**
```
Create an SRS for a billing system with PCI-DSS compliance
Write DESIGN_DOC.md for this repository using arc42
Create an architecture document with C4-style Mermaid
Document my Spring Boot application at ~/projects/customer-api
Create a user manual for my SaaS product
Write a database failover runbook
Audit my API documentation at docs/api/openapi.yaml
Convert docs/srs.md to Word format
Create a C4 container diagram for my microservices
Draw a login wireframe
```

**Execution Flow:**
1. Classify intent to 2. Choose one voice pack to 3. Load workflow to 4. Execute steps to 5. Generate documentation to 6. Present post-processing options

---

Сообщить о проблеме