docs: EN source-of-truth workflow (en2ru + DOCSTRAT)
- en2ru.py: EN markdown -> Russian via Ollama , strips code-fence artifacts, prints jargon-review hints to stderr - DOCSTRAT.md: rule — EN canonical source, RU for comprehension only, never edit on drifted Russian (dedup/receive mistranslation guard) - ROADMAP.ru.md: sample RU generated from EN source - AGENTS.md: section 8 documenting the EN-first workflow
This commit is contained in:
1 parent
bc68b68598
commit
4a394adc3e
4 files changed
+292
No files matched your search
+35
@@ -0,0 +1,35 @@
|
||||
# Стратегия документов (English source of truth)
|
||||
|
||||
## Правило (обязательное)
|
||||
|
||||
- **Английский — канонический источник (source of truth).** Все правки вносятся
|
||||
**только** в исходный `*.md` (EN).
|
||||
- **Русский — только для бегного понимания.** Это вычислительный **инструмент**;
|
||||
термиология может «поплыть».
|
||||
- **Ник не использовать `.ru.md` за основу для правок.** Правим EN → перезапускаем
|
||||
`en2ru.py`. Нарушение → накаплием ошибочный русский текст и **не можем сделать то,
|
||||
что задумано** (опора на «поплывшую» термиологию ломает смысл).
|
||||
|
||||
### Причина
|
||||
|
||||
`translategemma:latest` **чисто пишет орфографию**, но **джаргон** переводит криво —
|
||||
вплоть до переворота значения: `dedup` → «дублирование» (обратное значение),
|
||||
`receipt` → «результат». Порусскому — вторичен и нуждается в ревью джаргона.
|
||||
|
||||
## Как
|
||||
|
||||
```bash
|
||||
python3 en2ru.py ROADMAP.md # -> ROADMAP.ru.md
|
||||
cat doc.md | python3 en2ru.py - # stdin -> doc.ru.md
|
||||
```
|
||||
|
||||
- Вывод: `<file>.ru.md`.
|
||||
- Джаргон-ревью (термы, где модель ошибается) — в **stderr**, не в RU-выводе.
|
||||
- Оффлайн: зависимостей нет (`urllib`), модель уже в Ollama (`translategemma:latest`).
|
||||
|
||||
## Порядок работ
|
||||
|
||||
1. Пишем/правим **EN** источник.
|
||||
2. `en2ru.py` → генерим **RU**.
|
||||
3. Смотри **stderr** — правь flagged-термы (ревью, не авто).
|
||||
4. Храни **оба** файла рядом: `X.md` (EN, канон) + `X.ru.md` (RU, понимание).
|
||||
Reference in new issue
Block a user