Жаргон в технической документации (одобряем?)

[Stauffenberg]

Всем привет.

Давно хотел спросить об отношении жаргона в технической документации. Одобряем или не нравится?
Речь идет о документации не в книгах, но в блогах и других информационных online-ресурсах.

Спасибо за ответы

[SLEDopit]

Имхо, в жаргоне нет ничего плохого, если не злоупотреблять.
А то когда перебор в духе "задеплоить аппликейшн на девелопмент энвайронмент", оно немного коробит, хотя и понятно о чём речь (:

[jashaw5]

Всем привет.

Давно хотел спросить об отношении жаргона в технической документации. Одобряем или не нравится?
Речь идет о документации не в книгах, но в блогах и других информационных ресурсах.

Спасибо за ответы

Жаргон не нужен. Вообще. Ни на каких технических ресурсах.

[NickLion]

Жаргон бывает разный, и объём жаргона тоже влияет. Допустим, кликнуть — жаргон, но настолько часто используется, что не коробит. Но в больших объёмах, конечно неприятно читать. Но в особенности коробит, когда берут кальку с английского, когда есть распространённый русскоязычный термин, навроде, имадж/имэдж диска, вместо образ диска.

[Фантом]

Документация должна быть полезной и понятной. Каким образом это будет достигаться (с жаргоном или без оного) - несущественно.

[drBatty]

когда есть распространённый русскоязычный термин, навроде, имадж/имэдж диска, вместо образ диска.

Русское слово "образ" НЕ является точным синонимом слова "image". Да и вообще, "образ, точная копия" это всего лишь одно, и ИМХО не главное значение "image". Ну и потом слово "имидж" нужно признать русским и довольно распространённым, хотя оно и обозначает обычно совсем иное(как и "образ"). В данном случае без жаргона никак. (потому-что присваивание нового значения старому слову -- тоже жаргон. Например наркоманское: "план", "отъехать", "приколоться", "колючка", и т.д. Т.е. использование русского слова "образ" для disk image является тоже жаргоном, ибо не соответствует нормам языка)

Документация должна быть полезной и понятной. Каким образом это будет достигаться (с жаргоном или без оного) - несущественно.

без жаргона не получится. Даже оригинал не поможет, ибо Шекспир не делал образов HDD.

[alv]

берут кальку с английского, когда есть распространённый русскоязычный термин, навроде, имадж/имэдж диска, вместо образ диска.

Да. Вместо ихнего буржуазного слова хаб надо использовать исконно праславянский термин концентратор.
И уж как тут не вспомнить КД-ПЗУ...
Ребята, поймите: язык развивается по своим законам, и ему плевать на то, что вы все по этому поводу думаете.
Или про адмирала Шишкова напомнить?
Хотя адмирал ведь наверняка стебался... как сказали бы нынче.

Шекспир не делал образов HDD.

Если обратиться к Ромео с его Джульеттой, мы обнаружим там массу итальянских фехтовальных терминов. То есть Билл Шакспер был врагом аглицкого народного языка.

Русское слово "образ" НЕ является точным синонимом слова "image". Да и вообще, "образ, точная копия" это всего лишь одно, и ИМХО не главное значение "image".

Ага. Говорим ли мы "образ" или "имидж", вот здесь, в Zope, мы подразумеваем, что речь идёт об iso 9660
даже если это КД-ПЗУ...

[Hephaestus]

Жаргон допустим, но в меру. Такого варианта нет, посему, не голосовал.
Однако список жаргонных слов, от которых не коробит у каждого свой.

В целом, как показывает практика, без жаргона вполне можно обойтись.
Скажем, тот же disk image. Как объяснить несведущему человеку, что это за штука?
В процессе объяснения всё равно промелькнёт "образ диска" или "точная копия диска". Ну так бы и писали сразу.
Можно написать "побайтовая копия" (тут, правда, ещё придётся объяснять, что такое "побайтовая").

Больше всего коробит использование жаргона там, где есть нормальное русское слово.
Не далее как сегодня в видеоролике звучало "рандомный" вместо "случайный". При том, что ролик рассчитан на самую широкую аудиторию (не обязательно технарей).

[NickLion]

Русское слово "образ" НЕ является точным синонимом слова "image".

Не является, но для disk image используют именно образ диска. А имидж (для меня во всяком случае) в первую очередь социальный термин.

Да. Вместо ихнего буржуазного слова хаб надо использовать исконно праславянский термин концентратор.

Для данного случая есть 3 но:
1. Короткие слова будут заменять длинные почти всегда.
2. Они одинаково буржуазные.
3. Хаб используется не реже концентратора.

в видеоролике звучало "рандомный" вместо "случайный". При том, что ролик рассчитан на самую широкую аудиторию (не обязательно технарей).

Вот-вот. Хотя я сам данный жаргон, бывает, использую, но в нетехнарских текстах это действительно лишнее.

Сам я проголосовал "за", так как вопрос о технической документации. И всякие билды, репы там более менее нормально смотрятся. Но опять же, да, есть раздражающие.

[Bizdelnick]

А имидж (для меня во всяком случае) в первую очередь социальный термин.

И даже вместо него можно в большинстве случаев использовать слово "образ".

[alv]

задеплоить аппликейшн на девелопмент энвайронмент

Это не жаргон. Это просто смесь нижегородского с оксфордским. По заветам профессора Выбегаллы.

звучало "рандомный" вместо "случайный"

а рандомизацию надо называться случайнизацией?

Жаргон допустим, но в меру

Мера определяется исключительно литературным вкусом автора. Или его отсутствием.

А имидж (для меня во всяком случае) в первую очередь социальный термин.

И даже вместо него можно в большинстве случаев использовать слово "образ".

В том-то и дело, что как социальный термин он для кого образ, а для кого имидж

[Aectann]

Давно хотел спросить об отношении жаргона в технической документации. Одобряем или не нравится?
Речь идет о документации не в книгах, но в блогах и других информационных ресурсах.

В блогах каких? Если это личные блоги со статьями на определенную тему, то допустимо (хотя это и не является технической документацией). Если ресурс вроде IBM developerWorks или debian.org, то не хотелось бы.
Именно в технической документации, я считаю, он недопустим.

[Bizdelnick]

В бложиках можно писать что угодно. Если же хочется, чтобы бложек читали, следует позаботиться о том, чтобы тексты были понятны без чрезмерных напряжений мозга (то есть жаргонизмы допустимы, если они хорошо известны целевой аудитории). Что касается технической документации - ни в коем разе: она должна быть предельно точной и унифицированной и не допускать никаких двояких толкований.

[Hephaestus]

а рандомизацию надо называться случайнизацией?

А что такое рандомизация, можно узнать?

[NickLion]

А что такое рандомизация, можно узнать?

1. Процесс расстановки в случайном порядке.
2. Изъятие случайной выборки.
3. Любое другое введение случайности в что-либо.

[drBatty]

Не далее как сегодня в видеоролике звучало "рандомный" вместо "случайный".

вообще-то у этих слов совершенно разное значение, и жаль, что вам это неясно. Наверное, что-бы проще, я упомяну выражение "случайная связь", в смысле взаимоотношения полов. Случайная связь -- это когда вас случай вместе свёл, т.е. случай лишь сыграл роль катализатора, его влияние минимально, и решение за вами. Рандомная связь -- это когда вы выиграли девушку в кости, в данном случае вы ничего не решаете. В русском языке такой разницы нет, она угадывается из контекста. Но к сожалению, в технике контекст задать обычно невозможно.

Однако, статистическая разница огромна -- в технике, если процесс случайный, то практически всегда исход эксперимента предопределён, несмотря на случайное воздействие, система скатывается в состояние с меньшей энергией. Почти всегда. Т.е. если шарик поставить на вершину горки, то он покатится в ту сторону, где наклон круче. Хотя может и наоборот. Если построить карточный домик, то он рухнет. Но может и не прямо сейчас. Но очень скоро.

В отличие от этого, рандомный процесс никуда не скатывается, а ведёт себя как например идеальная монетка, т.е. вероятность исходов известна, и хорошо выполняется (монетка падает десять раз подряд решкой в каждом 1024ом случае, и чем больше кидать, тем ближе к этому).

В математике такое не изучают, но для техники это важно. Даже для IT.

Не является, но для disk image используют именно образ диска.

простите -- кто использует? Ваши коллеги?

А имидж (для меня во всяком случае) в первую очередь социальный термин.

для меня тоже. Ну и что?

а рандомизацию надо называться случайнизацией?

ослучаеванием правильнее.
только вот неблагозвучно ИМХО, то-ли осёл, то-ли случка...
потому-то ИМХО так никто и не пишет, а пишет "рандомизация"
Ну и в свете вышесказанного, рандомизация правильнее.

она должна быть предельно точной и унифицированной и не допускать никаких двояких толкований.

кто мешает вам объяснить значение термина и/или привести общепринятый англ. аналог?

А что такое рандомизация, можно узнать?

моделирование возрастания энтропии. Грубо говоря, увеличение числа состояний системы. К примеру уже выше привели: случайные перестановки отсортированного множества. В начальный момент множество имеет одно состояние (например 1,2,3,4,5), но после рандомизации оно может перейти в любое из 5!=120 разных состояний. Т.е. её энтропия увеличится от 0, до 120 состояний. Т.е. для передачи информации о том, что у нас получилось, нам потребуется почти 7 бит информации.

[Bizdelnick]

Случайная связь -- это когда вас случай вместе свёл, т.е. случай лишь сыграл роль катализатора, его влияние минимально, и решение за вами. Рандомная связь -- это когда вы выиграли девушку в кости, в данном случае вы ничего не решаете.

А что, играть в кости на девушку заставили насильно?

Однако, статистическая разница огромна -- в технике, если процесс случайный, то практически всегда исход эксперимента предопределён, несмотря на случайное воздействие, система скатывается в состояние с меньшей энергией. Почти всегда. Т.е. если шарик поставить на вершину горки, то он покатится в ту сторону, где наклон круче. Хотя может и наоборот. Если построить карточный домик, то он рухнет. Но может и не прямо сейчас. Но очень скоро.

В отличие от этого, рандомный процесс никуда не скатывается, а ведёт себя как например идеальная монетка, т.е. вероятность исходов известна, и хорошо выполняется (монетка падает десять раз подряд решкой в каждом 1024ом случае, и чем больше кидать, тем ближе к этому).

Где грибы собираете?
С каких это пор движение тела под действием силы тяжести стало случайным процессом?

кто мешает вам объяснить значение термина и/или привести общепринятый англ. аналог?

Никто. Более того, это обязательно надо сделать, если он не является общеупотребительным. И использовать только его, а не всякие синонимы, которые и есть жаргонизмы.
Да, выбор термина может быть в какой-то степени произвольным, но если он корректно определён - он не является жаргонизмом.

[drBatty]

UPD: забыл сказать, что "рандомизацию" никогда НЕ нужно переводить как "перемешивание". Разница существенна, ибо при рандомизации энтропия растёт, а при перемешивании -- нет. Т.е. перемешивание осуществляется по известным нам правилам, а рандомизация -- по неизвестным. Потому рандомизация необратима, а перемешивание обратимо. И это всё несмотря на то, что в реальном мире разницы никакой нет.

[drBatty]

А что, играть в кости на девушку заставили насильно?

естественно. Ну кто в здравом уме положится на случай в таком важном выборе?

С каких это пор движение тела под действием силы тяжести стало случайным процессом?

это случай неустойчивого равновесия. В рамках классической математики это уравнение не имеет решения. Проблемы математики, ибо шарик ведёт себя именно так, как я говорю.

[alv]

Что касается технической документации - ни в коем разе: она должна быть предельно точной и унифицированной и не допускать никаких двояких толкований.

Дело в том, что как раз так называемые жаргонизмы обычно куда однозначней их наукообразных аналогов.

Написал когда-то давно: http://alv.me/?p=1581
За прошедшие годы своего мнения не изменил. И добавить нечего.

[Hephaestus]

вообще-то у этих слов совершенно разное значение, и жаль, что вам это неясно.

Не буду с Вами спорить, скажу лишь, что в упомянутом мной ролике фраза звучит примерно так:
"водяной знак рандомально (с разными промежутками времени) выводится в разных местах экрана".
Согласитесь, что слово "рандомально" из этой фразы вполне можно выкинуть без потери смысла.
Также попадалось неоднократно слово "контент", которое опять-таки безболезненно могло быть заменено.
Вот именно такие случаи я имел в виду.

Если же термин не имеет русского аналога и в контексте конкретного документа заменить его невозможно - это совсем другое дело, но даже в этом случае необходимы какие-то пояснения, в зависимости от целевой аудитории.
Мне, например, в технической документации (да и в книгах) встречались списки сокращений и терминов, используемых в тексте. Считаю это весьма уместным, если уж без спец. терминов никак не обойтись.

[drBatty]

Написал когда-то давно: http://alv.me/?p=1581

+1

[drBatty]

водяной знак рандомально

ну это ИМХО неправильно. В данном случае использование random вообще не нужно. Тогда уж лучше слово messy использовать? :)

