Руководство по выводу на русском языке (Russian)
Этот файл содержит языковые рекомендации для генерации контента графа знаний на русском языке.
Соглашения по тегам
Используйте русские теги или общепринятые английские технические термины:
| Шаблон | Рекомендуемые теги |
|---|---|
| Точка входа | точка-входа, barrel, exports или entry-point |
| Утилитарные функции | утилиты, helpers, common или utility |
| API-обработчики | api-handler, контроллер, endpoint |
| Модели данных | модель-данных, entity, schema или data-model |
| Тестовые файлы | тесты, unit-test, test |
| Конфигурационные файлы | конфигурация, build-system, settings или configuration |
| Инфраструктура | инфраструктура, deployment, контейнеризация или infrastructure |
| Документация | документация, руководство, documentation |
Смешанная стратегия: общепринятые технические термины оставляйте на английском (например, middleware, api-handler), описательные теги можно писать на русском.
Стиль резюме
Пишите резюме на русском в 1–2 предложениях:
- Описывайте назначение и роль файла
- Используйте активный залог («предоставляет…», «обрабатывает…», «управляет…»)
- Избегайте повторения имени файла
Примеры:
- Хорошо: «Предоставляет вспомогательные функции для форматирования дат и очистки строк, широко используемые на API-слое.»
- Плохо: «Файл utils содержит утилитарные функции.»
Технические термины
Следующие термины рекомендуется оставлять на английском (устоявшегося перевода нет):
middleware,hook,barrel,entry-pointORM,REST API,CI/CD,CRUDsingleton,factory,observerinterceptor,guard
Имена слоёв
Используйте русские имена слоёв:
API-слой,сервисный слой,слой данных,UI-слойинфраструктура,конфигурация,документацияутилитарный слой,слой middleware,тестовый слой
Или оставляйте английские (по договорённости команды):
API Layer,Service Layer,Data Layer