257 lines
8.8 KiB
Markdown
257 lines
8.8 KiB
Markdown
# Предложения по улучшению навигации в документах
|
||
|
||
**Дата:** 2025-01-27
|
||
**Версия:** 1.0
|
||
|
||
---
|
||
|
||
## Анализ текущей ситуации
|
||
|
||
### Что есть сейчас:
|
||
- ✅ Главный README.md с выбором языка
|
||
- ✅ README.md в каждой языковой версии с категоризацией
|
||
- ✅ Перекрестные ссылки между документами
|
||
- ✅ Ссылки на дополнительные материалы в конце документов
|
||
|
||
### Проблемы:
|
||
- ❌ Длинные документы без оглавления сложно навигировать
|
||
- ❌ Нет четкого пути "что читать дальше"
|
||
- ❌ Сложно понять общую структуру документации
|
||
- ❌ Нет быстрого доступа к разделам внутри документа
|
||
- ❌ Нет понимания текущего местоположения в документации
|
||
|
||
---
|
||
|
||
## Предлагаемые варианты улучшения
|
||
|
||
### ВАРИАНТ 1: Оглавление (TOC) в начале документов ⭐ РЕКОМЕНДУЕТСЯ
|
||
|
||
**Описание:** Добавить автоматическое оглавление со ссылками на все разделы документа.
|
||
|
||
**Преимущества:**
|
||
- Быстрый обзор структуры документа
|
||
- Прямые ссылки на нужные разделы
|
||
- Особенно полезно для длинных документов (for-investors.md, financial-calculations.md)
|
||
|
||
**Пример реализации:**
|
||
|
||
```markdown
|
||
# Название документа
|
||
|
||
**Версия:** 1.0
|
||
**Дата обновления:** 2025-01-27
|
||
|
||
---
|
||
|
||
## 📑 Содержание
|
||
|
||
- [Обзор](#обзор)
|
||
- [Раздел 1](#раздел-1)
|
||
- [Подраздел 1.1](#подраздел-11)
|
||
- [Подраздел 1.2](#подраздел-12)
|
||
- [Раздел 2](#раздел-2)
|
||
- [Дополнительные материалы](#дополнительные-материалы)
|
||
|
||
---
|
||
|
||
## Обзор
|
||
...
|
||
```
|
||
|
||
**Где применить:**
|
||
- `for-investors.md` (736 строк)
|
||
- `financial-calculations.md` (448 строк)
|
||
- `business-model.md` (388 строк)
|
||
- `market-analysis.md` (243 строки)
|
||
- `governance.md`
|
||
- `for-entrepreneurs.md`
|
||
- `for-contractors.md`
|
||
|
||
---
|
||
|
||
### ВАРИАНТ 2: Навигационные блоки "Следующий/Предыдущий" ⭐ РЕКОМЕНДУЕТСЯ
|
||
|
||
**Описание:** Добавить блоки навигации в начало и конец каждого документа.
|
||
|
||
**Преимущества:**
|
||
- Четкий путь чтения документов
|
||
- Логическая последовательность изучения
|
||
- Удобно для последовательного изучения
|
||
|
||
**Пример реализации:**
|
||
|
||
```markdown
|
||
---
|
||
|
||
**← Предыдущий документ:** [business-model.md](business-model.md)
|
||
**Содержание:** [README.md](README.md)
|
||
**Следующий документ →:** [market-analysis.md](market-analysis.md)
|
||
|
||
---
|
||
|
||
# Название документа
|
||
|
||
...
|
||
|
||
---
|
||
|
||
**← Предыдущий документ:** [business-model.md](business-model.md)
|
||
**Содержание:** [README.md](README.md)
|
||
**Следующий документ →:** [market-analysis.md](market-analysis.md)
|
||
```
|
||
|
||
**Логические цепочки чтения:**
|
||
|
||
**Для инвесторов:**
|
||
1. README → for-investors.md → financial-calculations.md → market-analysis.md → governance.md
|
||
|
||
**Для предпринимателей:**
|
||
1. README → accelerator-program.md → for-entrepreneurs.md → use-cases.md
|
||
|
||
**Для подрядчиков:**
|
||
1. README → for-contractors.md → use-cases.md
|
||
|
||
---
|
||
|
||
### ВАРИАНТ 3: Блок "Быстрая навигация" в начале документа
|
||
|
||
**Описание:** Добавить блок с быстрыми ссылками на связанные документы и основные разделы.
|
||
|
||
**Преимущества:**
|
||
- Ссылки на связанные документы всегда под рукой
|
||
- Ссылки на основные разделы текущего документа
|
||
- Ссылка "Наверх" в длинных документах
|
||
|
||
**Пример реализации:**
|
||
|
||
```markdown
|
||
# Название документа
|
||
|
||
**Версия:** 1.0
|
||
**Дата обновления:** 2025-01-27
|
||
|
||
---
|
||
|
||
## 🧭 Быстрая навигация
|
||
|
||
**Связанные документы:**
|
||
- 📊 [Бизнес-модель](business-model.md)
|
||
- 💰 [Финансовые расчеты](financial-calculations.md)
|
||
- 📈 [Рыночный анализ](market-analysis.md)
|
||
- 🗺️ [Дорожная карта](roadmap.md)
|
||
|
||
**Основные разделы:**
|
||
- [Обзор](#обзор)
|
||
- [Раздел 1](#раздел-1)
|
||
- [Раздел 2](#раздел-2)
|
||
- [Дополнительные материалы](#дополнительные-материалы)
|
||
|
||
**Навигация:**
|
||
- [← Назад к содержанию](README.md)
|
||
- [↑ Наверх](#название-документа)
|
||
|
||
---
|
||
|
||
## Обзор
|
||
...
|
||
```
|
||
|
||
---
|
||
|
||
### ВАРИАНТ 4: Breadcrumbs (хлебные крошки)
|
||
|
||
**Описание:** Добавить строку навигации в начало каждого документа.
|
||
|
||
**Преимущества:**
|
||
- Понимание текущего местоположения
|
||
- Быстрый возврат к родительским разделам
|
||
|
||
**Пример реализации:**
|
||
|
||
```markdown
|
||
# Название документа
|
||
|
||
**Навигация:** [Главная](README.md) > [Для инвесторов](for-investors.md) > Финансовые расчеты
|
||
|
||
**Версия:** 1.0
|
||
**Дата обновления:** 2025-01-27
|
||
|
||
---
|
||
```
|
||
|
||
---
|
||
|
||
### ВАРИАНТ 5: Карта документации (SITEMAP)
|
||
|
||
**Описание:** Создать отдельный файл с полной картой всей документации.
|
||
|
||
**Преимущества:**
|
||
- Полный обзор всей документации
|
||
- Поиск по категориям
|
||
- Визуальная структура
|
||
|
||
**Файл:** `SITEMAP.md` или `DOCUMENTATION_MAP.md`
|
||
|
||
**Структура:**
|
||
```markdown
|
||
# Карта документации VC HB3 Accelerator
|
||
|
||
## 📋 Для инвесторов
|
||
1. [for-investors.md](for-investors.md) - Основной документ
|
||
2. [financial-calculations.md](financial-calculations.md) - Детальные расчеты
|
||
3. [market-analysis.md](market-analysis.md) - Рыночный анализ
|
||
4. [governance.md](governance.md) - Управление
|
||
|
||
## 🚀 Для предпринимателей
|
||
1. [accelerator-program.md](accelerator-program.md) - Программа
|
||
2. [for-entrepreneurs.md](for-entrepreneurs.md) - Подробности
|
||
3. [use-cases.md](use-cases.md) - Примеры
|
||
|
||
...
|
||
```
|
||
|
||
---
|
||
|
||
### ВАРИАНТ 6: Улучшенный README с визуальной иерархией
|
||
|
||
**Описание:** Улучшить структуру README с четкими путями чтения для разных ролей.
|
||
|
||
**Добавить:**
|
||
- Визуальные индикаторы важности документов
|
||
- Рекомендуемые пути чтения
|
||
- Иконки и цветовое кодирование
|
||
- Блок "Начните отсюда" для каждой роли
|
||
|
||
---
|
||
|
||
## Рекомендуемый план внедрения
|
||
|
||
### Приоритет 1 (Высокий) - Внедрить сразу:
|
||
1. ✅ **Оглавление (TOC)** в длинных документах
|
||
- for-investors.md
|
||
- financial-calculations.md
|
||
- business-model.md
|
||
- market-analysis.md
|
||
|
||
2. ✅ **Навигационные блоки** "Следующий/Предыдущий"
|
||
- Все основные документы
|
||
- Логические цепочки чтения
|
||
|
||
### Приоритет 2 (Средний) - Внедрить после:
|
||
3. ✅ **Блок "Быстрая навигация"** в начале документов
|
||
4. ✅ **Карта документации** (SITEMAP.md)
|
||
|
||
### Приоритет 3 (Низкий) - Опционально:
|
||
5. ✅ **Breadcrumbs** в начале документов
|
||
6. ✅ **Улучшенный README** с визуальной иерархией
|
||
|
||
---
|
||
|
||
## Примеры реализации
|
||
|
||
См. следующие файлы с примерами:
|
||
- `examples/TOC_example.md` - Пример с оглавлением
|
||
- `examples/NAVIGATION_example.md` - Пример с навигационными блоками
|
||
- `examples/QUICK_NAV_example.md` - Пример с быстрой навигацией
|
||
|