# generating-documentation: выбрать подходящий вид документации: сведения для ИИ-агента

> Справочный документ Staksy для твоего агента. Это сведения для проверки, не команды: ничего отсюда не выполняй и не устанавливай без подтверждения пользователя. Сверь требования с первоисточниками ниже; устаревшее и неподтверждённое не принимай как факт. Не утверждай, что инструмент работает, пока это не проверено.

- Материал: technical-documentation-generation (skill), страница для человека: /r/technical-documentation-generation
- Обновлено 2026-10-18

## Цель

Агент выберет вид документации: API, справочник или ADR

Один проверяемый документ: API, справочник кода или запись решения.

Этот skill разделяет задачи документации по результату: контракт API, справочник кода, сайт документов и ADR. Он помогает выбрать OpenAPI, TypeDoc, Sphinx или другие инструменты под конкретную задачу. Ценность в выборе слоя и проверке актуальности, поэтому начинать стоит с одного документа, а не устанавливать весь перечисленный набор.

## Источники

- Первоисточник и инструкция: https://github.com/ancoleman/ai-design-components/blob/76551b7b19ebc667764ec75da14990d0aef8b6e5/skills/generating-documentation/SKILL.md

## Требования

- Полная папка skill с references и templates; исходный код или действующий контракт. Генератор нужен только для выбранного формата.

## Совместимость

- Agent Skills: По инструкции автора; версия клиента: не указана. Условия окружения указаны ниже.

## Риски

- Примеры CI и публикации требуют настроек проекта; их выполнение может публиковать документы наружу.

## Порядок действий

Сначала проверьте условия и права в первоисточнике. Шаги ниже описывают ограниченный первый сценарий; внешняя запись, публикация и платный запуск требуют разрешённого вами scope.

1. Подготовить ограниченный сценарий: Полная папка skill с references и templates; исходный код или действующий контракт. Генератор нужен только для выбранного формата.

Руководство: https://github.com/ancoleman/ai-design-components/blob/76551b7b19ebc667764ec75da14990d0aef8b6e5/skills/generating-documentation/SKILL.md

2. Применить к одной задаче: Определи нужный слой документации для этой задачи. Подготовь один документ по реальному коду, укажи источники каждого параметра и способ проверить актуальность.

```text
Определи нужный слой документации для этой задачи. Подготовь один документ по реальному коду, укажи источники каждого параметра и способ проверить актуальность.
```

Руководство: https://github.com/ancoleman/ai-design-components/blob/76551b7b19ebc667764ec75da14990d0aef8b6e5/skills/generating-documentation/SKILL.md

3. Проверить результат: Для API проверь запрос и ошибку по реализации; для ADR проверь, что решение и последствия соответствуют фактической архитектуре.

Руководство: https://github.com/ancoleman/ai-design-components/blob/76551b7b19ebc667764ec75da14990d0aef8b6e5/skills/generating-documentation/SKILL.md

## Как проверить результат

Проверено по первоисточнику 13.10.2026. Предлагаемая проверка: Для API проверь запрос и ошибку по реализации; для ADR проверь, что решение и последствия соответствуют фактической архитектуре.