Введение
Начало работы
Узнайте, как адаптировать этот шаблон документации для своего продукта, проекта или внутренней базы знаний.
Установка
Пошаговая настройка проекта и локального окружения.
Архитектура
Структура системы, ключевые модули и точки расширения.
Расширения
Интеграции, дополнительные возможности и собственные плагины.
API-справка
Методы, параметры, примеры и ожидаемые результаты.
Этот шаблон сохраняет готовую структуру сайта: боковую навигацию, поиск, оглавление, примеры кода, предупреждения и темную тему. Замените текст на свои материалы, а разделы используйте как основу для будущей документации.
Быстрый старт
Начните с установки зависимостей и запуска локального сервера. После этого можно редактировать страницы в каталоге src/app/docs и обновлять навигацию в src/lib/navigation.js.
Установка зависимостей
Установите пакеты проекта. Команда ниже оставлена как пример для будущего пакета или внутреннего шаблона.
npm install @example/template-project
После установки запустите сайт локально и проверьте главную страницу, поиск и переключение темы.
Проверьте данные перед публикацией
Перед деплоем замените демонстрационные тексты, ссылки, названия разделов и примеры кода на реальные материалы вашего проекта.
Настройка шаблона
Основные параметры можно описывать прямо в документации. Используйте такие блоки, чтобы показывать рекомендуемую конфигурацию.
// template-project.config.js
export default {
project: 'Шаблон документации',
docs: {
navigation: true,
search: true,
theme: 'system',
},
}
Совет
Держите примеры короткими. Если настройка большая, вынесите подробности в отдельную страницу и оставьте здесь только основной путь.
Основное использование
Документация должна помогать читателю быстро понять задачу, выполнить действие и проверить результат. Ниже показана структура, которую можно повторять на внутренних страницах.
Первый сценарий
Опишите, какую задачу решает пользователь. Начинайте с цели, затем переходите к условиям и командам.
Сброс тестовых данных
Добавьте инструкции для безопасной очистки демонстрационных данных, временных файлов или локального состояния.
Добавление своего контента
Создавайте новые страницы в нужном разделе, обновляйте заголовки и добавляйте ссылки в навигацию. Так структура сайта останется понятной по мере роста документации.
Получение помощи
Добавьте сюда правила поддержки: где задавать вопросы, как оформлять ошибки и какие данные прикладывать к обращению.
Сообщить о проблеме
Опишите ожидаемое поведение, фактический результат, шаги воспроизведения и версию окружения.
Присоединиться к сообществу
Укажите каналы команды, внутренний чат или страницу обсуждений, где читатели могут получить помощь и предложить улучшения.