verstak/docs/00_README.md

67 lines
2.9 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. Главная сущность — **дело**.
Верстак нужен людям, у которых работа организована через дела,
а не через задачи.
Дело может быть:
- клиентом;
- сайтом клиента;
- личным проектом;
- набором документов;
- рецептом/инструкцией;
- архивом;
- разовой работой.
Внутри дела живут:
- вложенные папки;
- Markdown-заметки;
- документы (docx/pdf/xlsx/odt/png/zip);
- файлы любых типов;
- запускаемые действия (URL, файл, папка, команда);
- журнал работ;
- история активности.
## Файлы пакета
1. [[01_Product_Spec]] — описание продукта, аудитория, сценарии.
2. [[02_Architecture]] — архитектура core/GUI/TUI/CLI/server, плагины.
3. [[03_Data_Model_Storage]] — модель данных, SQLite, vault, files, notes.
4. [[04_Sync_Backup_Activity]] — синхронизация, backup, activity.
5. [[05_UI_UX]] — экраны GUI/TUI.
6. [[06_Roadmap]] — план разработки по этапам.
7. [[07_AI_Coder_Prompts]] — промпты для ИИ-кодера.
8. [[08_MVP_Checklist]] — чеклист первого MVP.
9. [[09_Extensibility]] — архитектура плагинов (Lua + шаблоны дел).
## Главные принципы
1. **Local-first.**
Рабочая копия всегда локальная. Сервер — для sync/backup.
2. **Универсальная база + плагины.**
Базовая модель (дело + заметка + файл + действие + журнал)
работает для любого сегмента. Плагины добавляют календарь,
канбан, импортёры — без перекомпиляции.
3. **Данные принадлежат пользователю.**
Заметки и файлы лежат обычными файлами. SQLite — индекс.
4. **Дерево дел важнее тегов.**
5. **Не таймтрекер, а восстановитель следов.**
6. **GUI основной, TUI быстрый, CLI служебный.**
7. **Sync не уничтожает данные.**
## Короткая формула
> Верстак — локальная программа, где по каждому клиенту или проекту
> лежат все его файлы, заметки, документы, ссылки, действия и
> история работ.