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

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

Основы: роль технического редактора

17.06.2013

01Вы – писатель, работающий с техническим редактором? Если да, считайте, что вы счастливчик; многие технические писатели не имеют такой роскоши, как услуги редактора. Писатели, работающие в проектной группе, часто редактируют документы друг друга, тогда как у их коллег, работающих в одиночку, может не быть другого выбора, кроме как выверять свою работу самостоятельно. Хотя эти сценарии широко распространены, они не являются примером для подражания.

Писать и редактировать – это разные процессы; каждый требует свой набор навыков и имеет свой принцип. Некоторые управленцы не до конца понимают разницу между написанием текста и  его редактированием, не осознают, какую пользу может принести редактор как отдельный сотрудник. По мнению Каролин Руд (Carolyn Rude) и Энджелы Итон (Angela Eaton), соавторов «Технического редактирования», технический редактор – это эксперт по коммуникациям, языку и нуждам аудитории. Хороший редактор способен оценить картину в целом так же хорошо, как и мелкие детали, и может играть ключевую роль в проектах по документированию.

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



Будущее сегодня: опыт пользователей двигает вперёд технические коммуникации

14.06.2013

01В настоящей статье изложена точка зрения Джекки Сэмюэлса (Jacquie Samuels), консультанта в области внедрения стандарта автоматизации создания технической документации DITA и систем управления содержимым (SMC), на будущее индустрии технической документации и технических коммуникаций. Образный язык автора не оставит равнодушными российских специалистов, работающих по данному направлению.


Хотя обычно я не люблю гадать на стеклянном шаре или на кофейной гуще, но TechWhirl попросила меня попытаться заглянуть в будущее технических коммуникаций. Итак, что мы имеем: «Джонни Мнемоник» вместе с «Особым мнением» и «Звёздными войнами», с примесью «Хакеров» в добавок.

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

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



Советы и хитрости: Переходим от очевидного контента к ценному

13.06.2013

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


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

Что пользователи считают самым ценным в техническом контенте? Простыми словами, пользователи хотят узнать то, что им нужно знать, не больше и не меньше. У пользователей есть вопросы, и они хотят ввести их в поисковую строку и получить ссылку на статью, само название которой уже является ответом на вопрос. А еще лучше, когда после открытия ссылки пользователь убеждается, что читает именно то, что ему нужно, что статья полностью отвечает на его вопрос. Как часто такое происходит? Не так уж и часто.

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



Советы техническим писателям: Документирование изменений в пользовательском интерфейсе в небольших командах

10.06.2013

Muhtar Kent, Nathan DealТехническим писателям часто приходится описывать пользовательские интерфейсы различных программных приложений. При этом разработка приложений не стоит на месте, имеет циклический характер, и поэтому важно выработать правильную стратегию работы для того, чтобы не случалось авралов или, хуже того, срывов сроков. Крейг Кардимон, технический писатель, работающий в таком активном режиме, делится своими советами.


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

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



Высокий уровень грамотности – на 20% выше зарплата

07.06.2013

gramotnostТемп роста уровня оплаты держится в этом году на достаточно низких отметках. Но у вас есть потенциал роста в пределах 10-20% и даже продвижения по службе, возможность неожиданного дохода, который напомнит годы подъёмов в экономике.

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

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

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

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