Як писати статті, або Як їх краще не писати

Натрапила на статтю Михайла Купаева, головного редактора RSDN, Rutext.com/, і так мені ця стаття сподобалася, що вирішила зберегти її в особистому архіві - для загального користування.

Введення

Пошук у Google за словами "як писати статті" видає 664 сторінки. Статті з такою назвою писали шановані люди, як Г.А. Шенгелі, А. А. Шалито та ін. Але в цілому, 664 сторінки - це, звичайно, перебір. Зрозуміло, що більша частина цієї писанини вигадана людьми, писати статті не вміють. Якби вони вміли писати статті, вони їх писали б, а не вчили інших. Зізнаюся чесно - я не знаю, як треба писати статті. Зате за час свого редакторства я надивився на таку кількість потвор, якої вистачило б на пару пітерських Кунсткамер і ще залишилося б на кілька курортних виставок. Тому я досить добре уявляю собі, чого при цьому робити не потрібно. Ось про це-то я і спробую розповісти нижче.

Так починаннях, взнесшіеся потужно,

звертають свій хід,

втрачають ім'я дії ...

Вільям Шекспір.

Як правило, робота над статтею починається зі складання плану. Можна, звичайно, покластися на натхнення і писати "як піде". Однак закінчити статтю за один день мало у кого виходить. А відновити наступного дня (тим більше - через тиждень) учорашніх міркувань вдається далеко не завжди. Результат передбачуваний - оповідання, набравши розгін, звертає убік. На цьому місці половина читачів, образно кажучи, вилітає в кювет. Розповіді про складні речі взагалі личить певна плавність і поважність - тут краще орієнтуватися на "Роллс-Ройс", А не на "Феррарі".

Зрозуміло, це в основному відноситься до статей, спрямованих на поважне, всебічне висвітлення предмета. Однак щось подібне трапляється і з невеликими статтями, що розповідають про який-небудь цікавою дрібниці. Мова про авторські відступи від теми. Оскільки автор, як правило, знає страх багато, в процесі викладу йому приходить в голову аналогія, випадок з життя або дуже важливе уточнення, яким просто не можна не поділитися з читачем. Однак у процесі цього відступу від теми йому приходить в голову (див. Вище). На третьому витку стаття остаточно сходить з орбіти і мчить кудись вже сама по собі, без керма, вітрил і гальм. Зрозуміло, потім автор спохвачується і повертається до вихідної теми - але читач до цього моменту встигає забути, з чого все починалося.

Ми, ви і я

Цікаво спостерігати, як автор, почавши писати від третьої особи ("Автор вважає"), На другій сторінці з'їжджає на "Ми будемо використовувати", А через ще пару абзаців, остаточно зневірившись, каже: "візьміть ось це і викличте он те". Ні в одній з цих форм немає нічого поганого. Проте їх не варто використовувати як попало. Інакше можуть виникнути курйозні ситуації.

До речі, російська мова, на відміну від англійської, куди більш терпимо до безособових оповідних речень, що не містить особових займенників. Там, де в англійській статті неодмінно буде сказано: "You'd use it for smth.", Російська прекрасно обійдеться чимось на зразок "Це використовується так-то і так-то". Між іншим, велика кількість особових займенників чітко вказує, в якому місці автор покинув викладати предмет своїми словами і вставив величезний шматок з MSDN. Я не кажу, що це погано для суті статті, я просто хочу сказати, що це вносить стилістичний різнобій.

Пролог, епілог і дещо між ними

Введення і висновок є майже у кожній статті. Сама стаття, яка за ідеєю повинна знаходитися між ними, є не завжди - але вступ і висновок пишуть практично всі. У попередніх пропозиціях важливі слова "майже" і "практично". Насправді це означає "далеко не завжди". Трапляються статті, що обриваються на півслові, хоча не так складно, наприклад, подякувати читача за те, що він дочитав ваш опус до кінця. Повірте, це часто достойно подяки.

