<Feature Name> Documentation.md

feature-name-doc.md

Documentation

Overview

<Краткое описание сути фичи, её цели и для чего она нужна.>
Пример: "Картина дня" — это автоматическая генерация дневного дайджеста чат-активности, чтобы быстро получать обзор тенденций, тем и важных событий за сутки.

---

Key Features

• Feature 1: Что делает (1-2 предложения)
• Feature 2: ...
• Feature 3: ...

---

Architecture

Высокоуровневое описание внутренней логики или архитектуры. Схема: участники, этапы, потоки данных. Можно с помощью Mermaid-графа "flowchart" или "sequenceDiagram".

flowchart TD
    A[Input/Source] --> B[Processing/Transformation]
    B --> C[Output/Storage/Delivery]
    C --> D[Monitoring/Feedback]

Loading

---

Ownership & Precedence Rules

• <Кто или что формирует финальное решение/результат. Как конфликтуют параллельные/альтернативные источники (если актуально).>
• <Правила "кто сильнее".>
• <Что делать при появлении ручных вмешательств.>

---

Specification

spec:
  settingA: <описание>
  settingB:
    param1: <описание>
    param2: <описание>
  ...

Кратко расшифровать настройки и параметры спецификации.

---

Status & State Reporting

• Опишите, какие параметры/статусы система отслеживает в процессе или на выходе (времена, успешность шагов, summary, ошибки).
• Пример статуса: status: lastRun: result: <Success/Failed/Error> details: <доп. информация>

---

Monitoring & Metrics

Metric	Type	Description
feature_total_runs	Counter	Всего запусков фичи
feature_failed_runs	Counter	Всего ошибок
feature_processing_time	Gauge/Histogram	Время обработки
feature_input_size	Gauge	Размер входных данных
...	...	...

Alert Rules

• Alert 1: Когда срабатывает (например, >5 ошибок за час)
• Alert 2: ...

---

Health Checks

• Check 1: Описание
• Check 2: ...

---

Selection/Behavior Algorithm

1. <Алгоритм принятия решений (приоритеты, фильтры, порядок обработки и проч.)>
2. Значимые условия обработки.

flowchart TD
    Start --> Step1[Описание шага]
    Step1 --> Step2[Следующий шаг]
    Step2 -->|Yes| Step3
    Step2 -->|No| Step4

Loading

---

Best Practices

1. <Описание "как лучше использовать">
2. <Типовые шаблоны применения или рестрикции>
3. <Советы по интеграции/гибкой настройке и т.д.>

---

Operational Cheatsheet

Common actions

Manual run

my_feature run --date YYYY-MM-DD

Смотреть статус

my_feature status

Логи ошибок

cat logs/my_feature.log

Monitoring

curl http://localhost:9100/metrics | grep feature_

Frequently Asked Questions

Почему результат пустой/некорректный?

<Объяснение>

Как добавить новый источник/выход?

<Инструкция или ссылка на раздел спецификации>