Навыки documentation-generation-doc-generate

📦

documentation-generation-doc-generate

Name: documentation-generation-doc-generate
Author: sickn33

Ревизия содержимого r2 Безопасно ⚙️ Внешние команды🌐 Доступ к сети📁 Доступ к файловой системе🔑 Переменные окружения

Создание поддерживаемой документации к коду

Ручная документация часто отстает от активно развивающегося кода. Этот навык помогает Claude, Codex и Claude Code создавать понятную документацию и планы автоматизации.

Поддерживает: Claude Codex Code(CC)

🥉 79 Бронза

Установить с помощью моего Агента

Скопируйте этот запрос в своего Агента. Он содержит каноническую страницу Skill и манифест.

Запрос агента

Review the Skillstore skill "documentation-generation-doc-generate" from https://skillstore.io/skills/sickn33-documentation-generation-doc-generate.md and its manifest at https://skillstore.io/api/skills/sickn33-documentation-generation-doc-generate/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.

Ваш Агент по-прежнему должен показать план и запросить все подтверждения, требуемые политикой безопасности.

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

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

Markdown-детали GET /skills/sickn33-documentation-generation-doc-generate.md Подписанный manifest GET /api/skills/sickn33-documentation-generation-doc-generate/manifest Подписанный lockfile GET /api/skills/sickn33-documentation-generation-doc-generate/lockfile

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

Использование «documentation-generation-doc-generate». Backend-сервису нужна документация перед запуском API.

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

Структура справочника API с группами endpoint, примечаниями по authentication и разделами ошибок.
Открытые вопросы о версионировании, rate limits и sample responses.
Рекомендуемые шаги проверки перед публикацией.

Использование «documentation-generation-doc-generate». Команда хочет архитектурную документацию для микросервисной системы.

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

Обзор системы с обязанностями сервисов и потоками данных.
План диаграмм с использованием Mermaid notation в качестве целевого формата.
Риски и допущения, требующие проверки владельцем.

Использование «documentation-generation-doc-generate». В репозитории разрозненные заметки по setup и нет contributor guide.

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

Структура README с разделами setup, configuration, testing и contribution.
Список недостающих фактов для проверки с maintainers.
Чек-лист автоматизации для поддержания документации в актуальном состоянии.

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

Безопасно

v5 • 23.07.2026 Открыть версионный отчет

All 30 static findings are false positives caused by prose, Markdown formatting, placeholders, and illustrative code or workflow examples. The skill contains no executable scripts and does not directly access commands, networks, files, or environment secrets. No prompt injection or malicious intent was found.

Просканировано файлов

698

Проанализировано строк

Пункты проверки

Ложные срабатывания проигнорированы

Факторы риска

⚙️ Внешние команды (9)

resources/implementation-playbook.md:253-254 resources/implementation-playbook.md:254-255 resources/implementation-playbook.md:255-256 resources/implementation-playbook.md:256-259 resources/implementation-playbook.md:355-356 resources/implementation-playbook.md:356-357 resources/implementation-playbook.md:357-363 SKILL.md:37 SKILL.md:51

🌐 Доступ к сети (8)

resources/implementation-playbook.md:509 resources/implementation-playbook.md:503 resources/implementation-playbook.md:138 resources/implementation-playbook.md:469 resources/implementation-playbook.md:474 resources/implementation-playbook.md:500 resources/implementation-playbook.md:509 resources/implementation-playbook.md:520

📁 Доступ к файловой системе (1)

resources/implementation-playbook.md:589

🔑 Переменные окружения (7)

resources/implementation-playbook.md:568 resources/implementation-playbook.md:319 resources/implementation-playbook.md:320 resources/implementation-playbook.md:321 resources/implementation-playbook.md:501 resources/implementation-playbook.md:511 resources/implementation-playbook.md:521

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

Аудитор:: codex Посмотреть историю аудитов →

Поделиться и цитировать этот отчет

Делитесь версионным отчетом об оценке, нейтральным значком, встраиваемой карточкой и цитатами. Skillstore публикует доказательства, не решая, безопасен ли этот Skill.

Открыть версионный отчет

Копировать ссылку на отчёт

https://skillstore.io/skills/sickn33-documentation-generation-doc-generate/audits/5?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

Значок Markdown