Епічний зачин - вірна ознака недосвідченого автора. Якщо автор починає статтю про взаємоблокування, наприклад, з того, що довгі роки Microsoft, IBM і решта Оракли билися над даною проблемою, як буржуї з Червоною Армією, значить (з імовірністю в 90%), далі він розповість нам про те, як він особисто її вирішив - і це буде черговим винаходом екіпажу, що приводиться в дію мускульною силою. Справедливості заради треба сказати, що бувають і дійсно оригінальні міркування, і навіть багато - але їх автори, як правило, скромніше.

Хочеться сказати ще й про так званий "американському" стилі - коли укладення практично дослівно повторює вступ. Американці, до речі, так пишуть нечасто, зате індуси і китайці просто обожнюють такі збочення. Не вірите - див. CodeProject. Нічого хорошого в такому дублюванні немає - кілька абсолютно непотрібних абзаців, які розповідають читачеві, про що, власне, була тільки що прочитана ним стаття. Якщо вже ви не знаєте, чим закінчити статтю, згадайте, а заради чого потрібно те, про що ви писали?

Телепатія на марші, або сага про праски

У мужик не випрасувані штани. Але праски в нього немає.

Він вирішує позичити праску у сусідки.

Йде до сусідки і по дорозі міркує:

"Зараз я прийду, попрошу праску.

Сусідка - жінка культурна, запропонує зайти, випити чаю.

Я відмовитися не зможу, зайду.

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

Запропонує чогось міцнішого - я теж не зможу відмовитися.

Так і до ліжка дійде. А я - людина порядна, доведеться одружитись, і що далі?

Пелюшки, сорочечки, лайки, розлучення ..."

З цією думкою він підходить до дверей сусідки й натискає на кнопку дзвінка.

Двері відчиняються, і чоловік випалює:

"Та пішла ти зі своєю праскою!"

(С) старий анекдот

Цей анекдот відтворюється у кожній третій статті з вступників до редакції. Дивно, але факт - серед читачів рідко трапляються пророки і ясновидці. Вони і в житті нечасто зустрічаються. Що з цього випливає? Те, що всі міркування автора повинні бути викладені повністю. Читач, як правило, не в змозі відтворити хід думок автора, навіть якщо у нього є вихідна посилка і кінцевий результат. У тому місці, де хід міркувань пропущений, читач неминуче "спотикається" - Тобто відволікається від суті статті, намагаючись зрозуміти, що мав на увазі автор. Знову включитися в оповідання йому непросто, особливо якщо стаття присвячена якомусь складному питанню. Кілька таких помилок послідовно гарантовано змусять читача кинути цю статтю.

Ще один різновид тієї ж помилки - використання що раніше не введених термінів і нерозшифрованих абревіатур. Зрозуміло, будь-яка стаття передбачає наявність у читача загальної підготовки і деяких знань з обговорюваного питання. Але краще все-таки припускати, що читач - ламер. Оскільки гуру статей все одно не читають - вони їх пишуть.

Науковий і наукоподібний

Різниця між цими термінами не менша, ніж між "людяним" і "людиноподібним". Там, де науковий стиль припускає чіткі і однозначні формулювання, наукоподібна стаття тоне в суміші невлад вставлених іноземних слів та великовагових оборотів. Там, де нормальна людина обійдеться десятком слів, автору наукоподібної статті потрібно не менше тридцяти. Замість "ця штука робить те і це" він напише "даний об'єкт при введенні в дію починає активність, обумовлена його конструкцією і вихідним призначенням". Причому зрозуміти, навіщо потрібна ця штука і що вона все-таки робить, з наукоподібної статті, швидше за все, не вийде - читач закине її раніше, ніж автор дійде до пояснень.

