Навыки when-documenting-code-use-doc-generator

📦

when-documenting-code-use-doc-generator

Name: when-documenting-code-use-doc-generator
Author: DNYoussef

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

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

В кодовых базах часто не хватает актуальных справочников API, файлов README, комментариев и диаграмм. Этот навык анализирует структуру проекта и создает документационные материалы для рабочих процессов Claude, Codex и Claude Code.

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

⚠️ 38 Плохо

Остановитесь и запросите подтверждение перед установкой.

Проверьте план и получите явное согласие пользователя перед изменением файлов.

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

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

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

Review the Skillstore skill "when-documenting-code-use-doc-generator" from https://skillstore.io/skills/dnyoussef-when-documenting-code-use-doc-generator.md and its manifest at https://skillstore.io/api/skills/dnyoussef-when-documenting-code-use-doc-generator/manifest. Verify the artifact. Stop and obtain explicit user consent before installing or changing files.

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

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

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

Markdown-детали GET /skills/dnyoussef-when-documenting-code-use-doc-generator.md Подписанный manifest GET /api/skills/dnyoussef-when-documenting-code-use-doc-generator/manifest Подписанный lockfile GET /api/skills/dnyoussef-when-documenting-code-use-doc-generator/lockfile

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

Использование «when-documenting-code-use-doc-generator». В проекте Node.js API есть маршруты, но нет справочника API.

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

Навык создает обзор API со сводками эндпоинтов, заметками об аутентификации, описаниями ответов и ссылками на сгенерированные файлы документации.

Использование «when-documenting-code-use-doc-generator». В репозитории устаревший README и отсутствуют инструкции по настройке.

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

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

Использование «when-documenting-code-use-doc-generator». Папка с исходным кодом содержит публичные функции без комментариев.

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

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

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

Высокий риск

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

Most static findings are false positives from Markdown examples, generated documentation placeholders, or sample configuration names. The executable slash-command scripts are real shell entry points, and the larger concern is their unpinned npx execution of claude-flow plus default writes to repository documentation files.

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

3,881

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

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

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

Подтверждённые проблемы безопасности (2)

Высокий

slash-command-doc-api.sh:100-103 slash-command-doc-inline.sh:98-102 slash-command-doc-readme.sh:87-91

Unpinned Third-Party Package Execution

The slash-command scripts invoke npx claude-flow@alpha for hooks and memory storage. Running an alpha npm package during documentation generation can download and execute third-party code.

The scripts directly call npx with an external package name in executable paths. This is a clear supply-chain execution risk even though it appears intended for workflow coordination.

Средний

slash-command-doc-readme.sh:93-99 slash-command-doc-readme.sh:167-178 slash-command-doc-api.sh:94-96 slash-command-doc-api.sh:231-233

Documentation Scripts Modify Repository Files by Default

The README and API scripts create or overwrite documentation files in the current project. This can change repository contents without a dry-run default or confirmation prompt.

The cited script paths create directories, copy generated specs, back up README.md, and write README content. These are intended actions but still affect repository state by default.

Пункты проверки возможностей (3)

Это реальные локальные возможности, которые могут ожидаться для этого навыка, поэтому они требуют проверки, но не считаются подтверждённым вредоносным поведением.

Средний

slash-command-doc-api.sh:1

Unix shell invocation

#!/bin/bash

This is an executable Bash entry point that scans project files and writes documentation outputs. Shell automation is expected, but it is still real command-execution behavior for a marketplace skill.

Средний

slash-command-doc-inline.sh:1

Unix shell invocation

#!/bin/bash

Средний

slash-command-doc-readme.sh:1

Unix shell invocation

#!/bin/bash

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

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

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

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

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

PROCESS.md:734 SKILL.md:491 SKILL.md:408 SKILL.md:409 slash-command-doc-readme.sh:465

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

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

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

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

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

https://skillstore.io/skills/dnyoussef-when-documenting-code-use-doc-generator/audits/9?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

Значок Markdown