Согласитесь, что слово "рандомально" из этой фразы вполне можно выкинуть без потери смысла.

ИМХО нужно.

Также попадалось неоднократно слово "контент", которое опять-таки безболезненно могло быть заменено.

слово "контент" конечно можно выкинуть, но часто оно служит вполне определённым целям. Т.е. говорящий/пишущий хочет этим словом подчеркнуть отличие информации от того, что называют обычно "содержимым". Может потому, что для него содержимое не имеет никакого значения. Просто ненужный(ему) контент.

Тут вообще сложно всё очень, есть ведь не только явные жаргонизмы, но и неявные и скрытые. К примеру есть слово "контекст". Слово как слово, вроде не вчера в русском языке. А есть слово "контексты"? В CS они сплошь и рядом, но вот в русском языке я что-то не слышал.

Мне, например, в технической документации (да и в книгах) встречались списки сокращений и терминов, используемых в тексте. Считаю это весьма уместным, если уж без спец. терминов никак не обойтись.

трудоёмкое это занятие, списки составлять. Да и объёмные списки получаются.

[VAA]

Что касается технической документации - ни в коем разе: она должна быть предельно точной и унифицированной и не допускать никаких двояких толкований.

Однозначно согласен. Нравится вам терминология или не нравится - ее нужно применять для гарантии правильного понимания.
А ситуации с неудобной терминологией обходить по типу:
"Концентратор данных (далее хаб) ..."

