Technický text má předat informaci s co nejmenším úsilím na straně čtenáře. Přirozená čeština informační hustotu nevynucuje a generativní modely ji dále snižují: výstup je gramaticky správný, ale delší, než odpovídá jeho obsahu. Controlled Czech definuje pravidla, která hustotu vynutí, a linter, který porušení najde v CI.
V rámci nasazení nové verze bychom měli ideálně zajistit, aby se migrace
provedla až poté, co budou dokončeny všechny běžící úlohy, protože jinak
může dojít k nekonzistenci dat.Před nasazením dokončete všechny běžící úlohy. Potom spusťte migraci.
Pokud migraci spustíte dříve, data mohou být nekonzistentní.Stejná informace, tři krátké věty, explicitní pořadí kroků.
Informace před stylem. Odpověď na začátku, jedna myšlenka ve větě, explicitní aktér, jeden termín pro jeden pojem. Žádné úvody bez nové informace.
Stabilní pravidla CCxxx. Každé pravidlo má identifikátor. Diagnostika linteru, revize v pull requestu i instrukce pro agenta odkazují na stejné číslo.
Linter pro CI. Deterministický nástroj v Go, jeden binární soubor bez závislostí. Běží offline, nepoužívá LLM a text nepřepisuje. V CI selže na varování s přepínačem --fail-on-warning.
Plugin pro AI agenty. Skill pro Claude Code, Codex a ChatGPT. Agent načte do kontextu jen popis skillu. Celá pravidla načte až při práci s českým textem.
Nejasný aktér. Věta „Po dokončení se vytvoří report a odešle se administrátorovi“ neodpovídá na otázku, kdo report vytvoří. Controlled Czech vyžaduje „Worker vytvoří report“.
AI slop. Odstavec o rychle se měnícím prostředí a několika faktorech ke zvážení lze nahradit jedinou větou „Doporučení: použij PostgreSQL“.
Rozhodnutí bez důvodu. Specifikace musí odlišit fakt, požadavek, rozhodnutí, důvod, předpoklad, omezení, otevřenou otázku a příklad. Toto rozlišení pravidla vynucují slovesy musí, nesmí, měl by, neměl by a může.
technická dokumentace,
specifikace a zadání,
ADR a jiná technická rozhodnutí,
issue a pull requesty,
runbooky a provozní postupy,
instrukce pro AI agenty.
Controlled Czech není obecný návod na dobrou češtinu. Nepoužívejte ho pro marketing, beletrii ani osobní komunikaci.
# Claude Code
/plugin marketplace add sinfin/controlled-czech
/plugin install controlled-czech@sinfin
# Linter
go install github.com/sinfin/controlled-czech/cmd/controlled-czech@latest
controlled-czech check dokumentace/Specifikace, pravidla CCxxx, příklady a šablony jsou na GitHubu. Kód linteru je pod licencí MIT, specifikace pod CC BY 4.0.
Controlled Czech jako plugin z GPT marketplace. Jedna instalace, žádná konfigurace.