Menú
Используй по просьбе: «обнови документацию», «обнови документацию для <path>», «обнови MODULE_INDEX.md»
Instalar con Codex o Claude Copia este prompt, pégalo en Codex, Claude u otro asistente, y deja que revise la página de la skill y la instale por ti.
Basado en la clasificación ocupacional SOC
Используй, когда пользователь просит: «закрой этап», «создай отчёт этапа», «напиши отчёт», «синхронизируй report/changelog/handoff»
Use when working with the project wiki layer — new reports in docs/reports/ are not yet covered in wiki/index.md, a new concept needs to be saved, session needs wiki context, or pages may be stale
Use when fixing bugs or writing code in processing/, API/, statistics/, ML-infrastructure — write a failing test before fixing
Use when you have a written implementation plan to execute in a separate session with review checkpoints
Use when completing tasks, implementing major features, or before merging to verify work meets requirements
Use when executing implementation plans with independent tasks in the current session
| name | update-docs |
| description | Используй по просьбе: «обнови документацию», «обнови документацию для <path>», «обнови MODULE_INDEX.md» |
Синхронизация описания модулей с кодом: file headers, docs/<category>/<module>.md, MODULE_INDEX.md.
| Каталог кода | docs/ |
|---|---|
processing/ | docs/processing/ |
statistics/ | docs/statistics/ |
API/ | docs/API/ (ML-сигнальные интеграции — также docs/MT/) |
ML/ | docs/ML/ |
MT/MQL4/ | docs/MT/ |
tests/ | docs/tests/ |
Примечание: изменение полей фрактала в lib_PIC.mqh → также docs/schemas/ (контракт MT4↔Python).
Единый канон — русский. Базовые поля обязательны, расширенные — опциональны для инфраструктуры с нетривиальными зависимостями (processing/, ML/data_loader.py, ML/train.py):
# =============================================================================
# Файл: [filename.py]
# Назначение: [одна строка]
# Язык: Python 3.10+ # опционально
# Автор: [имя] # опционально
# Создан: [YYYY-MM-DD] # опционально
# Обновлён: [YYYY-MM-DD]
# Зависимости: # опционально, для нетривиальных связей
# Входные данные:
# - [путь/файл] (откуда: [источник])
# Выходные данные:
# - [путь/файл] (куда: [назначение])
# Внутренние зависимости:
# - [module.py] (функция ...)
# Внешние зависимости:
# - [пакет]>=версия
# Использование:
# python [filename.py] [аргументы]
# Примечания: # опционально
# - [важные ограничения]
# =============================================================================
Английский compact-header (File:/Purpose:) не переделывать без необходимости.
Обновлять header при изменении: назначения, входов/выходов, CLI. Не обновлять при рефакторинге внутренней логики.
Box-стиль (большинство .mqh):
//+------------------------------------------------------------------+
//| Файл: [filename.mqh] |
//| Назначение: [одна строка] |
//| Обновлён: [YYYY-MM-DD] |
//| Зависимости: [файл.mqh] |
//+------------------------------------------------------------------+
Doxygen //!-стиль также встречается (например lib_PIC.mqh) — не переделывать.
Кодировка .mqh/.mq4 в репо — UTF-8 (с кириллицей); Проверяй file перед правкой.
Писать: публичные функции с нетривиальной логикой, все классы, публичные методы. Не писать: приватные хелперы (_foo), функции с говорящим именем и ≤3 строками тела. Описание shape массивов обязательно: shape (N, 20).
def compute_quantile_score(predictions: np.ndarray, threshold: float) -> np.ndarray:
"""Вычисляет бинарный сигнал по квантильному порогу.
Аргументы:
predictions: Массив предсказаний, shape (N,).
threshold: Квантильный порог [0.0, 1.0].
Возвращает:
Бинарный массив сигналов shape (N,), 1 = активная позиция.
"""
Классы — аналогично с секцией Атрибуты:. Однострочный docstring — для очевидных хелперов.
git status --short (видит и изменённые M, и новые untracked ??).Для каждого in-scope файла:
docs/<category>/<module>.md — создать/обновить по mapping. В docs отразить: назначение, входы/выходы, запуск, ограничения.Этот скилл не создаёт и не меняет поведенческий код — допускает только header/docstring-правки. Создание кода ведёт test-driven-development и правила AGENTS.md.
Обновить записи для in-scope code-файлов. При «обнови MODULE_INDEX.md» — полный glob: **/*.py, **/*.mq4, **/*.mqh, **/*.ipynb; исключить .venv/, __pycache__/, .git/, docs/archive/.
Колонки: Модуль | Назначение | Вход → Выход | Docs | Статус.
MODULE_INDEX.md или ставить ⚠️; не придумывать.-, не блокировать.^\| \[ в MODULE_INDEX.md, проверить отсутствие битых ссылок..md; в .md — обзор и ссылки.wiki/ — за него отвечает скилл my:wiki.AGENTS.md и скилл test-driven-development. Этот скилл обновляет документацию, не код.| Ошибка | Исправление |
|---|---|
| docs не обновлены после изменения CLI | Обновить секцию Использование в header и в docs |
новый модуль есть в коде, но нет в MODULE_INDEX.md | Добавить строку в соответствующий раздел |
| дублирование описаний между несколькими docs | Оставить одну source-of-truth страницу, в остальных ссылки |
правка .mqh «как UTF-16LE» ломает кодировку | Проверить file перед правкой; фактическая кодировка UTF-8 |