writing-docs
/writing-docs
Use when writing, editing, or auditing user-facing technical articles and documentation: README, HOWTO, research summaries, reports, and knowledge-base notes. Also use for contradictions, unsupported claims, repetition, or artificial dramatization in technical prose. Not for SKILL.md files or code comments.
- Author
- spgsroot ↗
- Repository
- omp-agent-skills ↗
- Licence
- MIT
- Last repository change
- 07.11.2026
Assessment and security
- Files in this package
- 1
- Scripts
- 0
- HTML comments
- 0
- URLs in SKILL.md
- 0
No signals detected. Repository changed on 07.11.2026, without references to retired models or APIs.
MIT, open: use and modify while retaining author attribution.
What it does and when to use it
Use when writing, editing, or auditing user-facing technical articles and documentation: README, HOWTO, research summaries, reports, and knowledge-base notes. Also use for contradictions, unsupported claims, repetition, or artificial dramatization in technical prose. Not for SKILL.md files or code comments.
Original author description
Use when writing, editing, or auditing user-facing technical articles and documentation: README, HOWTO, research summaries, reports, and knowledge-base notes. Also use for contradictions, unsupported claims, repetition, or artificial dramatization in technical prose. Not for SKILL.md files or code comments.
How it works
- Выбери режим и границы
- 1. Установи основания утверждений
- 2. Построй содержание
- 3. Напиши и сократи
- 4. Проверь драматизацию по смыслу
- 5. Сделай отдельный логический проход
- Стоп-факторы
- Калибровка
SKILL.md preview
--- name: writing-docs description: "Use when writing, editing, or auditing user-facing technical articles and documentation: README, HOWTO, research summaries, reports, and knowledge-base notes. Also use for contradictions, unsupported claims, repetition, or artificial dramatization in technical prose. Not for SKILL.md files or code comments." --- # Технический писатель и редактор Приоритеты: **фактическая корректность → непротиворечивость → ясность → информационная плотность → стиль**. Читателю нужны устройство системы, условия применимости и доказательства, а не имитация журналистской драматургии. ## Выбери режим и границы | Задача | Работа и результат | |---|---| | Написать материал | Готовый текст для указанной аудитории: предмет, механизм, применимость, ограничения. Структура определяется содержанием. | | Отредактировать текст | Исправленная версия в запрошенных границах; сохранить смысл, подтверждённые факты, ссылки, код и идентификаторы API. | | Провести аудит | Конкретные проблемы с цитатами, основаниями и предложенными правками. Полное переписывание — отдельный запрос. | Для правки фразы или раздела работай с этим фрагментом и связанными утверждениями; остальной материал сохраняй. Пиши на языке задания; по умолчанию — на русском. Технические термины сохраняй, лишние кальки заменяй понятными выражениями. **Форма выдачи:** публикуемый текст — отдельно; значимые изменения, основания правок и ограничения редакторской проверки — в кратком примечании после него. Если запрошен только текст или задан другой формат, соблюдай этот формат. Сведения о работе редактора не становятся содержанием публикации. Неподтверждённое существенное утверждение убери, ограничь или явно обозначь его статус в самом материале. Примечание после статьи не оправдывает категоричный неподтверждённый тезис внутри неё. ## 1. Установи основания утверждений Для нового материала составь внутренний реестр существенных утверждений; при редактировании проверь изменяемые тезисы и связанные с ними выводы: - **Тезис:** что именно утверждается. - **Основание:** документ, код, воспроизводимая проверка или предоставленный отчёт. - **Статус:** документированный факт / собственное наблюдение / вывод из источника / гипотеза. - **Область действия:** версия, режим, ОС, конфигурация, дата, единицы и исключения. - **Пробелы:** чего нет в источнике и какие свидетельства противоречат друг другу. Чужой результат атрибутируй: «согласно отчёту», а не «мы обнаружили». Предоставленная ссылка не означает, что её содержимое проверено. Команда в документации не означает, что она была выполнена. Не выдумывай источники, цитаты, эксперименты, значения по умолчанию или замеры. При расхождении источников укажи границы каждого утверждения. Если расхождение не разрешено, исключи категоричный вывод. Используй доступные основания; отсутствующие данные обозначай точно, а не заменяй осторожно звучащей догадкой. ## 2. Построй содержание Каждая секция отвечает на вопрос: «Что читатель узнает нового именно здесь?» Совпадающие ответы — повод объединить секции. Для статьи вступление в 2–4 предложения называет предмет, границы и содержательный результат. Дальше выбирай подходящий порядок: задача или механизм → наблюдаемое поведение → ограничения → последствия. Для короткой правки новый лид и разделы не нужны. Заголовки обозначают содержание. Таблица сравнивает объекты по одинаковым критериям; список перечисляет; схема показывает связи. Не добавляй формы ради симметрии и не пересказывай одну информацию во всех формах подряд. ## 3. Напиши и сократи Каждое предложение сообщает факт, объясняет причинность, определяет термин, оговаривает условие либо даёт проверяемое действие. Предпочитай точные существительные и глаголы: «сообщение добавляется в очередь» вместо «система организует механизм передачи». - Объясняй «почему» и «при каких условиях», когда без этого описание вводит в заблуждение. - Сохраняй имена API, команды, код, ссылки, единицы и технические различия. Фактическую ошибку исправляй по источнику, а не ради стиля. - Убирай дубли выводов, тавтологии и предложения, удаляемые без потери содержания. - Сокращай до удаления фрагментов без самостоятельной функции, а не на произвольный процент. Условия, оговорки и основания, необходимые для точности, сохраняй. - Не добавляй новые факты и примеры без оснований. ## 4. Проверь драматизацию по смыслу «Не просто X, а Y», «на самом деле», «вопреки ожиданиям» оправданы, когда исправляют конкретное заблуждение или различают технические понятия. Не придумывай наивного оппонента ради эффектного опровержения. «Революция», «прорыв», «магия», «уникальный», «критически важно», «под капотом» не заменяют объяснение. «Стоит отметить», «важно понимать», «как мы видим» убирай, если без них смысл тот же. Ментальные свойства модели не приписывай вместо наблюдаемого поведения. Это не механический запрет слов или противопоставлений. Различение «отправлено ≠ выполнено» полезно, если раскрывает семантику доставки. ## 5. Сделай отдельный логический проход Это повторное чтение собственного текста, а не обязательный запуск другого агента. 1. Сопоставь существенные утверждения с основаниями и областью действия. 2. Сверь вступление, основной текст, таблицы, диаграммы и выводы: нет ли несовместимых утверждений. 3. Раздели сущности и уровни: контекст и процесс ОС; отправка, прочтение и выполнение; документация и поведение конкретной сборки; чужое наблюдение и собственная проверка. 4. Проверь числа, единицы, значения по умолчанию, область лимитов, версии и исключения. 5. Проверь причинность: следует ли практический вывод из механизма и данных. 6. Вычитай язык: управление, падежи, терминологию, однокоренные и смысловые повторы. ## Стоп-факторы Не выдавай материал за проверенный, пока есть существенное противоречие, тезис сильнее доказательств, выдуманный источник или результат, необоснованное обобщение одной версии, смысловые дубли либо декоративная антитеза вместо предмета. Исправь доступные проблемы. Неразрешённый пробел обозначь конкретно; отдели подтверждённые части от неизвестного. Самооценки и фиктивные баллы готовности не заменяют проверку. ## Калибровка Условный источник: в спецификации очереди версии 3.4 статус `accepted` означает постановку задания в очередь, а `completed` публикуется после обработки; повторная доставка возможна. **Необоснованно:** «Это не просто очередь, а революция. Успешная отправка доказывает выполнение без дублей во всех версиях». **По источнику:** «В версии 3.4 статус `accepted` подтверждает постановку задания в очередь. Завершение обработки обозначается отдельно статусом `completed`; повторная доставка возможна».
Versions
| Repository | Score | Licence |
|---|---|---|
| This page · spgsroot/omp-agent-skills | 90 | MIT |
| smarzban/agent-skills | 100 | MIT |
| remotion-dev/remotion | 100 | MIT |
| nukeop/nuclear | 100 | AGPL-3.0 |
| foryourhealth111-pixel/Vibe-Skills | 100 | Apache-2.0 |
| it-bens/ai-tools | 100 | MIT |
| jamescai-md/motionframe-edit | 100 | MIT |
| MoizIbnYousaf/marketing-cli | 100 | MIT |
Database snapshot: 13.11.2026 · package version 9f44e89d32ad (SHA-256 digest of the entire package)
Downloads in the last 30 days: 0 · ranking
Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.
Similar skills
- 100flow-docs
Use when writing or auditing technical documentation, READMEs, user guides, architecture docs, agent instructions (AGENTS.md, SKILL.md, OKF chapters), pull requests, commit messages, or changelogs. - 100technical-writer
(forwward) Writes clear, jargon-free technical documents through a structured discovery and drafting workflow. Interviews the user to determine document type, audience, and purpose before writing. Triggers on writing documentation, user guides, SOPs, runbooks, API docs, README… - 100technical-documentation
Audit, write, and improve developer documentation using Google''s Developer Documentation Style Guide and Technical Writing courses. Use this skill for any documentation work, even when the user names no style guide: "audit our docs", "review this README", "write a README",… - 90technical-writer
Writes and revises clear, precise, accessible technical content for any medium. Use for manuals, wikis, README files, developer and user documentation, tutorials, references, specifications, RFCs, feature requests, issues, commit messages, code comments, review comments, pull… - 100technical-writing
Write or revise evidence-backed technical documentation for its intended audience. Use when creating, updating, restructuring, or editing a README, runbook, architecture guide, API guide, spec, or agent-facing instructions. - 100technical-writing
Writes and audits READMEs, guides, reference docs, changelogs; not site builders, profile READMEs. Use when writing or fixing a README, tutorial, how-to, reference page, ADR or CHANGELOG, checking docs against the code before a release, or turning a commit log into release…