Приложение
В этой главе представлена техническая документация Plannotator, включая документацию API, определения моделей данных и информацию о лицензии. Этот контент предназначен для пользователей, которым необходимо глубоко понять внутренние механизмы системы или доработать её.
Содержание главы
| Страница | Описание |
|---|---|
| Справочник по API | Просмотр всех конечных точек API Plannotator и форматов запросов/ответов |
| Модели данных | Ознакомление с моделями данных, используемыми Plannotator, включая Annotation, Block, CodeAnnotation и т. д. |
| Лицензия | Изучение лицензии Plannotator (BSL-1.1) и ограничений использования |
Рекомендации по обучению
Содержание приложения является относительно независимым, вы можете выборочно читать его по мере необходимости:
- Хотите узнать о интерфейсах API → сразу читайте Справочник по API
- Хотите понять структуры данных → читайте Модели данных
- Хотите узнать об ограничениях использования → читайте Лицензия
Совет
Содержимое приложения предназначено в основном для справки, его не нужно изучать по порядку. Рекомендуется обращаться к соответствующим разделам при возникновении конкретных вопросов.
Предварительные условия
Перед чтением приложения рекомендуется сначала изучить следующие материалы:
- Быстрое начало - узнайте основные концепции Plannotator
- Основы проверки планов - ознакомьтесь с базовыми операциями проверки
Следующие шаги
После завершения чтения приложения вы можете:
- Посмотреть Журнал изменений, чтобы узнать историю версий и новые функции
- Вернуться к Расширенным функциям, чтобы изучить больше продвинутых возможностей
- При возникновении проблем обратиться к Частым вопросам