Навыки llm-doc-writer
📦

llm-doc-writer

v1.0.0 Безопасно

Создание токен-эффективной документации для LLM

Длинная документация расходует контекст и замедляет работу с помощью ИИ. Этот навык превращает знания о проекте в лаконичные таблицы, списки, примеры и структуру, готовую для агентов.

Поддерживает: Claude Codex Code(CC)
🥈 81 Серебро
1

Скачать ZIP навыка

2

Загрузить в Claude

Перейдите в Settings → Capabilities → Skills → Upload skill

3

Включите и начните использовать

Ресурсы для AI-агентов

Используйте эти ссылки, когда AI-агенту, crawler или script нужен чистый контекст вместо полной страницы.

Markdown-детали GET /skills/aceek-llm-doc-writer.md Подписанный manifest GET /api/skills/aceek-llm-doc-writer/manifest Подписанный lockfile GET /api/skills/aceek-llm-doc-writer/lockfile

Протестировать

Использование «llm-doc-writer». Длинный README с инструкциями по настройке, сведениями о стеке и прозой об архитектуре.

Ожидаемый результат:

Более короткий README с таблицей стека, нумерованными шагами настройки, справочником команд и списком тезисов по архитектуре.

Использование «llm-doc-writer». Проект без инструкций для агентов Claude, Codex или Claude Code.

Ожидаемый результат:

Компактное руководство для агента с командами, соглашениями, заметками об архитектуре и ссылками на подробные файлы.

Использование «llm-doc-writer». Раздел API, написанный абзацами.

Ожидаемый результат:

Удобная для быстрого просмотра сводка endpoints с обязательными полями, ожидаемыми ответами и краткими заметками по использованию.

Аудит безопасности

Безопасно
v7 • 6/28/2026

Static analysis reported external command, network, weak crypto, and reconnaissance patterns. Manual review found only markdown examples, inline code formatting, and ordinary documentation text, with no executable code or malicious intent.

2
Просканировано файлов
282
Проанализировано строк
4
Review items
0
False positives ignored

Confirmed security concerns (4)

Низкий
patterns.md:7patterns.md:23patterns.md:27patterns.md:41patterns.md:49patterns.md:58patterns.md:62patterns.md:65patterns.md:71patterns.md:72patterns.md:80patterns.md:89patterns.md:93patterns.md:97patterns.md:98patterns.md:99patterns.md:100patterns.md:108patterns.md:119patterns.md:123patterns.md:126patterns.md:134SKILL.md:20SKILL.md:30SKILL.md:36SKILL.md:48SKILL.md:52SKILL.md:61SKILL.md:62SKILL.md:63SKILL.md:67SKILL.md:73SKILL.md:75SKILL.md:76SKILL.md:82SKILL.md:93SKILL.md:94SKILL.md:95SKILL.md:103SKILL.md:109
False Positive: Markdown Backticks Misread as Shell Execution
The external command detections are markdown fences or inline command examples. No Ruby code, shell execution logic, or user-controlled command invocation was found.
Both scanned files are markdown documentation. The flagged locations are code fences, inline command examples, or formatting markers, not executable Ruby backtick calls.
Низкий
patterns.md:12patterns.md:19patterns.md:104SKILL.md:3SKILL.md:38SKILL.md:98
False Positive: Weak Crypto Pattern in Documentation Text
The weak cryptography detections match ordinary words and markdown references. No hashing, encryption, signing, or credential handling implementation was found.
Manual review found no cryptographic code. The lines contain documentation prose, headers, or references such as CLAUDE.md.
Низкий
patterns.md:117
False Positive: Network Pattern in Architecture Example
The network detection appears in a prose example about REST APIs between services. No Python HTTP library import, endpoint, or outbound request code was found.
The line is inside a before-and-after documentation example. It describes architecture communication and does not perform network activity.
Низкий
patterns.md:139
False Positive: Reconnaissance Pattern in Section Heading
The reconnaissance detection maps to an anti-patterns heading. No host, user, process, environment, or filesystem discovery command was found.
The flagged line is a markdown heading introducing writing anti-patterns. There is no executable system reconnaissance behavior in the file.
Аудитор:: codex Посмотреть историю аудитов →

Оценка качества

55
Архитектура
100
Сопровождаемость
87
Контент
70
Сообщество
97
Безопасность
91
Соответствие спецификации

Что вы можете построить

Подготовка контекста для агента

Создать лаконичный CLAUDE.md или файл инструкций для агента для существующей кодовой базы.

Сжатие технической документации

Переписать длинные разделы по настройке, архитектуре или API в удобную для быстрого просмотра документацию.

Стандартизация проектных README

Создать согласованные разделы README для стека, команд, соглашений и ссылок.

Попробуйте эти промпты

Составить базовый документ для агента 
Create a CLAUDE.md for this project. Include stack, commands, architecture, conventions, and links to detail files.
Переписать многословную документацию 
Rewrite this documentation for LLM context. Use tables, bullets, and examples. Remove filler and redundant statements.
Спроектировать разбиение документации 
Review this long project document. Propose a main agent doc plus focused files for architecture, API, and workflows.
Провести аудит токен-эффективности 
Audit this documentation for token efficiency. Identify verbose sections, missing commands, unclear conventions, and content to split.

Лучшие практики

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

Избегать

  • Не используйте навык для выдумывания отсутствующих сведений о проекте.
  • Не оставляйте длинные повествовательные абзацы, когда таблица или список понятнее.
  • Не помещайте все детали проекта в один файл контекста для агента.

Часто задаваемые вопросы

Какой тип документации создает этот навык?
Он создает лаконичную документацию для ИИ-ассистентов, включая файлы CLAUDE.md, разделы README и инструкции для агентов.
Может ли он улучшить существующий README?
Да. Он может переписывать многословные разделы в таблицы, списки, примеры и более короткие справочные материалы.
Выполняет ли он проектные команды?
Нет. Навык предоставляет рекомендации по написанию и примеры. Он не выполняет команды.
Полезен ли он для Codex и Claude Code?
Да. Он фокусируется на контексте, который помогает Claude, Codex и Claude Code быстро понять репозиторий.
Может ли он проверять техническую точность?
Нет. Пользователям следует сверять сгенерированные команды, заметки об архитектуре и сведения об API с проектом.
Когда следует разбивать длинные документы?
Разбивайте документы, когда основной файл становится трудно просматривать или он превышает объем основного контекста, необходимого ассистенту.

Сведения для разработчиков

Автор

Aceek

Лицензия

MIT

Version

v1.0.0

Репозиторий

https://github.com/Aceek/claude-config/tree/master/src/skills/llm-doc-writer

Ссылка

master

Структура файлов

📄 patterns.md

📄 SKILL.md