Дело в том, что как раз так называемые жаргонизмы обычно куда однозначней их наукообразных аналогов.

Написал когда-то давно: http://alv.me/?p=1581
За прошедшие годы своего мнения не изменил. И добавить нечего.

Увы - это далеко не всегда правильно.

[lazhu]

Это просто смесь нижегородского с оксфордским.

А как назвать перевод всем понятного оксфордского firewall загадочным (не оксфордским, и уж точно не нижегородским/рязанским/магнитогорским) брандмауэром?

[NickLion]

Не является, но для disk image используют именно образ диска.

простите -- кто использует? Ваши коллеги?

Переводы в программах и документации, в интернете, коллеги, я в своей речи.

[Bizdelnick]

А как назвать перевод всем понятного оксфордского firewall загадочным (не оксфордским, и уж точно не нижегородским/рязанским/магнитогорским) брандмауэром?

Не надо его никак называть, тем более переводом. Просто мелкософт сотрудничает с очень странными переводческими конторами. (Хотя мой им респект за перевод слова browser как "обозреватель" - жаль, не прижилось.)

[Hephaestus]

трудоёмкое это занятие, списки составлять. Да и объёмные списки получаются.

Ну уж не более трудоёмкое, чем написать хороший технический текст. И не такие уж объемные эти списки по сравнению с текстом - при объеме текста в несколько десятков страниц, 2-3 страницы истратить на словарь - это совсем не много. И вроде бы составление таких словарей (глоссариев) поддаётся автоматизации. Не?

Хотя мой им респект за перевод слова browser как "обозреватель" - жаль, не прижилось.

А почему не прижилось? Вроде вполне используется.

[drBatty]

Переводы в программах и документации, в интернете, коллеги, я в своей речи.

жаргон...

Ну уж не более трудоёмкое, чем написать хороший технический текст. И не такие уж объемные эти списки по сравнению с текстом - при объеме текста в несколько десятков страниц, 2-3 страницы истратить на словарь - это совсем не много.

ну это смотря что за текст.

И вроде бы составление таких словарей (глоссариев) поддаётся автоматизации. Не?

поддаётся.

[yamah]

Жаргон на специализированных форумах - нормальное явление.
Жаргон в документациии... Э-э-э-э... Это точно документация?