[docs] О литературной правке ( было: ALT packaging docs)

[Andrey Orlov]

On Tuesday 16 November 2004 14:12, Kirill Maslinsky wrote:
> > Сама литературная правка, знаете ли, тоже. С бытующей в рашн-комьюити политикой пафосного отношения к документации -
> > когда оттуда удаляются все мало-мальски скользкие и личные выражения, сленг и все остальное, после чего из него

> Дабы вести разговор о правке конкретно, я перечёл документацию из rpm-build-python, и посмотрел, 
> что бы мне хотелось в ней изменить при публикации в  книжке alt-docs-devel. 

Некорректный пример. Если вы посмотрите changelog, то увидете, что литературная правка, 
силами добровольцев, уже была. Кроме того, он изначально писался под то, что такая правка
будет  - т.е. нудным и тухлым: все-таки не первый раз, приходится уважать традиции.

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

Я думаю, что их там несколько десятков. Это не совсем литературная правка.

> Есть слово "чбы",  
> которое я бы, грешным делом, заменил на "чтобы", хоть оно и яркий маркер 
> авторского стиля,

Сожалею, копирайт не мой.

> но всё же не единственный, и, я надеюсь, не самый дорогой 
> автору ;)

Зря надеятесь. Почитайте на досуге багзиллу. Кстати, NS его, вроде, везде 
исправил? Вы какую версию смотрели?

> Что касается жаргона, то ничего криминально-жаргонного я в Ваших текстах 
> не встретил, и почти все термины у Вас, кстати, переведены. Кроме того,

Вам просто повезло. Кроме того, то, что я следую некоторой (неформализованной) полиси,
еще не значит, что я ее одобряю.

> некоторая специальность текста не противоречит идее книжки: она же адресована
> разработчикам или будущим разработчикам, т. е. достаточно хорошо владеющим
> жаргоном людям, иначе они бы даже не взялись становиться разработчиками.
> Вот если бы речь шла о документации для пользователя, то никакая жаргонность
> была бы неуместна, просто потому что текст в этом случае становится совершенно
> непонятным пользователю, хоть и кажется совершенно ясным специалисту. 

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

...Пропущу грубую экстраполяцию и сведу к абсурду: через некоторое время потребуется переводчик,
чбы пользователи компьютерных систем общались с техподдержкой. Потом локализацию введем: русский
для пользователей и русский для саппорта. Это ваша цель?
Мне кажется, что в современном мире нужно вкладывать максимум усилий в языковую унификацию,
а не создавать проблему, там, где ее сейчас нет. Обучить пользователя (возможно) неблагозвучному
жаргону - более простое решение. Мы же все согласны, что пользователь должен осваивать инструментарий 
труда за компьютером. Компьютерный жаргон - это тот же инструментарий. Такой же незаменимый, как 
шелл ;). Но что-то тут политика иная: какие-то двойные, прям, стандарты ;). 

> Не могу согласиться с Вашим огульным осуждением редактуры, как 
> "иссушающей" текст. Обилие разговорных (личных) и жаргонных выражений нередко 
> свидетельствует не о блестящем и лёгком авторском стиле, а наоборот, о 
> недостаточном владении регистром письменной речи. Обычно такой текст 
> ещё и малопонятен неподготовленному читателю. Желание редактора это

Пардон. Малопонятный текст свидетельствует о недостаточном владении, и, иногда,
изобилует  разговорными выражениями. Вы же не будете утверждать, что хорошо понятный 
неподготовленному читателю текст, изобилующий разговорными и личными выражениями, 
свидетельствует о недостаточном владении регистром письменной речи? А ваше утверждение
допускает такую формулировку.

> исправить вполне оправданно, а если стиль действительно есть, уверяю Вас, 
> редактор не станет его искоренять. Но, понятно, что это идеальный редактор, 
> которого в природе нет. 

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

> Приведу одно предложение из Вашего текста, которое мне бы хотелось перестроить:

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

> С первого прохода не понять, приходится перечитывать, чтобы вникнуть. Скорее 

Есть такой момент.

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

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

> Противник ли Вы и такой правки? 

Приведите ваш вариант? 

> > Насколько я готов включать результат такой правки в текст - я, честно говоря, не знаю.  Иногда меня удается убедить. 
 
> А после этого описания задач правки? 

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

> Впрочем, с Вашим текстом проблем
> действительно почти нет, однако мне было важно продемонстрировать необходимость
> правки в общем случае.

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

> > > > 4. Python-полиси содержит явные и неявные ссылки на другую аналогичную документацию, в частности из пакета rpm/rpm-build. Будет ли
> > Для этого их нужно позиционировать. Для этого нужно чбы было общедоступное место,
> Вообще таким общедоступным местом должен стать alt-docs-devel. На него 

Что-то у меня создается такое ощущение, что моей головой хотят проломить стену. Имейте ввиду, что
если на python-policy я пошел добровольно, то на этот раз это дохлый номер ;)). В данном случае, я пойду
только следом за каким-то авторитетом, который будет ломать стены сам: я не против того, чбы поздравить победителя, но это не моя
война ;)

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

Это не является python-специфичным. Чгря, по-моему это стоит попробовать адаптировать к повсеместному введению, а раз так - то это
текст для другой полиси, которая, я надеюсь, когда-либо все-таки появится.

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

-- 
WthBstRgrds -- Андрей Орлов --  
 --- http: www.neural.ru, mail: cray на neural.ru, jid: cray на altlinux.org ---
----------------------------------------