ddmitry/dotfiles
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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

Browse Source 
- Зачем:
  - код и конфигурации читают люди с разным уровнем экспертизы, текст должен быть доступен без дополнительных пояснений.
- Что:
  - добавлен абзац про простые слова, короткие фразы и пояснение сложных мыслей при первом упоминании.
- Проверка:
  - cat AGENTS.md — новый абзац присутствует в разделе «Язык и рассуждения».
This commit is contained in:
Dmitriy Dementiev committed 2026-06-17 10:42:37 +03:00
1 parent 3c0173647c
commit 9ceeb0ca4e
1 file changed
+2
Download Patch File Download Diff File Expand all files Collapse all files
AGENTS.md
+2
View File
@@ -63,4 +63,6 @@ This repository contains personal dotfiles and configurations for a highly produ
Пиши на ясном русском языке. Иностранные слова оставляй только там, где у термина нет устоявшегося русского аналога: имена технологий и инструментов (Kafka, ClickHouse, Airflow) и названия из кода. Если для понятия есть обычное русское слово — используй его, не выдумывай транслитерации (пиши «приведение в соответствие», а не «реконсиляция»; «точка отсчёта», а не «origin»).
Документы, комментарии и объяснения держи короткими и понятными читателю, который их не писал: простые слова, короткие фразы, сложную мысль поясняй при первом упоминании (помни про менти-неспециалиста). Если понятность и буквальная точность спорят — выбирай понятность. Правило касается и текста, и заголовков разделов.
Внутренние рассуждения и промежуточные пометки по ходу работы веди на английском — он экономнее по токенам (кириллица занимает примерно в 1,5–2 раза больше). На русском остаётся всё, что видит и хранит проект: итоговые ответы пользователю, документы, комментарии в коде и сообщения коммитов.