Публикации
Советы и хитрости: 10 способов для определения пригодности документации
19.08.2013
Предлагаем вашему вниманию заметку Эны Эрел, которая посвящена некоторым эвристическим способам оценки такого важного параметра документации, как удобство её использования.
Мы стремимся создавать полезную для пользователей документацию. То есть мы хотим, чтобы наши пользователи находили необходимые разделы и использовали их для достижения своих целей с помощью программного обеспечения. Я использую десять способов для определения пригодности документации, или грубые оценки, чтобы планировать, оценивать и корректировать технический контент перед тем, как он уйдёт заказчику. Использование этих способов может помочь разработчикам контента выловить большинство конструктивных ошибок и получить представление о реальном опыте пользователей, касающегося работы с документацией.
Способы определения пригодности документации, приведённые в этой статье, были навеяны десятью основными принципами для пригодного дизайна, разработанными Джейкобом Ниэлсеном (Jakob Nielsen) и Рольфом Моличем (Rolf Molich). Тем не менее, мне потребовалось адаптировать большинство из них, основываясь на собственном опыте оценки пригодности документации.
Навыки писателей: слишком «субъективно»
16.08.2013
Виниш Гэрг в своей заметке размышляет о том, что навыки технических писателей можно оценить лишь субъективно. При этом ссылается на мнения других специалистов, которые мы также публиковали в нашей новостной ленте.
Из-за чего так трудно обучить основным навыкам писателя, по сравнению со всеми другими навыками, особенно в мире технологий? Марк Бэйкер прав, когда говорит, что писательство – единственная профессия, на которую не влияют инструменты.
Когда я планирую нанять технических писателей, для меня самое главное – оценить кандидата по правильным видам «писательских навыков». Писатель планирует и пишет независимо от того, использовал ли он FrontPage в 1990-х, или DreamWeaver в 2000-ом или использует DITA в 2013-ом. Мы можем провести экстенсивные обучающие программы, чтобы научить кандидатов и опытных профессионалов XML, CMS, индексированию, информационной архитектуре, навыкам бизнес-анализа, но научить их основным навыкам писательства, таким как «писать правильные предложения в инструкциях» – это совсем другая задача. На профессиональном уровне обучение и даже преподавание языковым навыкам очень субъективно.
Борьба с пренебрежением к файлам справки с помощью фокусировки на контенте (часть 2)
14.08.2013
Публикуем продолжение статьи Тома Джонсона, посвящённой проблеме качественного контента в файлах справки. Первая часть была опубликована ранее.
Исправление проблемы с контентом в файлах справки начинается с фокусировки на контенте
Чтобы исправить проблему бедного содержимого файла справки, мы должны начать смещать свой фокус непосредственно на контент. К счастью, фокусировка на контенте (вместо более эффективного процесса доставки контента) – это тот момент, когда карьера технического коммуникатора – по крайней мере, по моему опыту – начинает быть интересной. В этом заключается парадокс. Контент кажется таким скучным… до тех пор, пока вы не окунётесь в него. Затем все сложности, глубина, многообразие и другие аспекты начинают проявляться сами по себе, и внезапно всё остальное становится неважным.
Приведу несколько способов начать смещение приоритетов в сторону содержимого:
Борьба с пренебрежением к файлам справки с помощью фокусировки на контенте (часть 1)
12.08.2013
Представляем первую часть статьи Тома Джонсона, посвящённую проблемам написания файлов справки.
Долгое время я улучшал параметр лёгкости нахождения информации в документе как решение проблем документации. Но недавно я стал уже меньше уверен в том, что улучшение параметра находимости решит недостатки документации. Вместо этого стал убеждён, что настоящая проблема документации – неправильный контент сам по себе, не всегда позволяющий людям найти то, что нужно. Почему? Потому что «это» часто отсутствует. Пользователь пытается найти что-то, что не было создано.
Что на самом деле неправильно
Для начала краткое напоминание. Несмотря на то, что многие улучшения в технических коммуникациях позволили нам стать более эффективными – например, единый источник нашего контента, пропускаемый через множество каналов, подгонка контента в чётко определяемые структуры, подготовка хорошо выглядящих HTML, PDF и вывод на мобильные устройства без необходимости уметь программировать взаимодействие между форматами – многие пользователи всё ещё разочаровываются в файлах справки. Они всё ещё смотрят на них с пренебрежением.
Почему писательство – единственная профессия, на которую не влияют её инструменты?
09.08.2013
В настоящей статье Марк Бейкер говорит о том, что не согласен с мнением Ларри Кунца из предыдущей новости в том, что работа технического писателя не меняется по сути при появлении новых инструментов и приводит достаточно убедительные доводы.
Почему писательство – единственная профессия, на которую не влияют её инструменты? Ларри Кунц недавно опубликовал в своём блоге заметку на похожую тему: Инструменты приходят и уходят. Я по-прежнему писатель
Я писатель. Когда-то я использовал пишущую машинку. Теперь я использую XML-редакторы. Если я останусь в профессии ещё достаточно долго, появятся другие инструменты, и я научусь ими пользоваться.
Моя старая пишущая машинка в прошлом. Но я всё тот же писатель, я есть всегда.
Эти слова снова и снова звучат там, где собираются писатели. Похоже, среди писателей почётно заявлять, что ваша работа и самая суть того, что вы делаете, не зависит от инструментов, которые вы используете.
Довольно странное заявление, и я не могу придумать другой профессии, о которой можно было бы сказать то же самое.
На архитектуру сильно повлияло появление новых строительных материалов и строительной техники, что позволило архитекторам проектировать и строить здания, которые были бы невозможны при традиционных материалах.
Инструменты приходят и уходят. Я по-прежнему писатель
07.08.2013
Представляем очередную заметку Ларри Кунца, хорошо знакомого читателям нашей новостной ленты, о том, меняются ли писатели вместе с инструментами, которые они используют.
Пора убраться на чердаке. В этих коробках хранились годы, а то и десятки лет. Всю одежду и сувениры я раздарил, сдал в переработку или вывез на свалку. Это возможность посмотреть, что я хранил годами, и понять, что мне оно больше не нужно.
Как и большинство современных писателей, я вырос на пишущих машинках. На старенькой машинке моих родителей, которая весила как небольшой автомобиль, я набирал коротенькие рассказы о дружественных космических пришельцах и серьезные статьи для школьной газеты. Позже я научился печатать вслепую – навык, которому я нашёл хорошее применение, печатая десятки и десятки докладов и курсовых работ в школе и колледже.
Вскоре после того, как я стал техническим писателем, я по скромной цене купил машинку Smith Corona; весила она килограмм 5. Многие годы она служила мне верой и правдой для личной переписки и волонтерской деятельности.
4 пути к карьере технического писателя
05.08.2013
В данной заметке канадские эксперты размышляют о том, какими качествами должен обладать человек, чтобы ему легко далась работа технического писателя.
Если сообщения об ошибке 404 без всяких пояснений или нечётко сформулированные руководства пользователя не дают вам спокойно спать, возможно, в вас есть гены технического писателя.
Или вы любите размышлять о технологиях и словах, двух наиболее важных компетенциях технического писателя.
Таково мнение совет двух экспертов в области технического писательства, с которыми я недавно разговаривал – Эндрю Брук, президент Общества Технических Коммуникаций (STC) в Торонто, и Самедх Нене, ведущий инструктор по техническим коммуникациям в колледже Джорджа Брауна.
Эндрю Брук, президент Общества Технических Коммуникаций (STC) в Торонто: «Разработчики настолько близки к продукту, что не могут увидеть картину в целом. Вы выступаете в качестве среднего человека и фокусируетесь на основных вопросах, чтобы сделать продукт более удобным для использования».
Как инженеры могут улучшить навыки технического писательства
02.08.2013
Хотя инженер и техническая специальность, это не значит, что любой инженер обязательно будет хорошим техническим писателем.
«Техническое писательство включает в себя два ключевых навыка, – указывает Атул Матур, профессиональный инженер и технический копирайтер в Сингапуре. – Во-первых, это способность понимать технический язык, во-вторых, способность выразить это знание в ясной, чёткой и последовательной манере».
Дэн Джонс, профессор английского языка в Университете Центральной Флориды в Орландо, который предлагает ввести курсы технических писателей для будущих инженеров, не верит, что техническое писательство «или любой вид писательства – врожденный навык». По его словам, некоторые пишут лучше других, но эти навыки приобретались большой практикой и упорным трудом в течение довольно долгого времени.
Тем не менее, у инженеров действительно есть некоторые преимущества, когда дело доходит до технических коммуникаций. Они внимательны к деталям, сообразительны, требовательны, их не пугают технические термины. «Они хотят знать, как и почему что-то работает, но, как и студенты других специальностей, сталкиваются с похожими проблемами – четко и эффективно выражать свои знания», – говорит Джонс.
Переводчик инструкций
31.07.2013
Приобретение нового телевизора – захватывающе, до тех пор, пока вы сидите на диване с пультом в руке и не можете расшифровать запутанную инструкцию по эксплуатации, которая прилагалась к нему.
У вас есть 2 варианта: швырнуть пульт на пол с раздражением и выкинуть инструкцию по настройке на немецком или упорно продолжать штудировать инструкцию, которая не более понятна, чем если бы была написана на латыни.
Бесполезная инструкция, функция помощи, веб-сайт или документ как приводят в ярость, так и являются причиной стресса.
В такие моменты вспоминаются такие люди, как Эмма Хардинг.
Технические писатели нанимаются для того, чтобы сокращать, упрощать и рационализировать.
Когда всё это началось, у Хардинг был только диплом лингвиста.
«У меня было гуманитарное образование и всё, чего я хотела – была работа. И вот, это была моя первая работа за пределами стен университета. Это действительно большое поле для деятельности, о котором действительно понятия не имеют в Новой Зеландии».
Как побудить людей читать ваш контент
29.07.2013Представляем читателям нашего калейдоскопа мировых новостей заметку Мишель Макговэн о том, как сделать тексты, которые вы пишете, более востребованными для целевой аудитории.
«Всё равно никто не будет это читать» и другие беды копирайтера
За исключением того, что они не собираются читать это.
Я уверяю вас. Я тоже какое-то время жила в мире иллюзий. Но вы не перешагнёте этот порог к практичному копирайтингу, пока не преодолеете это огромное, несокрушимое препятствие. В основном люди не любят читать. И когда вы говорите, что вы «любите писать», а люди говорят, что они «ненавидят читать», то вы получаете рецепт препятствия.
Мой совет? Сломайте систему. Сделайте так, чтобы было невозможно не прочитать это.
В наши дни новое высказывание: «Контент – король». Это дополнительный стимул для копирайтеров всего мира. Основная мысль – что поданная в любой форме информация, скорее всего, провалится без серьёзного, качественного и нужного контента.
А значит, не падайте духом, потому что в вас нуждаются.
Значит так, возьмите ваш любимый документ и начните с уменьшения объема текста. В мире существуют несколько человек (и да, я один из них, остальные – те, кто сделают это дальше в этой статье), которые действительно хотят читать абзацы текста. И даже если они прочитают его, странно будет, если они обратят внимание или верно поймут его.