ddmitry/clickstream-ch-kafka-superset-demo
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

docs(agents): уточнены правила русского языка и понятности документов

Browse Source 
- Зачем:
  - прежняя формулировка допускала транслитерации и не требовала краткости и понятности самих документов.
- Что:
  - «устоявшийся английский» сужен до имён технологий, инструментов и кода.
  - добавлено правило: документы и объяснения — короткими фразами, простыми словами, понятность важнее буквальной точности.
- Проверка:
  - чтение AGENTS.md.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
ddadmin
2026-06-14 14:52:09 +03:00
co-authored by Claude Opus 4.8
parent 49512b190a
commit c4cc01e206
1 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
AGENTS.md
+3 -1
View File
@@ -8,7 +8,9 @@
## Обязательные правила
Пиши понятным русским языком без англицизмов и не переведенных слов за исключением ситуаций, где английский устоявшийся. Сложные темы старайся объяснять так, чтобы они хотя бы базово были понятны неспециалисту.
Пиши на ясном русском языке. Иностранные слова оставляй только там, где у термина нет устоявшегося русского аналога: имена технологий и инструментов (Kafka, ClickHouse, Airflow) и названия из кода. Если для понятия есть обычное русское слово — используй его, не выдумывай транслитерации (пиши «приведение в соответствие», а не «реконсиляция»; «точка отсчёта», а не «origin»).
Документы, комментарии и объяснения держи короткими и понятными читателю, который их не писал: простые слова, короткие фразы, сложную мысль поясняй при первом упоминании (помни про менти-неспециалиста). Если понятность и буквальная точность спорят — выбирай понятность. Правило касается и текста, и заголовков разделов.
Для работы с python использовать uv.