verstak/docs/00_README.md

70 lines
3.7 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Верстак — индекс документации
**Верстак** — local-first рабочий vault для дел, клиентов, проектов, документов, заметок, файлов, скриптов, действий запуска, журнала работ и синхронизации между машинами.
Это не просто заметочник и не CRM. Главная сущность — **дело**.
Дело может быть:
- клиентом;
- сайтом клиента;
- личным проектом;
- Godot-проектом;
- набором документов;
- рецептом/инструкцией;
- архивом;
- разовой помощью человеку;
- рабочей областью вроде `Рецепты / MySQL / Backup сайта`.
Внутри дела живут:
- вложенные папки;
- Markdown-заметки;
- документы `docx/pdf/xlsx/odt`;
- скриншоты;
- архивы;
- исходники;
- скрипты;
- SQL-фрагменты;
- ссылки;
- запускаемые действия;
- журнал работ;
- примерное время;
- история активности;
- связанные дела.
## Файлы пакета
1. [[01_Product_Spec]] — полное описание продукта и сценариев.
2. [[02_Architecture]] — архитектура core/GUI/TUI/CLI/server.
3. [[03_Data_Model_Storage]] — модель данных, SQLite, vault, files, notes, actions.
4. [[04_Sync_Backup_Activity]] — синхронизация, восстановление, backup, activity/time tracking.
5. [[05_UI_UX]] — экраны GUI/TUI, дерево, дело, поиск, документы, действия.
6. [[06_Roadmap]] — план разработки по этапам.
7. [[07_AI_Coder_Prompts]] — промпты для ИИ-кодера.
8. [[08_MVP_Checklist]] — чеклист первого MVP.
## Главные принципы
1. **Local-first.**
Рабочая копия всегда локальная. Сервер нужен для sync/backup/restore, но программа не должна зависеть от сервера каждый день.
2. **Данные принадлежат пользователю.**
Заметки и файлы физически лежат обычными файлами в vault. SQLite хранит индекс, связи, метаданные, FTS и sync state.
3. **Дерево дел важнее тегов.**
Теги полезны, но основная навигация — вложенное дерево: `Клиенты / Ромашка / Сайт / Документы`.
4. **Не таймтрекер, а восстановитель следов.**
Верстак не требует постоянно нажимать Start/Stop. Он собирает следы работы и предлагает записать их в журнал.
5. **GUI основной, TUI быстрый, CLI служебный.**
GUI — основная рабочая среда. TUI — быстрый доступ из терминала. CLI — sync, import, scripts, rescue mode.
6. **Sync не должен уничтожать данные.**
Нужны trash, conflict copies, versions, snapshots и retention.
## Короткая формула
> Верстак — это локальный рабочий кабинет для людей, у которых жизнь состоит из проектов, клиентов, документов, заметок, скриптов, файлов, репозиториев и вечного “где я это сохранил?”.