Як не слід писати статті
Автор: Микола Купаєв (Kupaev)
The RSDN Group
Джерело: RSDN Magazine #6-2004
Опубліковано: 14.03.2005
Виправлено: 01.06.2005
Версія тексту: 1.0
Переклад: Lucifer 18.11.2005
Оригінал можна знайти тут.
- Вступ
- Ми, ви та я
- Пролог, епілог та дещо між ними
- Телепатія на марші чи сага про праски
- Науковий та наукоподібний
- Локація інстанціацій криптування у кустомізованих аплікаіях
- Редакційні коментарі та правка
- Об'єм журнальної статті ...
- Орфографія і пунктуація
- Коректність виводів
- Тести
- Масштаб
- Велосипед
- Висновок
Якщо час, витрачений на написанні і читання статті, константа,
то левова частка його повинна бути витрачена Пісьменником
А.А.Шалито
Вступ
Пошук у Googe за словами «як писати статті» видає 664 сторінки. Статті з такими назвами писали такі шановні люди, як Г.А.Шенгелі, А.А.Шалито та інші. Але в цілому, 664 сторінки – це, безперечно, перебір. Зрозуміло, що більша частина цього моря писанини вигадана людьми, які не вміють писати статті. Якщо б вони вміли писати статті, вони б їх писали, а не навчали інших. Чесно кажучи – я не знаю, як слід писати статті. Зате за той час, що я був редактором, я надивився на таку кількість потвор, якої вистачило б на декілька ленінградських Кунсткамер та ще залишилося б на декілька курортних виставок. Тому я достатньо добре уявляю собі, чого при цьому робити не слід. Ось про це я і спробую розповісти нижче.
Так починання, вознесені потужно,
звертають в сторону свій хід,
втрачають ім'я дії ...
Шекспір
Як правило, робота над статтею починається з складання плану. Можна, звичайно, покластися на натхнення і писати «як піде». Однак закінчити статтю за один день мало в кого вдається. А відновити наступного дня (тим більше – через тиждень) послідовність вчорашніх міркувань вдається далеко не завжди. Результат передбачуваний – оповідання, набравши розгін, звертає в сторону. На цьому місці половина читачів, образно кажучи, вилітає в кювет. Розповіді про складні речі взагалі личить якась плавність і поважність – тут ліпше орієнтуватися на «Роллс-Ройс» ніж на «Феррарі».
Певна річ це в основному стосується до статей, які орієнтовані на поважне, всебічне освітлення предмету. Однак дещо подібне трапляється і з невеликими статтями, які розповідають про якийсь цікавий дріб'язок. Мова про авторські відступи від теми. Оскільки автор, як правило, людина, яка знає страх як багато, під час викладення йому приходе в голову аналогія, випадок з життя чи дуже важливе уточнення, яким просто не можна не поділитись з читачем. Однак у процесі цього відступу від теми йому приходить в голову (дивись вище). На третьому витку стаття остаточно сходе з орбіти і мчить кудись вже сама по собі, без керма, вітрил та гальм. Авжеж, потім автор спохвачується і повертається до вихідної теми – але читач до цього моменту встигає забути, з чого все починалося.
Вгору
Ми, ви та я
Цікаво спостерігати, як автор, який почав писати від третьої особи («Автор вважає»), до другої сторінки з'їжджає на «Ми будемо використовувати», а через ще декілька абзаців, остаточно впавши в відчай, каже: «візьміть ось це та викличте он те». В жодній з цих форм нема нічого поганого. Однак їх не слід використовувати як попало. Інакше можуть виникнути курйозні ситуації.
На відміну від англійської мови українська більш терпима до безособових оповідних речень, які не містять особових займенників. Там, де в англійський статті обов'язково буде сказано: «You'd use it for smth.», українська прекрасно обійдеться чимось на кшталт «Це використовується так-то і так-то». Поміж іншим, численність особових займенників чітко вказує, у якому місці автор покинув викладення предмету своїми словами і вставив величезний клапоть з якогось джерела. Я не кажу, що це погано для суті статті, я просто хочу сказати, що це вносить стилістичний різнобій.
Вгору
Пролог, епілог і дещо між ними
Вступ і висновок є майже у кожній статті. Сама стаття, яка за ідеєю повинна знаходитись між ними, є не завжди – але вступ і висновок пишуть практично всі. У попередніх реченнях важливі слова «майже» і «практично». На справді це означає «далеко не завжди». Трапляються статті, що обриваються на півслові, хоч не так складно, наприклад, подякувати читачеві за те, що він дочитав ваш опус до кінця. Повірте, це часто достойно подяки.
Епічний зачин – вірна ознака недосвідченого автора. Якщо автор починає статтю про взаємоблокування, наприклад, з того, що довгі роки 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 встановлює значення відповідних строк колонки, що посилається у значення, яке використовується в цій колонці за умовчанням.
Однак перекладом справа не обмежується. Є багато термінів, які люди бездумно використовуються разом, не турбуючись по значення отриманого кадавру. Наприклад, сполучення двох термінів, які цілком усвідомлюються окремо, може стати абсолютно безглуздим. Результат приголомшуючий – усі слова у реченні зрозумілі, але зрозуміти речення не вдається!
Вгору
Редакційні коментарі і правка
До речі, про редакторські коментарі. Редактор – це професійний читач. Він не менш за автора бажає, щоб стаття вийшла доброю, і відповідно незацікавлений у різного роду суперечках і конфліктах з автором. Якщо редактор прислав багато коментарів – значить, він просто сумлінно відноситься до своїх обов'язків. Заперечувати редактору безглуздо – ви не зможете так же заперечити усім читачам, а у багатьох з них, повірте, виникнуть ті самі питання, що й у редактора. Точно також не слід пояснювати щось нерозумному редактору – пояснювати слід читачу.
Трапляється так, що автор ображається на зауваження редакції, чи вважає питання редакторів відверто глупими. Повторю: редактор – це перший читач вашої статті. Лише він, за визначенням, причепливий читач. Він може прекрасно розуміти, що бажав сказати автор, але він також відмінно бачить, що необізнаний читач це місце статті не зрозуміє. А якщо і редактор не розуміє написаного, скоріш за все, це місце не зрозуміє більшість читачів. Нормальна реакція на коментарі – виправлення статті. Якщо ви не розумієте, що і як слід змінити, спробуйте «на пальцях» пояснити редактору у коментарі відповіді, що ви намагались сказати, і від спробує підібрати потрібні слова.
ПРИМІТКАНе пояснюйте редактору те місце, яке він не зрозумів. Виправте це місце у статті так, щоб його зрозумів будь-який читач.
І ще одне. Дорогі колеги, ми стараємось бути у коментарях гранично ввічливими і коректними, але не завжди виходить. :( Тому, зустрівши єхидний коментар редактора, спробуйте уявити, що в цьому місці скаже простий читач, на зв'язаний вимогами пристойності.
Вгору
Об'єм журнальної статті ...
Цей стандартний початок за звичай продовжується словами «... не дозволяє розкрити тему у всій повноті» чи чимось подібним. Частіше за все цими словами відмічають або те місце, де автору стало лінь писати далі, або границя його знань. На справді редакція ніколи не відкине добру велику статтю – скоріше її розіб'ють на декілька частин і будуть публікувати з продовженням. Тому залиште цю фразу мені для службового використання. Я її вставлю у тому місці, де визнаю, що автор елементарно забазікався.
Вгору
Орфографія і пунктуація
Присвячується VladD2
Орфографія і пунктуація – це, певна річ, турбота редактора і коректора. Але у спеціалізованих виданнях з грамотністю, як ви можете бачити на багатьох прикладах, не так добре, як в загально-політичних і навіть науково-популярних. Проблема у тому, що коректор багато термінів бачить у перший раз, а не розуміє практично всі. Тому він їх або не виправляє, сподіваючись на редактора, або – що ще гірше – виправляє по своєму розумінню. Редактор, у свою чергу, все розуміє, але сподівається на коректора. Особливо схильні цій напасті коментарі у коді і ілюстрації – тому що їм випадає менше всього уваги. Всі вважають, що це їх не стосується. Науковий редактор вважає, що все, що українською – це до літературного, літературний – що код в провадженні наукового, а ілюстрації – це взагалі художнику, коректор же обачно взагалі не торкається ані коду, ані малюнків – від гріха подалі. Результат може бути дуже невтішним. Тому не вважайте, що редакція виправить усі ачіпяткі і проставить усі коми. Згадайте, що все ж таки ви пишете рідною мовою, і віднесіться до неї, як до рідної. До речі, «ви» пишеться з великої літери лише при особистому зверненні.
Вгору
Коректність виводів
Статті, пов'язані з програмуванням – це суто технічні статі, якщо вони, звичайно, не відносяться до розділу «Колеги, посміхніться». Питання віри в таких статтях недоречні. Якщо ви робите якесь твердження, воно повинно бути належним чином обґрунтовано – тестами, замірами чи логічними виводами.
Вгору
Тести
Багато авторів, виконуючи в статтях порівняння будь-яких продуктів, підходів чи алгоритмів, вважають свої тести до того тривіальними, що навіть не замислюються про можливість банальних помилок в цих тестах. Тому вони не перевіряють свій код. Однак практика показує, що імовірність помилки у, здавалося, елементарних випадках, дуже висока. Властивість помилятись притаманна кожній людині, і виключень тут нема. Щоб уникнути таких ситуацій, слід не просто перевірювати працездатність тестів, але і будувати їх так, щоб мати можливість легко порівняти правильність виданих результатів. Наприклад, якщо ви порівнюєте продуктивність двох засобів розробки, скажімо, компіляторів у цілочислових операціях, ліпше за все підібрати добре відомий алгоритм, який на виході дає більш-менш добре відомий результат. Так, алгоритм розрахунку числа Пі наперед відомий повинен видавати число Пі, а не щось інше.
При перевірках результату теж необхідна обачність. Помилки можуть міститись не в самих алгоритмах, а в супутньому коді, який використовують ці алгоритми. Наприклад, якщо ви тестуєте швидкість сортування і використовуєте для цього зовнішні об'єкти чи функції-компаратори, помилка може міститись в одному з методів порівняння. Перевірка результату, зроблена за допомогою того ж самого компаратору, скоріш за все, не виявить проблеми. Тому перевірку результатів ліпше виконувати за допомогою окремого коду, якщо можливо не використовуючи ніяких зовнішніх компонентів. У згаданому випадку сортування оптимальною перевіркою буде банальний цикл, який перевіряє, що кожен наступний елемент більше попереднього, і який обчислює контрольну суму, яку можна зіставити з контрольною сумою, яка обчислена для не відсортованого масиву.
Пам'ятайте про те, що на тест можуть впливати невраховані зовнішні умови. Невраховані тому, що автор на момент створення тестів не здогадувався про їх існування. Можливо, ви будете здивовані, але перешкодами можуть опинитися такі речі, як оптимізації, які виконуються сучасними процесорами. Наприклад, спроба замірити швидкість виклику функції інтерфейсу шляхом виклику її в циклі, скоріш за все, на дасть жодних розумних результатів. Справа у тому, що навіть якщо такий виклик не буде усунуто розумним компілятором з оптимізацією, на його швидкість все одно вплине оптимізація, яку виконує процесор. Сучасні процесори містять механізм передбачення галуження, який прекрасно працює при таких тестах, але безсилий, коли виклик такої функції зустрічається у звичайному коді. Виходом з такої ситуації може бути підбір алгоритму, який інтенсивно використовує віртуальні виклики.
Загалом, підходьте до своїх тестів критично, намагайтесь перевіряти все, навіть найменш імовірніші, припущення і, ліпше за все, створюйте декілька варіантів тестів для одного аспекту, що тестується.
Вгору
Масштаб
Якщо ви вирішили щось звеличити, чи навпаки, вважати суттєвим недоліком, подумайте, наскільки це вплине на кінцевий результат. Часто буває так, що автор, ухопившись за, у цілому, неважливу річ, робить з мухи слона, або представляє її як панацею, або, навпаки, будує над нею велике судилище. Між тим, факт може бути шага не вартий на фоні інших переваг і недоліків описаної технології, мови чи платформи.
Вгору
Велосипед
«Я знайшов, як застосовувати тут шини, які не стираються, з
поліструктурного волокна з виродженими аміними зв'язками
і неповними кисневими групами.
Але поки не знаю, як використовувати регенеруючий
реактор на субтеплових нейтронах. Міша, Мішок! Як бути з реактором?»
Придивившись до пристрою, я без труда впізнав велосипед.
А. і Б. Стругаціький «Понеділок починається в суботу»
Цей славний пристрій для переміщення у просторі вже було згадано вище, але повторити вже ж слід. Якщо вам в голову прийшла геніальна думка, до якої поки що не додумався ніхто інший, не поспішайте створювати трактат на цю тему. Перевірте – можливо, ця ідея прийшла в голову не лише вам. Наприклад, викладіть її стисло в форумі з відповідною тематикою. Якщо ідея не нова, за день-два ви про це дізнаєтесь.
Те, що ваша ідея опинилась не лише вашою, ще не означає, що ваші міркування не мають жодної цінності. Часто буває так, що людина, яка обмірковує «з нуля» щось вже відоме, знаходить власний неординарний погляд на проблему. Це може опинитись цікавим читачам.
Не бійтеся, що вашу ідею вкрадуть. Якщо ви все ж таки побоюєтесь злих конкурентів, запатентуйте ідею. Але у цьому випадку вам все одно буде необхідно доказати її новизну. :)
Вгору
Висновок
Усі наведені помилки до того типові, що викорінити їх не вдасться ані одною, ані шістсот шести десятьма чотирма статтями, згаданими во вступі. Однак якщо після цієї статті комусь прийде в голову перед тим, як надіслати в редакцію свою статтю, прочитати її ще раз і щось в ній виправити, я вважатиму своє завдання виконаним – це хоч трохи зменшить кількість згадувань читачем близьких родичів автора, редактора і моїх особисто.