Крім того, науковий стиль повинен бути логічним, тобто послідовним, несуперечливим і повним. Наукоподібність найчастіше приховує недоліки викладу, підміняючи відсутність виразних передумов і пояснень заплутаними і громіздкими формулюваннями. Розрахунок, по всій видимості, на те, що читач, не розібравшись в написаному, подумає: "Розумна людина! Далеко мені до нього". Однак наш журнал (і сайт) читає чимало висококваліфікованих спеціалістів, які не піддадуться на цей прийом. Мало того, серед них напевно знайдуться фахівці саме в цій галузі, які не забаряться виступити з нищівними коментарями. Це не просто зведе нанівець можливий ефект - це його зверне в негативну величину.

Можливо, багато авторів потрапляють у пастку наукообразия не по своїй волі, а намагаючись слідувати зразкам, які вони приймають за еталон наукового стилю. Біда в тому, що вони за суть приймають форму. Дійсно гарна наукова стаття, як правило, написана простою і зрозумілою мовою.

У наукоподібного стилю є, тим не менш, незаперечне достоїнство. Якщо нормально написана стаття займає 10000 знаків, аналогічна їй наукоподібна займе не менше 25000. При визначенні гонорару така різниця більш ніж суттєво. Але тут постає питання - для чого ви пишете? А якщо вас переповнює альтруїзм і бажання наставити ближнього на шлях істинний - полюбіть його хоча б трохи, і не змушуйте продиратися крізь наукоподібний бурелом.

Локація інстанціацій криптування в кустомізованих аплікаціях

Програмування - галузь, засмічена термінологічними ляпсусами, як ніяка інша. Перераховувати ці ляпсуси можна дуже довго, втім, ви й самі легко згадаєте багато прикладів. Найбільш поширене застосування калік з англійської (від слова "калька", Але можна і від слова "каліка" - Суть не зміниться). Цей різновид потвор з'являється, коли автор у творчому пориві стахановськими темпами різьбить нетленку, думаючи:"Потім поправлю". "Потім", Як правило, настає після повернення матеріалу автору з редакторськими коментарями. Ще одне джерело - автору просто не вдається підібрати вдалий термін. І, нарешті, третій - спілкування у форумах і читання невдалих, ніким ніколи не редагованих статей в Інтернеті.

Доводиться констатувати - Internet, невичерпне джерело відомостей про все на світі, є заодно і основним джерелом словесного сміття.

Кальки, які збігаються за звучанням з наявними словами, просто неприпустимі - як, наприклад, наведена в заголовку "локація" в сенсі "місце розташування". "Локація" в російській мові - це визначення місця розташування об'єкта, тобто процес. У слова "аплікація" теж є конкретне значення в російській мові - це "спосіб створення орнаментів, зображень шляхом нашивання, наклеювання на тканину, папір і т. п. різнобарвних клаптиків будь-якого матеріалу (тканина, папір, хутро, соломка і т. п.) іншого кольору чи вичинки, а також орнамент, зображення, створені по такому способу, який придає їм особливу рельєфність - Вікіпедія". Якщо ви збираєтеся використати термін, російський аналог якого підібрати важко, не пошкодуйте часу - справьтесь зі словниками та перекладацькими сайтами (хоча б задайте питання на нашому форумі "Проблеми перекладу"), Подивіться, як цей термін перекладали до вас. Якщо словника під рукою немає, скористайтеся сайтами www.lingvo.ru, www.translate.ru і www.gramota.ru. Якщо так нічого і не знайшлося, можливо, кращим варіантом буде використовувати англомовний варіант. Пам'ятайте, що такі слова не відмінюються, але якщо це призводить до поліпшення читабельності і зрозумілості, редакція закриє на це очі. Якщо ви знайшли хороший варіант перекладу, але розумієте, що він не загальноприйнятий, і вас можуть неправильно зрозуміти, достатньо ввести його на початку статті, написавши, наприклад, що під словом "втілювати" в цій статті в подальшому буде розумітися переклад слова "instantiate". У будь-якому випадку, навіть якщо використовуваний вами переклад широко розповсюджений, наведіть при першому використанні англійський варіант в дужках. Гірше від цього не буде, а багато ще й скажуть "спасибі".