[![Skillstore security assessment](https://skillstore.io/badges/skills/dnyoussef-when-documenting-code-use-doc-generator/security.svg)](https://skillstore.io/skills/dnyoussef-when-documenting-code-use-doc-generator?utm_source=security_passport_badge)

Значок HTML

<a href="https://skillstore.io/skills/dnyoussef-when-documenting-code-use-doc-generator?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/dnyoussef-when-documenting-code-use-doc-generator/security.svg" alt="Skillstore security assessment" loading="lazy"></a>

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

<iframe src="https://skillstore.io/embed/skills/dnyoussef-when-documenting-code-use-doc-generator.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

DNYoussef. (2026). when-documenting-code-use-doc-generator security audit report (audit version 9) [Author version 1.0.0]. Skillstore. https://skillstore.io/skills/dnyoussef-when-documenting-code-use-doc-generator/audits/9

Цитата BibTeX

@techreport{dnyoussef-dnyoussef-when-documenting-code-use-doc-generator-2026,
  author = {DNYoussef},
  title = {when-documenting-code-use-doc-generator security audit report (audit version 9)},
  institution = {Skillstore},
  year = {2026},
  number = {9},
  url = {https://skillstore.io/skills/dnyoussef-when-documenting-code-use-doc-generator/audits/9},
  note = {Author version 1.0.0}
}

CITATION.cff

cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "when-documenting-code-use-doc-generator security audit report (audit version 9)"
version: "1.0.0"
type: report
authors:
  - name: "DNYoussef"
date-released: "2026-07-05"
url: "https://skillstore.io/skills/dnyoussef-when-documenting-code-use-doc-generator/audits/9"
identifiers:
  - type: other
    value: "skillstore:dnyoussef-when-documenting-code-use-doc-generator:audit:9"
    description: "Skillstore immutable audit report identifier"

Оценка Skillstore

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

Архитектура

100

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

Контент

Сообщество

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

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

Задокументировать Backend API

Создать справочники в стиле OpenAPI, сводки эндпоинтов, заметки об аутентификации и примеры использования для репозитория сервиса.

Обновить документацию для онбординга в проекте

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

Улучшить покрытие кода комментариями

Выявить недокументированные функции и создать рекомендации по встроенным комментариям для поддерживаемых языковых стилей.

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

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

Используй этот навык, чтобы просмотреть текущий репозиторий и создать базовую документацию README и API. Сделай вывод кратким и перечисли измененные файлы.

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

Используй этот навык, чтобы задокументировать REST API в этом проекте. Включи эндпоинты, форматы запросов, сводки ответов, заметки об аутентификации и предупреждения о валидации.

Добавить встроенные комментарии

Используй этот навык, чтобы найти недокументированные публичные функции в src. Добавь или предложи JSDoc, TSDoc или Python docstrings и избегай изменений бизнес-логики.

Собрать полный набор документации

Используй этот навык, чтобы создать README, справочник API, архитектурные заметки, рекомендации по встроенным комментариям и отчет о пробелах в документации. По возможности запускай в режиме dry-run и помечай рискованные записи перед редактированием.

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

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

Избегать

Не запускайте скрипты генерации для репозиториев с незакоммиченными критическими изменениями.
Не публикуйте сгенерированные сведения API до проверки аутентификации и раскрытия данных.
Не предполагайте, что примеры готовы к production без валидации.

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

Редактирует ли этот навык файлы проекта?

Да. Включенные скрипты могут создавать README и выходные файлы docs, поэтому проверяйте изменения перед коммитом.

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

Да. Навык включает рабочие процессы документации API, которые создают справочники в стиле OpenAPI и сводки эндпоинтов.

Какие языки описывает навык?

Документация описывает стили документирования JavaScript, TypeScript, Python, Java, C#, Go и Rust.

Валидирует ли он каждый сгенерированный документ?

Нет. Он предоставляет рекомендации по валидации, но сгенерированный контент все равно требует проверки человеком и проверок, специфичных для инструментов.

Требуется ли ему доступ к сети?

Некоторые скрипты вызывают внешний инструментарий claude-flow через npx, что может требовать доступа к сети, если пакет не установлен.

Подходит ли он для приватных репозиториев?

Используйте с осторожностью. Навык сканирует файлы проекта и может создать документацию, раскрывающую внутренние API или имена конфигураций.