Альтернативное изучение фреймворка
Кроме официальной документации существуют другие способы изучения программ, которые будут рассмотрены здесь по отношению к фреймворку HLEB2.
#Самостоятельное изучение без документации
Некоторые программисты изучают работу кода методом проб и ошибок. Если вы предпочитаете этот способ, то в этом фреймворке много комментариев к коду, которые помогут вам в этом. Уточните возможности вашей IDE для быстрого доступа к этим комментариям.
В следующем пункте указано, что репозиторий фреймворка содержит текстовую версию документации, так что вы можете найти нужные примеры просто поиском по проекту.
#Помощь LLM в написании кода
HLEB2 является довольно молодым фреймворком, поэтому информации для обучения неспециализированных нейросетей пока недостаточно в свободном доступе.
Но если вы хотите изучать фреймворк при помощи нейросети, то вам может пригодиться единая текстовая версия этой инструкции в формате Markdown. Например, сервис deepwiki позволяет задавать вопросы по коду на основе этой информации.
Благодаря тому, что весь базовый код фреймворка находится в одном репозитории, а также в него добавлена компактная версия этой документации, то сервис deepwiki без проблем генерирует ответы на основе кода актуальной версии и выдает неплохие варианты, но их нужно проверять, в отличие от примеров из официальной документации.
Например, вот так этот сервис отвечает на следующие вопросы:
Как сделать страницу сайта с роутингом, контроллером, шаблоном и моделью?
Как отправить пользователю ошибку 404 в контроллере?
Как использовать внедрение зависимостей?
Указывать название фреймворка не нужно, так как этот раздел сервиса специально натренирован для работы с конкретным репозиторием.
#Советы по составлению промптов для LLM
Чтобы получить максимально релевантный ответ с первого раза, рекомендуется указывать в вопросе:
ВОПРОС - (здесь лаконичный вопрос, указывающий на запрос конкретной информации, без расплывчатых формулировок).
РОЛЬ - с какой позиции будет отвечать нейросеть. Например, "как эксперт по фреймворку HLEB2".
ФОРМАТ - например, "3-5 практических примеров с объяснениями в стиле официальной документации".
ОБЪЁМ - например, "400-600 слов + код".
ТРЕБОВАНИЯ - учесть преимущества; типичные ошибки; сравнение подходов (если их несколько); XSS, CSRF, SQL-injection и другие упомянуть при необходимости.
УРОВЕНЬ - на какую аудиторию рассчитан ответ. Например: junior, middle или senior (один конкретный тип).
ИСКЛЮЧЕНИЯ - список того, чего НЕ хотите видеть в ответе.
ВАЖНОСТЬ - можно указать, нужно ли это для персонального обучения или это делается для публичного проекта планетарного масштаба, способного сделать этот мир лучше. Есть мнение, что во втором случае будет дан более точный ответ.
Ответам нейросетей нельзя доверять на 100%, а без собственных знаний фреймворка трудно будет проверять результат. В этой документации в простой форме передаются примеры его работы, проверенные вручную и основные принципы фреймворка, составленные непосредственно автором.
← Предисловие к использованию документации
