Создание документации ПО по Diataxis
Командам часто нужна документация, которая соответствует намерениям пользователей в учебных материалах, практических руководствах, справочных страницах и объяснениях. Этот навык помогает Claude, Codex и Claude Code уточнять область задачи, предлагать структуру и создавать черновики структурированного Markdown.
Этот навык входит в набор
Установите весь набор одной командой, чтобы получить все навыки для задачи.
Скопируйте этот запрос в своего Агента. Он содержит каноническую страницу Skill и манифест.
Review the Skillstore skill "documentation-writer" from https://skillstore.io/skills/github-documentation-writer.md and its manifest at https://skillstore.io/api/skills/github-documentation-writer/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.Ваш Агент по-прежнему должен показать план и запросить все подтверждения, требуемые политикой безопасности.
Используйте эти ссылки, когда AI-агенту, crawler или script нужен чистый контекст вместо полной страницы.
Использование «documentation-writer». Запрос на написание онбординговой документации для новой функции для разработчиков.
Ожидаемый результат:
Уточняющие вопросы об аудитории и цели, затем структура учебного материала, сфокусированная на первом успешном результате.
Использование «documentation-writer». Утвержденная структура для задачи развертывания.
Ожидаемый результат:
Практическое руководство в Markdown с предварительными требованиями, упорядоченными шагами, ожидаемыми результатами и краткими заметками по устранению неполадок.
Использование «documentation-writer». Существующие Markdown-файлы, определяющие тон и терминологию продукта.
Ожидаемый результат:
Переработанный черновик документации, который следует тому же стилю, именованию и структуре без копирования исходного текста.
The skill contains prompt guidance for technical writing and no executable network operation. The Diátaxis website URL is a framework citation, not a request target or data transfer mechanism.
Делитесь версионным отчетом об оценке, нейтральным значком, встраиваемой карточкой и цитатами. Skillstore публикует доказательства, не решая, безопасен ли этот Skill.
https://skillstore.io/skills/github-documentation-writer/audits/5?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report[](https://skillstore.io/skills/github-documentation-writer?utm_source=security_passport_badge)<a href="https://skillstore.io/skills/github-documentation-writer?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/github-documentation-writer/security.svg" alt="Skillstore security assessment" loading="lazy"></a><iframe src="https://skillstore.io/embed/skills/github-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>github. (2026). documentation-writer security audit report (audit version 5) [Author version unspecified]. Skillstore. https://skillstore.io/skills/github-documentation-writer/audits/5@techreport{github-github-documentation-writer-2026,
author = {github},
title = {documentation-writer security audit report (audit version 5)},
institution = {Skillstore},
year = {2026},
number = {5},
url = {https://skillstore.io/skills/github-documentation-writer/audits/5},
note = {Author version unspecified}
}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 5)"
version: "unspecified"
type: report
authors:
- name: "github"
date-released: "2026-07-23"
url: "https://skillstore.io/skills/github-documentation-writer/audits/5"
identifiers:
- type: other
value: "skillstore:github-documentation-writer:audit:5"
description: "Skillstore immutable audit report identifier"
Навык каждого автора остаётся отдельным устанавливаемым вариантом. Рекомендуемый вариант ранжируется по данным Skillstore.
Почему этот вариант первый
github-documentation-writer
2026-09-09
c0ntr0lledcha0s-documentation-writer
2026-09-09
Создайте ориентированную на обучение структуру и черновик для пользователей, которым нужен управляемый первый успешный результат.
Преобразуйте конкретную задачу в понятную последовательность шагов с областью применения и предварительными требованиями.
Организуйте технические факты в краткий справочный материал для повторного поиска и поддержки.
Мне нужна документация для [product or feature]. Помоги выбрать, должен ли это быть учебный материал, практическое руководство, справочная страница или объяснение. Сначала задай любые уточняющие вопросы.
Создай структуру на основе Diataxis для [document type] о [topic]. Целевая аудитория — [audience], цель — [goal], а область задачи — [scope].
Используй утвержденную структуру, чтобы написать полный Markdown-документ. Сохраняй язык простым, точным и согласованным с предоставленными сведениями о продукте.
Проверь эти черновики документации на соответствие Diataxis. Выяви смешанные цели, недостающий контекст аудитории, проблемы с областью задачи и несогласованность терминологии перед предложением правок.
Автор
githubЛицензия
MIT
Ревизия Skillstore
r2
Примечание о версии
Автор не указал версию.
Ссылка
c43861a65bb95efcae259cd161c9d6f4dc7eec6f
Актуальность поддержки
26.07.2026
Использование
20 загрузок · 124 просмотров
Структура файлов
📄 SKILL.md
Создание документов требований к продукту
Команды часто начинают разработку функций с расплывчатых целей и неполных требований. Этот навык превращает продуктовые идеи в структурированные PRD с измеримыми критериями и техническим контекстом.
Создавайте более качественные приложения на Spring Boot
Проекты Spring Boot могут становиться несогласованными на разных уровнях: в слоях приложения, конфигурации, тестировании и безопасности. Этот навык дает краткие рекомендации по лучшим практикам для проектирования сопровождаемых Java-сервисов с использованием Spring Boot.
Безопасный рефакторинг кода
Крупные кодовые базы становится трудно изменять, когда структура, имена и зоны ответственности начинают расползаться. Этот навык помогает выполнять безопасные шаги рефакторинга, которые сохраняют поведение и одновременно улучшают сопровождаемость.
Создавайте понятные Conventional Git-коммиты
Неясные коммиты усложняют понимание ревью и истории релизов. Этот навык анализирует изменения в репозитории, добавляет выбранные файлы в индекс и создает сообщение Conventional Commit.
Создание редактируемых диаграмм Excalidraw по описанию на естественном языке
Сложные процессы и системы трудно объяснить одним лишь текстом. Этот навык преобразует понятные описания в редактируемые диаграммы Excalidraw и сопроводительные сводки.
Управление GitHub из командной строки
Командам GitHub нужны быстрые подсказки по командам для репозиториев, issues, pull requests, Actions и релизов. Этот навык предоставляет сфокусированные примеры gh CLI и рабочие процессы для Claude, Codex и Claude Code.
Создание профессиональной документации в Markdown
от AutumnsGrove
Командам нужна понятная проектная документация, которая остается согласованной в README-файлах, журналах изменений и руководствах по участию. Markdown Pro предоставляет шаблоны, структуру и вспомогательные рабочие процессы для качественной технической документации.
Писать документацию Metabase
от metabase
Продуктовая документация часто становится слишком формальной, расплывчатой или трудной для быстрого просмотра. Этот навык помогает Claude, Codex и Claude Code писать документацию в стиле Metabase: ясную, прямую и ориентированную на читателя.
Форматирование статей в Markdown
от jimliu
Черновикам часто не хватает единообразной структуры, frontmatter и удобочитаемой типографики. Этот skill превращает обычный текст или черновой Markdown в организованный Markdown, готовый к проверке.
Совместное создание документации с ИИ
от ZhanlinCui
Создание качественной документации — непростая задача. Этот навык предоставляет структурированный трёхэтапный рабочий процесс, который помогает пользователям собирать контекст, уточнять контент через итерации и тестировать документы с новым экземпляром ИИ для обеспечения ясности для читателей.
Создание README с учетом аудитории
от softaworks
Универсальные README часто не учитывают потребности контрибьюторов, коллег по команде или будущих сопровождающих. Этот навык помогает Claude, Codex и Claude Code с вопросами об аудитории, шаблонами и проверками качества.
Создание поддерживаемой документации к коду
от sickn33
Ручная документация часто отстает от активно развивающегося кода. Этот навык помогает Claude, Codex и Claude Code создавать понятную документацию и планы автоматизации.