Отворен проект · v0.7 · неофициална публикация

Един термин.
Едно значение.

STB е контролиран български език за технически текстове: инструкции, монтаж, чертежи и спецификации. Правила за писане, речник от разрешени думи и проверка на текста.

Откъде идва идеята

Идея, която започва
в авиацията.

В края на 70-те европейските авиокомпании имат проблем: механиците четат ръководства за поддръжка на английски, който не е техен роден език.

Ръководствата са писани от различни производители. Едни пишат на американски английски, други на британски, трети на английски като втори език. Авиокомпаниите превеждат документацията за своите механици и се оплакват, че текстът се разбира трудно.

Отговорът е контролиран език: малък набор от разрешени думи, всяка с едно значение, и ясни правила за изреченията. През 1985 г. европейската асоциация на авиационната индустрия (AECMA) публикува Simplified English Guide. Днес той се нарича ASD-STE100.

От авиацията идеята се разпространява. Използва се в отбраната и намира място в S1000D. В края на 2024 г. 64% от потребителите на STE са извън авиацията и отбраната.

А при нас?

Проектът започна с прост въпрос: има ли български вариант на ASD-STE100? Доколкото ни е известно, няма. А българският има свои капани за техническия текст:

  • Болтът се затяга.Кой го затяга? Безличното „се“ крие изпълнителя и превръща командата в описание.
  • Свържете кабела към конектора, който е жълт.Какво е жълто: кабелът или конекторът?
  • Извадете филтъра от корпуса и го почистете.„Го“ е филтърът или корпусът?
  • Затегнете добре.Колко е „добре“? Без число изпълнителят решава сам.

Много ръководства за машини и оборудване у нас са преводи. Всяка неяснота е риск за хората и за оборудването. Затова започнахме STB: стандарт за яснота, който всеки може да използва, проверява и подобрява.

Как работи

Три части.
Една цел.

01

Правила

58 правила в 9 раздела: думи, глаголи, изречения, абзаци, безопасност, числа. Една команда в изречение. До 20 думи. Повелително наклонение.

Прочети правилата
02

Речник

Над 900 разрешени думи. Всяка има едно значение, пример и списък на думите, които да избягвате. Общо ядро и 11 области.

Разгледай речника
03

Проверка

Скрипт за PowerShell проверява дължина, залог, неразрешени думи и речника. Правилата, които изискват преценка (⚠), са само предупреждения.

Виж скриптовете

Как изглежда на практика

  • Не такаБолтът се затяга.
    STBЗатегнете болта.
  • Не такаСвържете кабела към конектора, който е жълт.
    STBСвържете кабела към жълтия конектор.
  • Не такаИзвадете филтъра от корпуса и го почистете.
    STBИзвадете филтъра от корпуса. Почистете филтъра.
  • Не такаЗатегнете добре.
    STBЗатегнете с момент 25 N·m.

Речникът има общо ядро и пакети по област:

  • Механика и монтаж
  • Електрика и електроника
  • Хидравлика и пневматика
  • ИТ, мрежи и софтуер
  • Подемна и мобилна техника
  • Автоматизация и роботика
  • Авиация
  • Автомобили
  • Железопътна техника
  • Мебелно и столарско производство
  • CNC машини

Приложения

Къде можете
да го използвате.

STB е набор от текстови файлове. Работи с всеки изкуствен интелект и без него.

Skill за Claude

Копирайте папката skills/stb-bulgarian в .claude/skills/ или я добавете като Skill в Claude. После помолете: „Напиши инструкцията по STB“ или „Провери този текст“.

Gem за Gemini

Създайте Gem и добавете правилата и избраните речници като инструкции или файлове. Gem пише и проверява текст по STB.

GPT и ChatGPT

Създайте собствен GPT или проект. Качете rules.md и речниците като знания и задайте роля: „Пиши и проверявай по STB“.

Други модели

Всеки модел с достатъчно голям контекст. Поставете правилата и нужните пакети в системния промпт или в началото на разговора.

Писане на ръка

Пишете с правилата като справка. Пуснете проверката върху готовия текст и поправете забележките. Подходящо за инструкции, монтажни схеми и спецификации.

Преработка на преводи

Подайте ръководство, преведено от английски. Получавате STB вариант, списък на промените и въпроси там, където липсва стойност или посока.

Моделите грешат. Проверявайте резултата и оценявайте ръчно правилата със ⚠. STB не заменя инженерната проверка на документ.

# Проверка на текст (Windows PowerShell)
powershell -ExecutionPolicy Bypass -File scripts\stb-check.ps1 `
  -Text "1. Затегнете гайката с 25 N·m." -Domain mechanics

Присъединете се

Търсим
съмишленици.

STB ще стане добър само ако го ползват и оспорват хората, които пишат и четат техническа документация.

  1. Следвайте проекта.

    Поставете звезда или изберете Watch в GitHub.

  2. Отворете issue.

    Предложете дума, оспорете решение, докладвайте грешка в проверката.

  3. Изпратете pull request.

    Поправете или добавете нещо сами. Упътването е в CONTRIBUTING.

  • Езиковеди и редакториПреглед на правилата и на значенията в речника.
  • Технически писатели и инженериПроверка върху реална документация: инструкции, монтаж, чертежи.
  • ПреводачиОпит с ASD-STE100 или други контролирани езици.
  • РазработчициИнструменти за автоматична проверка на текст по правилата на STB.

Лиценз

Свободно за ползване.

КаквоЛиценз
Правила, документация и речникCC BY-SA 4.0
Скриптове за проверкаMIT
Шрифт Adys на тази страницаЛицензиран отделно

Може да ползвате, променяте и разпространявате STB. Посочете проекта като източник и запазете лиценза върху производните работи. Пълният текст е в NOTICE.md.