О нечестных приёмах в технических статьях — первая часть
Разрешите предложить перечень некоторых приемов, на которые часто обращаешь внимание при редактуре технических статей.
1) Доказательство заменяется метафорой
Сначала некоторый важный для статьи объект сравнивается с другим, часто из смежной области; затем очевидные читателю свойства второго объекта переносятся на первый.
При выборе инструментов и политик, а также правильного времени их внедрения, уместна аналогия с кессонной болезнью – эффектом, который возникает при слишком быстром подъеме на поверхность с большой глубины. [… ] Известны только два решения – постепенный многочасовой подъем или быстрый подъём с последующей акклиматизацией на поверхности, но уже в барокамере. Поскольку обычные проекты не избалованы бюджетом для покупки “барокамер”, будем рассматривать только первый рецепт.
http://experience.openquality.ru/software-configuration-management/
В приведенном отрывке из статьи об управлении проектами читателю сообщаются некоторые (по всей видимости, верные) факты о способах лечения кесонной болезни. Эти факты легко верифицируемы и достаточно правдоподобны, и автор, пользуясь тем, что читатель расслаблен, быстро производит перенос на управление проектами. Так он избегает большого куска работы, а читатель не задает лишних вопросов.
— Почему если кесонная болезнь лечится двумя способами, то и при выборе инструментов для проекта способов всего два?
— Даже если предположить, что их два, почему один дорогой, а другой дешевый? Если рассматривать приведенный отрывок, такой вывод можно сделать исключительно из распределения цен на способы лечения кесонной болезни.
— Почему, собственно говоря, «аналогия уместна»? Так как она уместна, два способа лечения болезни соответствуют двум тактикам в управлении проектами, но именно это соответствие и должно было продемонстрировать (будь оно доказано), что сравнение обоснованно, не правда ли?
Рецепт: у A и B совпадает свойство Ai, B обладает свойством Bi, значит и A обладает свойством Bi.
2) Один из выводов представлен данностью
Несколько тезисов верны, если верен один. Первый проходится быстро, после чего внимание читателя фокусируется на подробном разборе остальных.
Представьте ситуацию. Вы со своей командой, после очередной итерации, обсуждаете слабое покрытие кода тестами и решаете что с понедельника текущего момента все пишут тесты. […] Приходит время следующего собрания на котором во время вопроса «а как у нас с тестированием» большинство отводит глаза. […] Другая ситуация. Для проекта понадобилась система прав доступа и ее реализовал один из участников команды. […] Ее начинают активно использовать и спустя какое-то время замечают, что […] код запутывается, появляется много дублирования. […] Что объединяет эти ситуации? Недостаточный контроль за процессом. Контролировать можно совершенно по разному и ниже я хочу поделиться своими мыслями по поводу того как лучше это делать и почему.
Не совсем ясно из чего именно вытекает, что приведенные ситуации объединены недостатком контроля. Автор настолько сильно хотел поговорить о контроле, что ввел его в статью искусственно. Теперь, после того, как читатель поверил в то, что заманившие его практические проблемы разрешимы (они возникли из-за недостатка контроля, а статья о нём!), он может читать дальше и надеяться на то, что описываемые там методы действительно будут приложимы к приведенным ситуациям.
В статье, из которой я привел отрывок, увы, так и не становится ясно, как предлагаемые приемы контроля способны повлиять на примеры из введения.
Рецепт: Очевидно, A. Следовательно B, C и D.
3) Доказательство заменяется типологией
Вместо того, чтобы доказывать тезис, предлагается некоторая типология, то есть классификация. Поскольку читатель редко думает о том, насколько классификация полна, верифицируема и т.п., на ее основе довольно легко произвести нужный автору логический переход.
Ежедневно каждый из нас принимает решения. Принятие решений — это один из важнейших видов деятельности человеческого мозга […]
У решения можно выделить:
- Стоимость (затраты) решения — негативные факторы, связанные с решением.
- Выгода (выгодность, прибыль) решения — соответственно, позитивные факторы, связанные с решением.
- Цена решения — соотношение стоимости и выгоды, при которых решение принимается.
Большинство решений принимаются человеком спонтанно, то есть без анализа ситуации. Причиной этого является сильное преобладание выгодности решения над стоимостью.
Тезис, который хорошо бы обосновать — «большинство решений принимается спонтанно» (поскольку отрывок приведен из статьи, где предлагается продукт для неспонтанного принятия решений). Он доказывается так: ежу понятно, что решения принимаются спонтанно, так как выгода преобладает над стоимостью. При этом выгода и стоимость — это введенные автором термины из его же типологии, которая может быть неполна или просто неверна. Но поскольку типологии не принято обосновывать — они как бы есть — то на них можно опереться чтобы протолкнуть свой тезис.
Частный пример рецепта: A делится на B, C и D. Так как Ai — свойство A, то оно свойство либо B, либо C, либо D. (А не, например, E, которое не вошло в типологию).
