documentation-writer
Создание понятной проектной документации
Проектная документация часто становится неполной, несогласованной или сложной в поддержке. Этот навык помогает Claude, Codex и Claude Code составлять структурированные руководства, READMEs и справочные материалы на основе файлов проекта.
Остановитесь и запросите подтверждение перед установкой.
Проверьте план и получите явное согласие пользователя перед изменением файлов.
Установить с помощью моего Агента
Скопируйте этот запрос в своего Агента. Он содержит каноническую страницу Skill и манифест.
Review the Skillstore skill "documentation-writer" from https://skillstore.io/skills/c0ntr0lledcha0s-documentation-writer.md and its manifest at https://skillstore.io/api/skills/c0ntr0lledcha0s-documentation-writer/manifest. Verify the artifact. Stop and obtain explicit user consent before installing or changing files.Ваш Агент по-прежнему должен показать план и запросить все подтверждения, требуемые политикой безопасности.
Ресурсы для AI-агентов
Используйте эти ссылки, когда AI-агенту, crawler или script нужен чистый контекст вместо полной страницы.
Протестировать
Использование «documentation-writer». Задокументируй модуль person.
Ожидаемый результат:
- README модуля с кратким обзором и областью применения.
- Разделы классов и свойств на основе исходных файлов модуля.
- Практические примеры использования и ссылки на Schema.org.
Использование «documentation-writer». Обнови руководство по установке с новыми шагами настройки.
Ожидаемый результат:
- Обновленное руководство с предварительными требованиями, упорядоченными шагами, примерами и устранением неполадок.
- Существующие заголовки и стиль сохранены там, где это возможно.
- Контрольный список команд, ссылок и терминов, которые нужно проверить.
Использование «documentation-writer». Создай документацию для проектной команды.
Ожидаемый результат:
- Справочник команды с назначением, синтаксисом, параметрами, выходными данными и кодами завершения.
- Примеры для распространенного использования и примечания для связанных команд.
Аудит безопасности
Высокий рискAll 50 static findings are false positives caused by Markdown syntax, prose tokens, a documentation URL, and a relative link. A separate high-severity finding remains because the skill directs agents to run all commands without approval, sandboxing, or source-trust checks.
Подтверждённые проблемы безопасности (1)
Факторы риска
⚙️ Внешние команды (41)
🌐 Доступ к сети (2)
📁 Доступ к файловой системе (1)
Поделиться и цитировать этот отчет
Делитесь версионным отчетом об оценке, нейтральным значком, встраиваемой карточкой и цитатами. Skillstore публикует доказательства, не решая, безопасен ли этот Skill.
Копировать ссылку на отчёт
https://skillstore.io/skills/c0ntr0lledcha0s-documentation-writer/audits/9?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportЗначок Markdown
[](https://skillstore.io/skills/c0ntr0lledcha0s-documentation-writer?utm_source=security_passport_badge)Значок HTML
<a href="https://skillstore.io/skills/c0ntr0lledcha0s-documentation-writer?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/c0ntr0lledcha0s-documentation-writer/security.svg" alt="Skillstore security assessment" loading="lazy"></a>Встраиваемая карточка
<iframe src="https://skillstore.io/embed/skills/c0ntr0lledcha0s-documentation-writer.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
C0ntr0lledCha0s. (2026). documentation-writer security audit report (audit version 9) [Author version unspecified]. Skillstore. https://skillstore.io/skills/c0ntr0lledcha0s-documentation-writer/audits/9Цитата BibTeX
@techreport{c0ntr0lledcha0s-c0ntr0lledcha0s-documentation-writer-2026,
author = {C0ntr0lledCha0s},
title = {documentation-writer security audit report (audit version 9)},
institution = {Skillstore},
year = {2026},
number = {9},
url = {https://skillstore.io/skills/c0ntr0lledcha0s-documentation-writer/audits/9},
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-writer security audit report (audit version 9)"
version: "unspecified"
type: report
authors:
- name: "C0ntr0lledCha0s"
date-released: "2026-07-23"
url: "https://skillstore.io/skills/c0ntr0lledcha0s-documentation-writer/audits/9"
identifiers:
- type: other
value: "skillstore:c0ntr0lledcha0s-documentation-writer:audit:9"
description: "Skillstore immutable audit report identifier"
Сравнить варианты
2 устанавливаемых вариантовНавык каждого автора остаётся отдельным устанавливаемым вариантом. Рекомендуемый вариант ранжируется по данным Skillstore.
Почему этот вариант первый
github-documentation-writer
2026-09-09
c0ntr0lledcha0s-documentation-writer
2026-09-09
Оценка Skillstore
Почему такая оценка Достоверность доказательств: СреднийЧто вы можете построить
Документирование нового модуля
Создать README модуля на основе исходных файлов с краткими описаниями классов, деталями свойств, примерами и связанными ссылками.
Обновление руководства пользователя
Переработать руководство по установке или рабочему процессу, сохранив структуру, терминологию, примеры и разделы устранения неполадок.
Создание справочника API
Преобразовать сведения о скрипте или команде в справочник с синтаксисом, параметрами, поведением вывода и примечаниями о кодах завершения.
Попробуйте эти промпты
Напиши README для модуля person. Используй существующие исходные файлы и включи обзор, классы, свойства, примеры и связанные модули.
Обнови руководство по установке с учетом последних шагов. Сохрани текущую структуру и добавь устранение неполадок для распространенных ошибок настройки.
Создай технический справочник для build script. Объясни назначение, зависимости, параметры, выходные данные, примеры и коды завершения.
Проверь эти файлы документации на точность, отсутствующие предварительные требования, устаревшие ссылки, неясные примеры и несогласованную терминологию. Верни приоритетный список исправлений.
Лучшие практики
- Предоставляйте релевантные исходные файлы и текущую документацию перед запросом черновика.
- Проверяйте сгенерированные примеры и команды перед публикацией.
- Запрашивайте финальный контрольный список, охватывающий точность, ссылки, форматирование и отсутствующие разделы.
Избегать
- Не публикуйте сгенерированную документацию без проверки точности по исходным файлам.
- Не просите навык придумывать отсутствующие API, файлы или поведение команд.
- Не запускайте сгенерированные или обнаруженные shell-команды без одобрения и контекста.
Часто задаваемые вопросы
Какую документацию может создать этот навык?
Этот навык предназначен только для Logseq Template Graph?
Он читает исходные файлы?
Может ли он обновлять существующую документацию?
Он выполняет команды автоматически?
Что пользователи должны проверить перед публикацией?
Сведения для разработчиков
Автор
C0ntr0lledCha0sЛицензия
MIT
Ревизия Skillstore
r2
Примечание о версии
Автор не указал версию.
Репозиторий
https://github.com/C0ntr0lledCha0s/logseq-template-graph/tree/main/.claude/skills/documentation-writerСсылка
a39a91716eadede5f4cdefd78178fed4e837a128
Актуальность поддержки
26.07.2026
Использование
9 загрузок · 166 просмотров
Структура файлов
📄 SKILL.md