Всё для технического документирования
+7 (495) 001-40-42
Разработка технической документации
Курсы для технических писателей
Программное обеспечение

Эксперты без купюр

02.10.2013

01Представляем статью американского эксперта по документированию, посвящённую его личному опыту общения с экспертами, с которыми приходится работать каждому профессиональному техническому писателю.


Допускаю, что я не всё знаю о специалистах-экспертах, или SME. Но я точно знаю, что есть некоторые вещи, которые вы должны избегать спрашивать у экспертов, особенно «Пользователь это уже знает?» и «Должен ли я объяснить это пользователю?»

Проблема с этими вопросами заключается в том, что т.к. эксперты склонны верить, что все знают столько же о технологиях, сколько они, то они обычно отвечают «Да!» на первый вопрос и «Нет!» на второй, а на самом деле всё должно быть наоборот. Метод технического писательства: Нет, пользователь ещё этого не знает и да, вы должны объяснить это пользователю.

Никогда, никогда, никогда не позволяйте экспертам говорить вам, как писать документацию. SME – это эксперт в своей области, не эксперт по документации (как вы).

Несмотря на то, что вы – эксперт в документации, пожалуйста, не позволяйте этому факту вас опьянить. Я говорю это, потому что некоторые технические писатели создают нам репутацию несносных всезнаек, и вы не хотите быть одним из них. Если эксперт настаивает на том, чтобы вы включили что-то в документацию, а вы уверены, что это там не нужно, просто улыбнитесь и поблагодарите эксперта за совет! Нет необходимости спорить или указывать на то, что вы эксперт по документации. Прежде всего, вы обидите эксперта, человека, который только что уделил час или два своего времени, терпеливо отвечая на все ваши вопросы; плюс к тому, вы только что могли решить, поразмыслив, что и в самом деле должны включить этот кусок информации.

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

Я недавно размышлял об экспертах. Я писал документ об унифицированном языке моделирования (UML) и рациональном едином процессе (RUP) и удивлялся: «Что, если начинающий технический писатель спросит меня об UML и RUP?» Я понял, что уставлюсь беспомощно на этого новичка на несколько мгновений, когда попытаюсь сформулировать свой ответ. Бедный новичок может интерпретировать мой отсутствующий взгляд как показатель того, что я нахожусь в присутствии воплощённой глупости, когда на самом деле я бы попытался понять, с чего лучше начать. Эти размышления привели меня к небольшому пониманию. Возможно, все те отсутствующие взгляды, которые я получал годами, совсем не были выражением мыслей экспертов о моём интеллекте; возможно, они просто пытались понять, с чего начать отвечать на мои вопросы.

Я заметил различие в том, как женщины и мужчины-эксперты отвечают на вопросы. Если женщина-эксперт не знает ответа на ваш вопросы, она обычно говорит «Я не знаю». Если же мужчина-эксперт не знает ответ на ваш вопрос, он обычно пытается всё равно что-то сказать. Это создаёт небольшие проблемы, потому что некоторые из их ответов окажутся неверными.

Хотя я ничего не знаю о психологии, всё же верю в то, что когда эксперт даёт вам неверный ответ, он не пытается вас ввести в заблуждение, но возможно, что он:

а) на самом деле хочет помочь вам

б) не может пересилить себя сказать слова «Я не знаю»

в) не хочет показаться неосведомлённым после того, как вы выбрали его на роль «эксперта»

г) ?

Я также заметил, что мужчины и женщины-писатели добираются до экспертов по-разному. Если женщины-писатели обычно идут в офис к эксперту, чтобы задать вопросы, то мужчины-писатели обычно просят экспертов зайти в их офис. В книге «Разговоры с 9 до 5» Дебра Таннен (Deborah Tannen) говорит о том, что многие мужчины чувствуют, что «запрос инструкций или просьба какой-либо помощи опускает их на позицию ниже» (стр. 24) Думаю, что пойти в офис эксперта и задать вопросы, должно быть, то же самое, что и остановить машину и спросить, как проехать.

Техника, которую вы используете для интервьюирования экспертов, приходит вместе с вашим опытом дипломатически вести дела с людьми. Определённо, ваши навыки интервьюирования развиваются и улучшаются со временем.

Одна вещь в экспертах, которая раньше вводила меня в замешательство, заключалась в том, что, за исключением руководства, очень немногие из них могут рассказать вам, как та часть, над которой работают они, работает с остальными, и как части, которые разрабатывают другие, работают с их частью. Я прихожу к выводу, что причина этого в том, что каждый разработчик обычно работает только над незначительной частью приложения. Это означает для меня, что просить разработчика рассказать вам, как работает всё приложение – это примерно как спрашивать каменщика о том, как устроено всё здание. Часто системный архитектор – единственный человек, который может рассказать вам, как эта штука работает полностью.

Источник: SMEs in a Nutshell

Тэги: , ,

< Вернуться к списку публикаций

Облако тегов