[![Skillstore security assessment](https://skillstore.io/badges/skills/sickn33-documentation-generation-doc-generate/security.svg)](https://skillstore.io/skills/sickn33-documentation-generation-doc-generate?utm_source=security_passport_badge)

Значок HTML

<a href="https://skillstore.io/skills/sickn33-documentation-generation-doc-generate?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/sickn33-documentation-generation-doc-generate/security.svg" alt="Skillstore security assessment" loading="lazy"></a>

Встраиваемая карточка

<iframe src="https://skillstore.io/embed/skills/sickn33-documentation-generation-doc-generate.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>

Академические ссылки (APA · BibTeX · CFF)

Цитата APA

sickn33. (2026). documentation-generation-doc-generate security audit report (audit version 5) [Author version unspecified]. Skillstore. https://skillstore.io/skills/sickn33-documentation-generation-doc-generate/audits/5

Цитата BibTeX

@techreport{sickn33-sickn33-documentation-generation-doc-generate-2026,
  author = {sickn33},
  title = {documentation-generation-doc-generate security audit report (audit version 5)},
  institution = {Skillstore},
  year = {2026},
  number = {5},
  url = {https://skillstore.io/skills/sickn33-documentation-generation-doc-generate/audits/5},
  note = {Author version unspecified}
}

CITATION.cff

cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "documentation-generation-doc-generate security audit report (audit version 5)"
version: "unspecified"
type: report
authors:
  - name: "sickn33"
date-released: "2026-07-23"
url: "https://skillstore.io/skills/sickn33-documentation-generation-doc-generate/audits/5"
identifiers:
  - type: other
    value: "skillstore:sickn33-documentation-generation-doc-generate:audit:5"
    description: "Skillstore immutable audit report identifier"

Оценка Skillstore

Почему такая оценка Достоверность доказательств: Высокий

Архитектура

Сопровождаемость

Контент

Сообщество

Соответствие спецификации

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

Документирование релиза API

Создавайте справочники endpoint, примечания по authentication, описания response и интерактивную API documentation на основе существующих route definitions.

Объяснение системной архитектуры

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

Стандартизация документации проекта

Создавайте разделы README, setup, user guide, contribution и troubleshooting с единообразной структурой.

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

Создать план документации

Review this repository and propose a documentation plan. Include the audiences, required documents, source files to inspect, and open questions.

Создать черновик справочника API

Analyze the route definitions and draft API documentation. Include endpoints, parameters, authentication, errors, examples, and validation gaps.

Создать архитектурную документацию

Create architecture documentation for this application. Include components, data flows, dependencies, diagrams, operational concerns, and assumptions.

Спроектировать автоматизацию документации

Design a documentation automation workflow. Include generation steps, linting, coverage checks, review gates, deployment, and maintenance risks.

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

Проверяйте сгенерированную документацию по исходному коду перед публикацией.
Заменяйте все placeholders значениями, специфичными для проекта.
Удаляйте secrets, internal URLs и конфиденциальные детали реализации.

Избегать

Публикация сгенерированной документации без проверки maintainer.
Копирование placeholder commands или tokens в production docs.
Документирование деталей private infrastructure в публичных репозиториях.

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

Какие типы документации может создавать этот навык?

Он поддерживает API docs, архитектурные заметки, содержимое README, user guides, developer guides и планы автоматизации документации.

Он автоматически изменяет мой код?

Нет. Он сосредоточен на планировании документации, черновиках, шаблонах и чек-листах проверки.

Может ли он создавать документацию OpenAPI?

Да. Playbook включает примеры структуры OpenAPI и шаблоны интерактивной API documentation.

Может ли он создавать диаграммы?

Да. Он включает примеры архитектурных и компонентных диаграмм на основе Mermaid.

Стоит ли сразу публиковать сгенерированную документацию?

Нет. Перед публикацией проверьте точность, безопасность, placeholders, links и соответствие аудитории.

Он работает с Claude, Codex и Claude Code?

Да. В отчете Claude, Codex и Claude Code указаны как поддерживаемые инструменты.

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

Автор

sickn33

Лицензия

MIT

Ревизия Skillstore

Примечание о версии

Автор не указал версию.

Репозиторий

https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/documentation-generation-doc-generate

Ссылка

f9e2c34b4f19c7f3e6b0a1e93227b5f77cc12526

Актуальность поддержки

29.07.2026

Использование

10 загрузок · 108 просмотров

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

📁 resources/

📄 implementation-playbook.md

📄 SKILL.md