Навыки tech-doc
📦

tech-doc

Ревизия содержимого r1 Безопасно ⚙️ Внешние команды

Пишите понятную техническую документацию

Технические команды теряют время, когда документация смешивает предположения, неясный объем работ и инструкции, которые сложно быстро просмотреть. Этот навык помогает Claude, Codex и Claude Code создавать структурированные, сопровождаемые ссылками и удобные для сопровождения технические документы.

Поддерживает: Claude Codex Code(CC)
🥉 78 Бронза

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

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

Запрос агента
Review the Skillstore skill "tech-doc" from https://skillstore.io/skills/dcjanus-tech-doc.md and its manifest at https://skillstore.io/api/skills/dcjanus-tech-doc/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.

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

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

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

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

Использование «tech-doc». Черновые заметки описывают новую функцию кэширования и несколько пограничных случаев.

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

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

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

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

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

Использование «tech-doc». Руководство Markdown содержит длинные разделы, непоследовательные термины и слабые ссылки на источники.

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

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

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

Безопасно

The static command finding is a false positive because SKILL.md line 23 describes how to format shell examples in documentation. The entropy alert is also a false positive; the file is coherent Markdown text with Chinese content, not obfuscated or encrypted data. No prompt injection or malicious semantic intent was found.

1
Просканировано файлов
39
Проанализировано строк
0
Пункты проверки
0
Ложные срабатывания проигнорированы

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

⚙️ Внешние команды (1)
Последний завершенный статический и семантический аудит не обнаружил подтвержденных проблем безопасности. Это не доказывает отсутствие побочных эффектов у навыка.
Поделиться и цитировать этот отчет

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

Открыть версионный отчет
Оценка безопасности

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

https://skillstore.io/skills/dcjanus-tech-doc/audits/8?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

Значок Markdown

[![Skillstore security assessment](https://skillstore.io/badges/skills/dcjanus-tech-doc/security.svg)](https://skillstore.io/skills/dcjanus-tech-doc?utm_source=security_passport_badge)

Значок HTML

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

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

<iframe src="https://skillstore.io/embed/skills/dcjanus-tech-doc.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

DCjanus. (2026). tech-doc security audit report (audit version 8) [Author version unspecified]. Skillstore. https://skillstore.io/skills/dcjanus-tech-doc/audits/8

Цитата BibTeX

@techreport{dcjanus-dcjanus-tech-doc-2026, author = {DCjanus}, title = {tech-doc security audit report (audit version 8)}, institution = {Skillstore}, year = {2026}, number = {8}, url = {https://skillstore.io/skills/dcjanus-tech-doc/audits/8}, 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: "tech-doc security audit report (audit version 8)" version: "unspecified" type: report authors: - name: "DCjanus" date-released: "2026-07-06" url: "https://skillstore.io/skills/dcjanus-tech-doc/audits/8" identifiers: - type: other value: "skillstore:dcjanus-tech-doc:audit:8" description: "Skillstore immutable audit report identifier"

Оценка Skillstore

Почему такая оценка Достоверность доказательств: Высокий
55
Архитектура
85
Сопровождаемость
87
Контент
70
Сообщество
83
Соответствие спецификации

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

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

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

Написание операционных SOP

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

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

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

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

Черновик базового документа
Используй навык tech-doc, чтобы составить короткий пояснительный документ на основе этих заметок. Сначала укажи цель, читателя, область охвата и результат.
Переписать для ясности
Используй навык tech-doc, чтобы переписать этот документ. Оставь факты без изменений, сократи предположения, уточни заголовки и отметь любую недостающую информацию.
Создать SOP
Используй навык tech-doc, чтобы создать SOP. Включи область применения, предварительные требования, заметки о рисках, самый короткий безопасный пример, распространенные ошибки и ссылки.
Аудит качества документации
Используй навык tech-doc, чтобы проверить этот технический документ. Определи неподтвержденные утверждения, неясные термины, недостающие ссылки, рискованные примеры и пробелы в сопровождении.

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

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

Избегать

  • Не просите навык выдумывать недостающие факты, метрики или неподтвержденные выводы.
  • Не публикуйте примеры команд без проверки разрешений, placeholder и вариантов dry-run.
  • Не смешивайте учебные материалы, справочники и SOP без четкой цели для читателя.

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

Какие типы документов поддерживает этот навык?
Он поддерживает пояснения, SOP, краткие справочники, руководства Markdown и стандарты командной документации.
Может ли он проверить, корректны ли технические факты?
Он может сохранять и организовывать предоставленные факты, но для проверки утверждений ему нужны надежные источники.
Выполняет ли он shell-команды из документа?
Нет. Он только дает рекомендации по написанию безопасных и понятных примеров команд.
Может ли он помочь с API-документацией?
Да. Он может структурировать пояснения API, определять область охвата, стандартизировать термины и отмечать недостающие ссылки.
Подходит ли навык для многоязычных команд?
Да, но исходные рекомендации на китайском языке, поэтому следует указать язык вывода и терминологию.
Как подготовить входные данные для лучших результатов?
Предоставьте исходные заметки, аудиторию, цель, ограничения, существующую терминологию и любые обязательные ссылки.

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

Автор

DCjanus

Лицензия

MIT

Ревизия Skillstore

r1

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

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

Ссылка

72d5025b022c77f7a51bdf5c1637c689c80e89d1

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

18.07.2026

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

20 загрузок · 207 просмотров

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

📄 SKILL.md

Больше от DCjanus

Показать все
📦

ui-ux-pro-max

75

Проектируйте более качественные фронтенд-интерфейсы

Работа над UI и фронтендом часто требует быстрых решений о стиле, цвете, типографике, компоновке и паттернах фреймворков. Этот навык ищет данные в курируемых локальных дизайн-материалах и превращает их в практические рекомендации по реализации UI/UX.

Дизайн и креатив Просмотр
📦

github-pr-issue

66

Управление GitHub PR и Issues

Работа с ревью GitHub и релизами может требовать нескольких команд и повторного сбора контекста. Этот навык собирает контекст PR и помогает вносить изменения в issue или PR с помощью структурированных рабочих процессов.

Кодинг и разработка Просмотр
📦

pwdebug

38

Отладка страниц браузера из командной строки

Отладка frontend часто требует реального сеанса браузера, который сохраняется между командами. Этот skill предоставляет управление браузером на основе Playwright для навигации, инспекции, снимков экрана и логов.

Кодинг и разработка Просмотр
Показать все
📦

markdown-pro

79

Создание профессиональной документации в Markdown

от AutumnsGrove

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

Документация Просмотр
📦

docs-write

79

Писать документацию Metabase

от metabase

Продуктовая документация часто становится слишком формальной, расплывчатой или трудной для быстрого просмотра. Этот навык помогает Claude, Codex и Claude Code писать документацию в стиле Metabase: ясную, прямую и ориентированную на читателя.

Документация Просмотр
📦

doc-coauthoring

79

Совместное создание документации с ИИ

от ZhanlinCui

Создание качественной документации — непростая задача. Этот навык предоставляет структурированный трёхэтапный рабочий процесс, который помогает пользователям собирать контекст, уточнять контент через итерации и тестировать документы с новым экземпляром ИИ для обеспечения ясности для читателей.

Документация Просмотр
📦

crafting-effective-readmes

79

Создание README с учетом аудитории

от softaworks

Универсальные README часто не учитывают потребности контрибьюторов, коллег по команде или будущих сопровождающих. Этот навык помогает Claude, Codex и Claude Code с вопросами об аудитории, шаблонами и проверками качества.

Документация Просмотр