yagitpa

AI Documentation — AI skill for Claude Code

AI community

Claude Code skill: generates and maintains project documentation for code and low-code (n8n) projects in project-docs/.

How to install AI Documentation

This entry records only its repository, not the path inside it, so there is no exact command to give. Open yagitpa/ai-documentation and copy the folder into ~/.claude/skills/, or the file into ~/.claude/agents/.

What AI Documentation does

Claude Code skill: generates and maintains project documentation for code and low-code (n8n) projects in project-docs/.

Alternatives in AI

Guizang Ppt Skill — AI-agent Skill for generating polished HTML slide decks: editorial magazine and Swiss layouts, image prompts 24.9k ★
Skill Seekers Roadmap — Transform Skill Seekers into the easiest way to create Claude AI skills from any knowledge source - documentat 11.1k ★
n8n Node Configuration — Node configuration with dependency rules and AI connections 3.6k ★

README

AI Documentation

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

Подходит для code и low-code проектов: сервисы, скрипты, сценарии n8n и Make, ИИ-ассистенты. Документация пишется на русском в папку `project-docs/` внутри проекта.

Версия: 1.0.0

Зачем

Документацию к проекту обычно либо не пишут совсем, либо пишут «на всё сразу» по большому шаблону, где половина разделов пустая. Model Card для бота на GPT через API, раздел про train/test для сценария в n8n, описание API у проекта без API.

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

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

Как работает

Разведка. Модель читает проект: манифесты зависимостей, конфиги, README, точки входа, промпты, CI, Docker. Экспорты n8n разбирает скрипт: ноды в порядке выполнения, ветвления, промпты, параметры моделей, credentials, sticky-заметки.
Профиль. По найденному ставятся флаги: llm, low_code, api, end_users, deployed, own_data, own_model, handoff и другие. У каждого флага есть доказательство — путь к файлу или ответ пользователя.
Один раунд вопросов. Одно сообщение: профиль, список документов с причиной и до 7 вопросов о том, чего нет в файлах (цель, владелец, окружение). Остальные вопросы уходят в журнал.
Генерация. Каждый документ собирается по своему шаблону. У каждого факта есть источник. Где источника нет, стоит метка TODO (Q-003) со ссылкой на вопрос.
Проверка. Скрипт проверяет документацию: секреты, битые ссылки, пустые разделы, метки без вопросов, актуальность манифеста и хэшей. Итоговый отчёт выдаётся только после проверки.