Добро пожаловать в единую систему документации Timeline Studio!
Эта документация обеспечивает:
- Полный контекст проекта для разработчиков и AI-ассистентов
- Структурированную информацию по всем аспектам проекта
- Актуальное состояние разработки и прогресса
- Билингвальность из коробки (русский + английский)
- Enterprise-ready организацию с 18 специализированными секциями
Главный документ с видением, целями и ключевыми инновациями проекта:
- Манифест проекта - Полное описание проекта и его инноваций
- Обзор архитектуры - Высокоуровневый обзор системы
- Быстрый старт - Как начать работу с проектом
- Установка - Детальное руководство по установке
- Структура проекта - Организация кода
Требования к проекту и спецификации:
- Функциональные требования - Детальные функциональные требования
- Техническое задание - Технические требования системы
- Спецификация функций - Детальная спецификация возможностей
- AI Chat требования - Требования к AI чат модулю
- AI анализ требования - Требования к AI анализу
- AI функции требования - Требования к AI возможностям
- Требования расширения рынка - Требования к расширению рынка
- frontend/ - React, XState, компоненты
- backend/ - Rust, Tauri, сервисы
- AI сервис - Архитектура AI сервисов и интеграций
- Поток данных - Архитектура потока данных
- Коммуникация - Взаимодействие компонентов
Документация всех API:
- External And Headless Integration Contracts - Supported
ProjectSchema, Rusttimeline,render-job,bot-workflow,bot-worker, and postim/headless integration surface - Bot-First Production Contract - Supported Telegram bot-first production workflow, state, retry, cleanup and Rust publish boundary
- Rust/Node AI Edit Parity - Current AI edit ownership boundary and future Rust
llm-editparity path - Media API - API для работы с медиафайлами
- AI Chat API - API для AI чат функциональности
- Export API - API для экспорта проектов
- Recognition API - API для распознавания
- Timeline API - API для работы с таймлайном
- Video Compiler API - API для компиляции видео
- Transition Sync API - API для синхронизации переходов
- Video Player Transitions API - API для переходов в плеере
- Backend API - Backend API документация
- Интеграции - API интеграций
Руководства для разработчиков:
- Руководство разработчика - Основное руководство по разработке
- Команды разработки - Все команды для разработки
- Производительность - Оптимизация производительности
- Настройка - Настройка среды разработки
- Тестирование - Руководство по тестированию
- Стандарты кодирования - Стандарты написания кода
- Контрибьютинг - Как внести вклад в проект
- Чеклист разработки - Чеклист для разработчиков
- Статус зависимостей - Обзор зависимостей проекта
- Линтинг и форматирование - Инструменты качества кода
- Персистентность медиафайлов - Работа с медиафайлами
- Справочник скриптов - Документация NPM скриптов
- Разработка плагинов - Руководство по разработке плагинов
- Управление версиями - Практики контроля версий
- Миграция WebGL - Руководство по миграции WebGL
- Примеры миграции WebGL - Примеры миграции WebGL
- Рефакторинг AI Chat - Отчет о рефакторинге AI Chat
- Очистка AI Content Intelligence - Очистка AI модуля
- Анализ AI модулей - Отчет анализа AI модулей
- Рефакторинг Scene Analysis - Рефакторинг сервисов анализа сцен
- Сводка ошибок консоли - Сводка ошибок консоли
- Директории приложения - Структура директорий
Руководства по развертыванию:
- Руководство по сборке - Инструкции по сборке приложения
- Настройка OAuth - Настройка OAuth интеграций
- Telegram Bot Worker Production Runbook - Production topology, systemd setup, retention and sandbox smoke for bot-first worker
- Telegram AI Review Sandbox Smoke - Mocked and real sandbox smoke path for Telegram AI review without desktop UI
- Telegram AI Review Sandbox Report Template - Sanitized evidence template for real sandbox runs
- Платформы - Специфика развертывания по платформам
- active/ - Текущие задачи
- completed/ - Выполненные задачи
- planned/ - Будущие задачи
Проверяемые примеры и quickstarts:
- Bot/Headless SDK Quickstart - Supported
ProjectSchema,render-job,bot-workflow,bot-worker, and publish validation path for external consumers - AI Director Usage - Пример использования AI Director
- Peaks.js Usage Examples - Примеры waveform-интеграции
Архитектурные решения:
- Исследование DI - Исследование dependency injection
Текущее состояние проекта:
- Текущий статус - Актуальное состояние разработки
- Дорожная карта - Планы развития проекта
Юридические документы:
- Лицензия - Информация о лицензировании
Стратегии тестирования:
- Тестирование - Основное руководство по тестированию
- Backend тестирование - Тестирование backend части
- Тестирование с реальными медиа - Тестирование с медиафайлами
- Новое тестирование с медиа - Обновленное тестирование медиа
- Проблемы памяти в тестах - Проблемы памяти при тестировании
- Сводка тестов - Сводка покрытия тестами
- Руководство по тестированию - Комплексное руководство по тестированию
Непрерывная интеграция и развертывание:
- CI/CD - Основное руководство по CI/CD
- Настройка CI/CD - Настройка пайплайнов
- Компоненты Codecov - Настройка покрытия кода
- Semantic Release - Автоматические релизы
Процессы обеспечения качества:
- Quality Assurance - Стандарты качества
- Руководство по Alpha тестированию - Руководство по тестированию Alpha версии
Руководства по безопасности:
- Безопасность - Руководство по безопасности
- Руководящие принципы безопасности - Принципы безопасности
Документация для пользователей:
- Пользовательская документация - Руководства для пользователей
Управление релизами:
- Релизы - Управление версиями и релизами
- Бизнес-план - Бизнес-план проекта
- Конкурентный анализ - Анализ конкурентов
- Финансовые прогнозы - Финансовые прогнозы
- Инвестиционная оценка - Оценка для инвесторов
- Требования к презентации - Требования к питч-деку
- Структура презентации - Структура питч-дека
- Модель ценообразования - Модель ценообразования
- Дорожная карта команды - Дорожная карта и инвестиции
- AI Demo слайды - Слайды для демонстрации AI
- Новичкам → Быстрый старт
- Разработчикам → Обзор архитектуры
- Контрибьюторам → Руководство разработчика
- Маркетологам → Стратегии продвижения
- Alpha готовность: 97.5%
- Rust workspace:
crates/*decomposition завершена - TypeScript workspace:
packages/*andapps/*extraction завершены - Bot/headless contracts: Phase G закрыта, main CI зеленый
- Изучите Манифест проекта
- Выберите задачу из Планируемых
- Следуйте руководствам из Development
- Для bot/headless задач начинайте с Current Status and Roadmap
Наша документация организована по принципам:
✅ 18 специализированных секций для полного покрытия проекта
✅ Билингвальность из коробки (ru/en структура)
✅ Media-First архитектура для мультимедийных проектов
✅ Enterprise-ready организация с профессиональными стандартами
- GitHub: https://github.com/chatman-media/timeline-studio
- Маркетинговые стратегии: 18_marketing/
- Текущий статус: 10_project_state/current-status.md
- Roadmap: 10_project_state/roadmap.md
Шаблоны документов:
- Шаблон задачи - Шаблон для описания задач
- Шаблон функции - Шаблон для описания функций
- Шаблон ADR - Шаблон архитектурных решений
- Шаблон маркетинговой стратегии - Шаблон маркетинговой стратегии
- Шаблон релиза - Шаблон заметок о релизе
Последнее обновление: 11 июня 2026