Навыки documentation-templates

📦

documentation-templates

Name: documentation-templates
Author: sickn33

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

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

Команды теряют время, когда проектной документации не хватает структуры. Этот skill предоставляет готовые шаблоны для README, документации API, changelog, ADR и документации, удобной для ИИ.

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

🥉 78 Бронза

Maintain this Skill? Claim it 🥉 78 Бронза

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

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

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

Review the Skillstore skill "documentation-templates" from https://skillstore.io/skills/sickn33-documentation-templates.md and its manifest at https://skillstore.io/api/skills/sickn33-documentation-templates/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-templates.md Подписанный manifest GET /api/skills/sickn33-documentation-templates/manifest Подписанный lockfile GET /api/skills/sickn33-documentation-templates/lockfile

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

Использование «documentation-templates». Мейнтейнер просит рекомендации по README для новой библиотеки.

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

План README с названием, назначением, quick start, функциями, конфигурацией, ссылками на документацию и лицензией.
Краткие placeholders для каждого раздела, чтобы мейнтейнер мог заполнить детали проекта.

Использование «documentation-templates». Команде нужно зафиксировать решение по хранилищу.

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

Черновик ADR со статусом, контекстом, решением, последствиями и компромиссами простым языком.

Использование «documentation-templates». Продуктовой команде нужна документация endpoint.

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

План документа endpoint с путем, назначением, таблицей параметров, случаями ответов и примечаниями к примеру запроса.

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

Безопасно

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

All 15 static findings are false positives caused by fenced documentation examples and ordinary template wording. The skill contains no executable commands, system reconnaissance, prompt injection, or other semantic security concerns.

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

205

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

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

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

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

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

SKILL.md:31-59 SKILL.md:59-67 SKILL.md:67-83 SKILL.md:83-91 SKILL.md:91-102 SKILL.md:102-117 SKILL.md:117-131 SKILL.md:131-137 SKILL.md:137-151 SKILL.md:151-161 SKILL.md:161-173

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

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

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

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

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

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

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

Значок Markdown

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

Значок HTML

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

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

<iframe src="https://skillstore.io/embed/skills/sickn33-documentation-templates.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-templates security audit report (audit version 5) [Author version unspecified]. Skillstore. https://skillstore.io/skills/sickn33-documentation-templates/audits/5

Цитата BibTeX

@techreport{sickn33-sickn33-documentation-templates-2026,
  author = {sickn33},
  title = {documentation-templates security audit report (audit version 5)},
  institution = {Skillstore},
  year = {2026},
  number = {5},
  url = {https://skillstore.io/skills/sickn33-documentation-templates/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-templates 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-templates/audits/5"
identifiers:
  - type: other
    value: "skillstore:sickn33-documentation-templates:audit:5"
    description: "Skillstore immutable audit report identifier"

Оценка Skillstore

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

Архитектура

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

Контент

Сообщество

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

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

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

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

Подготовка справочников API

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

Улучшение open source проектов

Добавьте предсказуемые разделы README, changelog, ADR и документации для ИИ для участников проекта.

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

Создать README

Используй skill documentation-templates, чтобы подготовить черновик README для этого проекта: [project summary]. Включи quick start, функции, конфигурацию, документацию и лицензию.

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

Используй шаблон документации API для этого endpoint: [method and path]. Включи назначение, параметры, ответы и описание примера.

Написать ADR

Используй шаблон ADR, чтобы задокументировать это решение: [decision]. Включи статус, контекст, решение и последствия.

Создать документацию, удобную для ИИ

Создай план документации для [project]. Включи структуру README, рекомендации по комментариям к коду, разделы changelog, ADR, llms.txt и разделы RAG-ready.

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

Начинайте с самого маленького полезного документа, затем добавляйте детали по мере того, как читатели задают повторяющиеся вопросы.
Перед публикацией замените placeholders на названия, команды, endpoints и ограничения, специфичные для проекта.
Синхронизируйте changelog, ADR и файлы для ИИ с крупными изменениями продукта.

Избегать

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

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

Генерирует ли этот skill полную документацию автоматически?

Он предоставляет структуру и стартовые формулировки. Вам все равно нужны детали, примеры и проверка, специфичные для проекта.

Может ли он писать справочные страницы API?

Да. Он дает структуру для каждого endpoint: назначение, параметры, ответы и примеры.

Поддерживает ли он документацию, удобную для ИИ?

Да. Он включает рекомендации по llms.txt и принципы структуры RAG-ready.

Он ограничен только программными проектами?

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

Выполняет ли он команды или проверяет мой репозиторий?

Нет. Содержимое skill является только руководством. Любую проверку репозитория нужно запрашивать отдельно.

Могу ли я использовать его с Claude Code и Codex?

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

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

Автор

sickn33

Лицензия

MIT

Ревизия Skillstore

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

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

Репозиторий

https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/documentation-templates

Ссылка

f9e2c34b4f19c7f3e6b0a1e93227b5f77cc12526

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

26.07.2026

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

9 загрузок · 90 просмотров

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

📄 SKILL.md