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

Новости о техническом писательстве

Минимизируем документацию

17.11.2017

О том, как минимизировать количество документации и почему это важно, рассказывает Том Джонсон. И хоть эта статья довольно старая (ей 8 лет), тренды, которые наметились в то время, подтвердились и актуальны по сей день. А значит, применимы и советы, данные в этом материале.


На одной из конференций по дизайну интерфейса докладчик Грант Скоусен показал такой рисунок:

 

Простота и сложность Читать дальше…



Как структурировать объёмный текст

16.09.2015

Часто говорят о том, что нужно писать как можно короче, убирать лишнее, что никто не читает большие тексты и т.д. и т.п. Но как быть, если ваша история не помещается в тесные рамки минимализма? В статье несколько советов о том, как написать объёмный пост или какой-либо другой текст так, чтобы он не вызывал реакцию «слишком-многобукв-не-буду-читать». Автор текста: Скотт Несбитт (Scott Nesbitt).


Толпа адептов TLDR (too long, didn’t read; слишком длинно, не читал) сейчас удивится, но… в Интернете есть место для текстов крупных форм. И в печати тоже.

Я не буду подробно рассказывать, почему крупные формы важны — это тема другого поста в другое время. Если у вас есть интересная история, то нет причин, по которым вы не можете занять немного больше времени, немного больше места и чуть больше слов, чтобы рассказать её. Читать дальше…



Оптимизация просмотра веб-страниц для мобильных устройств посредством отзывчивого дизайна

07.08.2015

01Если вы ещё сомневаетесь, стоит ли менять дизайн своего сайта на отзывчивый, то определиться вам поможет данный аналитический обзор. Из него вы узнаете, какие именно преимущества получают компании, имеющие «отзывчивые» сайты, для кого в первую очередь нужен отзывчивый дизайн и какими способами добиться того, чтобы дизайн вашего сайта был как эстетически приятен, так и удобен пользователям любым устройств. Автор обзора – Джефф Харт (Geoff Hart) – в прошлом сотрудник компаний IBM, Канадской лесной службы и Канадского лесотехнического научно-исследовательского института, а с 2004 года он работает как фрилансер-научный редактор, технический писатель и переводчик, и иногда входит в различные управляющие группы.

Этой публикацией мы заканчиваем цикл статей о дизайне. Предыдущие публикации цикла:

Советы по графическому дизайну для начинающих

21 совет по веб-дизайну для начинающих


На «фаблетах» (англ. phablet) (смешанная комбинация телефона и планшетного компьютера – англ. phone и tablet computer) можно просматривать веб-страницы – и это даже приятно – в дороге без использования ноутбука или полноразмерного планшета. Но всё ещё существует поразительно большое количество разработанных без учёта нужд мобильных посетителей сайтов, пользоваться которыми на таких устройствах неудобно. Эта проблема сохраняется несмотря на то, что ошеломительный рост количества сотовых телефонов, фаблетов и планшетов должен сделать необходимость в дружественных к мобильному использованию сайтов очевидной для веб-дизайнеров. (Ноутбуки с большими экранами тоже являются мобильными устройствами, но я в этой статье сконцентрируюсь на телефонах и планшетах). Читать дальше…



Лаконичность без примитивизма

20.07.2015

минимализмРанее мы уже публиковали статью на тему УТР – упрощённого технического русского языка, присланную одним из читателей нашего блога. Сегодня мы публикуем другую статью на эту же тему, которая затрагивает не только принципы русского языка, но и инструменты, необходимые для внедрения принципов УТР в организации. Тема эта актуальна, и это подтверждается в том числе тем, что автор данной публикации – тоже читатель нашего блога, который делится своим опытом, за что ему большое спасибо!
Автор: Владислав Москалёнок, старший технический переводчик, Bercut Ltd.


Упрощенный технический русский язык

В последнее время усилилась тенденция перехода на упрощенный технический русский язык (УТР), возникшая вслед за Simplified English (SE). Прежде всего, область применения SE и УТР – техническая и эксплуатационная документация на аппаратные и программные средства, бытовую технику и прочее оборудование. Читать дальше…



Как писать кратко и понятно

10.01.2014

01Представляем статью Инны Якименко, эксперта по документированию компании First Line Software (г. Санкт-Петербург), посвящённую упрощённому техническому языку.


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

Сертифицируясь по своей специальности в американском университете, я познакомилась с правилами написания и редактирования технических текстов, которые применяют зарубежные специалисты по технической коммуникации.

Читать дальше…



Что такое минимализм (часть 3)

29.11.2013

01Часть третья статьи о минимализме – о том, как преодолеть существующую ментальную модель пользователей и зачем это нужно.


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

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

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

Читать дальше…



Записи докладов конференции ТехДок 2013

28.11.2013

Logo_TechDoc201327 и 28 ноября прошла конференция ТехДок 2013. Ура! 🙂

Спасибо всем докладчикам, участникам, а также информационным партнёрам, которые помогли нам собрать аудиторию. Максимальное одновременное количество участников онлайн было 118 человек, и цифра не опускалась весь день ниже 100. Мы очень рады, что мероприятие вызвало интерес и собрало множество положительных откликов! Теперь конференция для технических писателей станет ежегодным событием, и мы будем рады, если аудитория будет расширяться, и в России и странах ближнего зарубежья появится сообщество технических писателей, редакторов и переводчиков. Вместе веселее! 🙂

С удовольствием принимаем отзывы на электронную почту (info@protext.su), в соцетях и на сайте. Уже есть дельные замечания и мы постараемся учесть их в будущем.

Представляем записи докладов конференции. Читать дальше…



Что такое минимализм (часть 2)

27.11.2013

01Во второй части статьи с помощью цитат из книги Джона Кэрролла доказывается необходимость минимализма и невозможность преодоления парадокса придания смысла.


Приспособление к парадоксу придания смысла – это фраза Джона Кэрролла (John Carroll), использованная для описания того, что он или его коллеги узнали путём эксперимента над тем, как люди изучают компьютерные системы. Что мы могли ожидать: люди с наименьшими знаниями системы должны были полагаться на документацию больше всех, для того чтобы она провела их через незнакомые дебри. Новички читают документы; эксперты могут понять всё сами – это классическая модель. Кэрролл же выяснил, что всё с точностью до наоборот: чем меньше люди знают и меньше опыта имеют, тем меньше они читают документацию.

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

Читать дальше…



Что такое минимализм (часть 1)

25.11.2013

01Представляем первую часть статьи Марка Бэйкера о том, что такое минимализм в технической документации и как его достичь. В первой части речь идёт о причинах необходимости стремления к минимализму.


Спросите, что такое минимализм (в контексте технических коммуникаций), и вы, скорее всего, придёте к цитированию четырёх принципов минимализма.

Согласно Джо-Энн Хэкос (JoAnn Hackos), основные четыре принципа минимализма такие:

Принцип 1: Выбирайте подход, ориентированный на действие.

Принцип 2: Делайте документ удобным с точки зрения поиска нужной информации.

Принцип 3: Обеспечьте доступ пользователя к информации об ошибках и их устранении.

Принцип 4: Обеспечьте информацией о том, как сделать, как научиться и как систематизировать.

Это объяснение изнутри. Это всё равно, что отвечать на вопрос, что такое банка персиков, говоря, что это банка, в которой сироп и разрезанные персики. Это определение не содержит объяснение того, почему вы должны положить немного таких же изумительных, как и свежих персиков в банку. Это всё ответ на вопрос «что?», а не «зачем?».

Читать дальше…