Особливий випадок представляють словосполучення. Наприклад, "key container" - Це "сховище ключів" або, якщо завгодно, "контейнер ключів". Але ніяк не "ключовий контейнер". "Ключовий" - Це "має ключове, першорядне значення", А "ключовий контейнер" - Це "головний, який має ключове значення, контейнер". Подібні помилки зустрічаються досить часто, в основному через спроби дослівного перекладу англомовної фрази. Наприклад, "default value" регулярно намагаються перекласти як "умолчальне значення". У російській мові немає слова "умолчальне", Правильніше, звичайно, використовувати "значення за замовчуванням", Але часто і цього буває недостатньо. Ось простий приклад:

SQL Server sets the referencing column values of the related rows in the referencing table to the default value of the column.

Неправильний переклад:

SQL Server встановлює значення відповідних строк колонки в значення колонки за замовчуванням.

Тут легко плутається "значення, використовується у цій колонці за замовчуванням" і "значення колонки, використовуваної за замовчуванням".

Тому правильніше буде написати пару зайвих слів:

SQL Server встановлює значення відповідних строк колонки в значення, яке використовується в цій колонці за замовчуванням.

Однак перекладом справа не обмежується. Є маса термінів, які люди бездумно вживають разом, не піклуючись про значення отриманого кадавра. Наприклад, поєднання двох цілком осмислених окремо, може стати абсолютно безглуздим. Результат приголомшує - всі слова в реченні зрозумілі, але зрозуміти пропозиція не вдається!

Редакційному коментарі І ПРАВКА

До речі, про редакторські коментарі. Редактор - це професійний читач. Він не менше учасника хоче, щоб стаття вийшла хорошою, і зовсім не зацікавлений у різного роду суперечках і конфліктах з автором. Якщо редактор прислав багато коментарів - значить, він просто сумлінно ставиться до своїх обов'язків. Заперечувати редактору безглуздо - ви не зможете так само заперечити усім читачам, а у багатьох з них, повірте, виникнуть ті ж питання, що і у редактора. Точно так само не потрібно пояснювати щось нерозумному редактору - пояснювати треба читачеві.

Трапляється так, що автор ображається на зауваження редакції чи вважає питання редакторів відверто дурними. Повторюся: редактор - це перший читач вашої статті. Тільки це за визначенням прискіпливий читач. Він може чудово розуміти, що хотів сказати автор, але він так само відмінно бачить, що необізнаний читач це місце статті не зрозуміє. А якщо і редактор не розуміє написаного, швидше за все, це місце не зрозуміє більшість читачів. Нормальна реакція на коментарі - виправлення статті. Якщо ви не розумієте, що і як слід змінити, спробуйте "на пальцях" пояснити редактору у коментарі відповіді, що ви намагалися сказати, і він спробує підібрати потрібні слова.

ПРИМІТКА

Чи не пояснюйте редактору те місце, яке він не зрозумів. Виправте це місце у статті так, щоб його зрозумів будь-який читач.

І ще одне. Дорогі колеги, ми намагаємося бути в коментарях гранично ввічливими і коректними, але виходить не завжди. Тому, зустрівши єхидний коментар редактора, спробуйте уявити, що в цьому місці скаже простий читач, не пов'язаний вимогами пристойності.

Обсяг журнальної статті ...

Цей стандартний початок зазвичай триває словами "... Не дозволяє розкрити тему у всій повноті" або подібними до них. Найчастіше цими словами відмічають або те місце, де автору стало лінь писати далі, або границю його знань. Насправді редакція ніколи не відкине добру велику статтю - скоріше її розіб'ють на декілька частин і будуть публікувати з продовженням. Тому залиште цю фразу мені для службового користування. Я її вставлю в тому місці, де визнаю, що автор елементарно забазікався.

Орфографія і пунктуація

