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

Публикации

Эджайл и технические коммуникации: эджайл-процесс глазами руководителя (часть 2)

06.12.2013

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


Преимущества эджайла для руководителей

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

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

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



Эджайл и технические коммуникации: эджайл-процесс глазами руководителя (часть 1)

04.12.2013

01Сегодняшняя статья Алиссы Фокс посвящена технологии эджайл с позиции выгоды для руководителей предприятия. Первая часть статьи посвящена трудностям внедрения технологии эджайл в производственные процессы.


Если говорить о «самой чистой» форме этого процесса, эджайл-разработка втягивает в работу над пожеланиями пользователей посредством множества спринтов, пока их качество не станет достаточным для релиза чего-нибудь для ваших клиентов. Создание этих простых, независимых кусков производит потенциально готовый к отправке код в конце каждого спринта.

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

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



Какой набор навыков важен для технического писателя?

02.12.2013

01Статья об основных навыках, которыми должен обладать технический писатель, а также о том, как в него добавлялись новые навыки с течением времени.


Как и в случае с любой профессией, становление техническим писателем требует мастерства в определённом наборе навыков. В этот набор, с тех пор как объёмные инструкции для печатной публикации стали стандартом в профессии, обычно входили в качестве основных писательские навыки и способность иллюстрировать материал. Мир коммуникаций и технологий очень серьёзно развился во второй половине XX века и начале нынешнего. Как эта эволюция повлияла на набор навыков, необходимых техническому писателю?

  • Писательские навыки. Для технического писателя писательские навыки никогда не могут быть недооценены. Технический писатель всегда должен писать ясно, лаконично и быть способным подать материал так, чтобы он соответствовал разной целевой аудитории.
  • Технические навыки. Набор технических навыков технического писателя зависит в основном от того, какие требования предъявляют описываемый предмет, продукт или сервис, к которым требуется документация. Документация к «железу» или к программному обеспечению требуют различных навыков от технического писателя. К тому же, фармацевтика и другие производственные области имеют специфические требования, которые превращаются в знания, которыми обязан обладать технический писатель. Технический писатель, которого попросили написать гайд для разработчиков, должен быть «на ты» со специфическими языками программирования, тогда как технический писатель, задача которого – документирование в области оружейных защитных систем, должен иметь высокую степень компетенции в инженерных вопросах, так же, как и уверенные знания государственных стандартов документирования.

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



Что такое минимализм (часть 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: Обеспечьте информацией о том, как сделать, как научиться и как систематизировать.

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

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



Yahoo вырвала влиятельного технического писателя из NY Times

22.11.2013

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


Yahoo-Technology Columnist

Саннивейл, Калифорния – ведущий колонки о технологиях и обозреватель гаджетов New York Times  Дэвид Пог (David Pogue) покинул газету, чтобы освещать те же темы для Yahoo.

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

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



Эджайл и технические коммуникации: как видят скрам писатели (часть 2)

20.11.2013

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


Преимущества скрама для писателей

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

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



Эджайл и технические коммуникации: как видят скрам писатели (часть 1)

18.11.2013

01В данной статье Алисса Фокс, директор по производству информации и программному менеджменту из Техаса, рассказывает о том, как воспринимать и участвовать техническим писателям в производственных процессах, организованных по технологии скрам (scrum), входящей в идеологию эджайл (agile).


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

Скрам-команда состоит из владельца продукта (часто он является менеджером по продукту), разработки, инженеров по качеству и разработки информации (это вы!). Важно, чтобы писатели работали в скрам-команде бок о бок с разработчиками и инженерами по качеству, чтобы оставаться в курсе всех аспектов: дизайн, актуализация проекта, разработка продукта и т.д.

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