技能 doc-writer
📝

doc-writer

安全 🌐 网络访问📁 文件系统访问⚙️ 外部命令

Генерация документации по задачам из шаблонов

也可从以下获取: 0xhiroki

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

支持: Claude Codex Code(CC)
⚠️ 68
1

下载技能 ZIP

2

在 Claude 中上传

前往 设置 → 功能 → 技能 → 上传技能

3

开启并开始使用

测试它

正在使用“doc-writer”。 Create a new task document for user authentication feature using DOC_TEMPLATE.md

预期结果:

  • • Документ создан по пути docs/planned/03-user-authentication.md
  • • Блок метаданных включает номер задачи, статус и дату
  • • Раздел целей описывает задачи аутентификации
  • • Список предварительных требований содержит зависимости и требования
  • • Этапы реализации ссылаются на существующие модули аутентификации
  • • Раздел валидации определяет критерии приемки

安全审计

安全
v3 • 1/16/2026

This is a pure documentation skill with no executable code. The static analyzer flagged 20 false positives due to pattern matching on file paths and URL strings in markdown and JSON. No network calls, file system operations, external commands, or cryptographic operations exist in these files. Only plain text documentation and metadata.

2
已扫描文件
206
分析行数
3
发现项
3
审计总数
审计者: claude 查看审计历史 →

质量评分

38
架构
100
可维护性
83
内容
23
社区
100
安全
83
规范符合性

你能构建什么

Поддержание единообразного отслеживания задач

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

Обеспечение стандартов документации

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

Документирование деталей реализации

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

试试这些提示

Создать новый документ по задаче
Создай новый документ по задаче для [task name] в docs/planned/ используя DOC_TEMPLATE.md. Пронумеруй его последовательно после существующих задач и включи контекст из PLAN.md.
Отметить задачу завершенной
Перемести задачу [task-name] из docs/planned/ в docs/completed/ и обнови документ, чтобы отразить то, что было реализовано.
Обновить устаревший документ
Проверь и обнови документ по задаче по пути [path], чтобы отразить текущее состояние репозитория, тесты и требования к инструментам.
Сгенерировать из контекста
Сгенерируй полный документ по задаче для [feature] используя DOC_TEMPLATE.md. Собери контекст из PLAN.md, AGENTS.md и соответствующих исходных файлов. Делай ссылки на существующий код вместо дублирования.

最佳实践

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

避免

  • Создание документов без проверки существующей последовательности нумерации
  • Дублирование больших блоков кода вместо ссылок на исходник
  • Пропуск блока метаданных или обязательных разделов шаблона
  • Невыполнение проверки структуры по DOC_TEMPLATE.md

常见问题

Какие шаблоны требуются для работы этого навыка?
DOC_TEMPLATE.md должен существовать в директории docs/ с ожидаемой структурой, включающей метаданные, разделы и форматирование.
Какой формат именования файлов используется?
Файлы должны использовать формат NN-task-name.md, где NN - уникальное двузначное число, а имя пишется строчными буквами с дефисами.
Могу ли я интегрировать это в мой CI/CD pipeline?
Этот навык работает внутри вашего AI-ассистента. Вы можете добавить шаги валидации в ваш pipeline, которые проверяют структуру docs/.
Этот навык изменяет существующие файлы?
Да, он может обновлять существующие документы по задачам при перемещении из запланированных в завершенные или при обновлении устаревшей документации.
Что происходит при конфликтах нумерации?
Навык пытается найти следующий доступный уникальный номер, но вам следует проверять согласованность нумерации вручную.
Чем это отличается от генератора документации?
Этот навык следует определенному шаблону и соглашению об именовании для отслеживания задач, а не генерирует общую документацию API.

开发者详情

文件结构

📄 SKILL.md