Орфографія і пунктуація - це, звичайно, турбота редактора і коректора. Але в спеціалізованих виданнях з грамотністю, як ви можете бачити на багатьох прикладах, аж ніяк не так добре, як у суспільно-політичних і навіть науково-популярних. Проблема в тому, що коректор багато термінів бачить у перший раз, а не розуміє практично все. Тому він їх або не виправляє, сподіваючись на редактора, або - що ще гірше - править за власним розумінням. Редактор, у свою чергу, все розуміє, але сподівається на коректора.

Особливо схильні до цієї напасті коментарі в коді і ілюстрації - тому що їм перепадає найменше уваги. Усі вважають, що це не по їх частини. Науковий редактор вважає, що все, що по-російськи - це до літературного, літературний - що код в провадженні наукового, а ілюстрації - це взагалі художнику, коректор же обачно взагалі не торкається ані коду, ні картинок - від гріха подалі. Результат може бути вкрай невтішним. Тому не вважайте, що редакція виправить всі ачіпяткі і проставте усі коми. Згадайте, що все-таки ви пишете рідною мовою, і поставтеся до нього, як рідного. До речі, "ви" в російській мові пишеться з великої літери тільки при особистому зверненні.

Коректність висновків

Статті, пов'язані з програмуванням - це суто технічні статті, якщо вони, звичайно, не відносяться до розділу "Колеги, посміхніться". Питання віри в цих статтях недоречні. Якщо ви робите якесь твердження, воно повинно бути належним чином обгрунтоване - тестами, замірами або логічними висновками.

Масштаб

Якщо ви вирішили щось звеличити, або, навпаки, вважати суттєвим недоліком, подумайте, наскільки це вплине на кінцевий результат. Часто буває так, що автор, зачепившись за, в цілому, неважливу річ, робить з мухи слона, або представляючи її як панацею, або, навпаки, влаштовуючи над нею велике судилище. Між тим, факт може бути шага не вартий на фоні інших переваг і недоліків описаної технології, мови або платформи.

Велосипед

"Я знайшов, як застосувати тут не стираються шини з

поліструктурного волокна з виродженими амінними зв'язками

і неповними кисневими групами.

Але я не знаю поки, як використовувати регенеруючий

реактор на субтеплових нейтронах. Миша, Мішок! Як бути з реактором?"

Придивившись до пристрою, я без праці дізнався велосипед.

А. і Б. Стругацькі, Понеділок починається в суботу.

Це славне пристрій для переміщення в просторі вже згадувалося вище, але повторитися все ж варто. Якщо вам прийшла в голову геніальна ідея, до якої поки не додумався ніхто інший, не поспішайте створювати трактат на цю тему. Перевірте - можливо, ця ідея прийшла в голову не тільки вам. Наприклад, викладіть її коротко в форумі з відповідною тематикою. Якщо ідея не нова, ви дізнаєтеся про це буквально за день-другий - у нас повно бажаючих крикнути "Баян" з приводу.

Те, що ваша ідея виявилася не тільки вашої, ще не означає, що ваші міркування не мають жодної цінності. Часто буває так, що людина, яка обмірковує "з нуля" щось вже відоме, знаходить власний неординарний погляд на проблему. Це може виявитися цікавим для читачів.

Не бійтеся, що вашу ідею вкрадуть. Якщо ви все ж побоюєтеся злих конкурентів, запатентуйте ідею. Але в цьому випадку вам все одно доведеться доводити її новизну.

Висновок

Всі наведені помилки типові, що викорінити їх не вдасться ані одною, ні шестисот шістдесятьма чотирма, згаданими у вступі. Однак якщо після цієї статті комусь прийде в голову перед відправкою в редакцію свою статтю ще раз і що-небудь виправити в ній, я вважатиму своє завдання виконаним - адже це хоча б трохи зменшить кількість читацьких спогадів про найближчих родичів автора, редактора та моїх особисто.

Михайло Купала, головний редактор RSDN, Rutext.com/

проект SEONEWS.RU