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

БЛОГ

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

26.06.2013

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


Руки свело судорогой, и iTunes не обновляется. Вы сидите перед компьютером уже чересчур долго. Вы одинокий технический писатель, занятый разработкой документации. Надвигается дедлайн. В прошлом месяце вы отослали черновой проект, а в ответ… ничего. Ваши документы настолько плохи, что темные силы гуглят новые слова, чтобы описать ваши недостатки? Не совсем так. Я помогу вам найти способ справиться с работой практически без обратной связи.

Отсутствие вестей – само по себе неплохая весть

Худые вести не лежат на месте. Хорошие новости, как правило, не торопятся вылезти из кроватки. Причина? Менеджер, вероятно, занят тушением пожаров, и у него совершенно нет времени дружески поболтать или похвалить вашу работу. Для этого вас и наняли.

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


Изменения на арене технических коммуникаций: Советы и рекомендации, как оставаться на волне

24.06.2013

wind_turbine

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


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

О каких технологических изменениях я говорю?

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

Скорость и пропускная способность: широкое использование высокоскоростного Интернета и, как результат, инструменты, полагающиеся на эту скорость (взять хотя бы Skype и Google Video, но я мог бы перечислить тысячи).

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

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


Работа с техническим редактором: Получил обратно исправленный текст. И что теперь?

21.06.2013

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


Десять советов как организовать и пережить встречу с техническим редактором

Примечание автора: Эта статья появилась после прочтения и ответа на статью Чери Ласота об авторстве и редактировании художественной и научно-фантастической литературы. Работа с техническим редактором имеет некоторые сходства с другими видами письма, но также и некоторые отличия.

Технических писателей зачастую передергивает, когда они получают назад отредактированный материал, но ведь всё не так плохо. Вот несколько советов (выполняйте их по порядку), которым необходимо следовать при получении измененного текста от технического редактора или ЭП (эксперта по предмету).

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


Защита пользователей: нам нужно относиться к покупателю как к пользователю

19.06.2013

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


Традиционно технические коммуникаторы пытаются держаться подальше от маркетинга и всего, что с ним связано. В Techwhirl Алисса Мартин и Алан Хаузер с оружием в руках встали на поддержку существующей традиции, в то время как Бретт Перуцци призывал всех к миру, компания сотрясалась от разногласий. Сара О’Киф уже давно призывает нас положить конец холодной войне между техническими коммуникаторами  и маркетологами, но многие технические писатели еще, кажется, испытывают сильное отвращение ко всему, что хоть как-то похоже на маркетинг, считая его чепухой, а то и обманом.

Но вот в чем проблема. Покупатель  – он еще и пользователь. Во многих отношениях он для нас наиболее важный пользователь, потому что именно покупатель платит (или не платит) деньги, которые идут на наши зарплаты. И вот парадокс: то, что подходит начинающему или опытному пользователю, не всегда подходит для покупателя.

Брюс Тогнаццини, гуру в обеспечении простоты пользования и первый автор инструкции к интерфейсу Apple, недавно написал статью о том, почему нынешние продукты Apple нарушают многие фундаментальные правила хорошего пользовательского восприятия (ПВ).
Читать дальше…


Компания ПроТекст выступила спонсором гранта лучшему лицеисту

13 июня 2013 в Большим зале Центра культуры Новосибирского государственного технического университета прошла торжественная церемония, посвящённая переводу десятиклассников Инженерного лицея при НГТУ в 11 класс, где также был выбран лучший лицеист параллели.

По сложившейся традиции, каждое лето, после завершения экзаменов Инженерный лицей проводит три мероприятия, на которых выбираются лучший лицеист на параллели 10-х классов, лучший лицеист на параллели 11-х классов и лучший учитель.

В этом году спонсором гранта для лучшего лицеиста 10-х классов стала компания «ПроТекст». На церемонии вручения Александр Михайлов, генеральный директор ООО «ПроТекст» и член Ассоциации выпускников НГТУ-НЭТИ, вручил грант победительнице – лучшей лицеистке 10-х классов 2012-2013 гг. Цой Марии.

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


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

17.06.2013

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

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

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


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

14.06.2013

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


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

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

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


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

13.06.2013

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


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

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

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


Студенческая школа-семинар «Новые информационные технологии»

11.06.2013

01Компания «ПроТекст» с 20 по 26 мая 2013 г. приняла участие в проведении студенческой школы-семинара «Новые информационные технологии» в г. Судак, Крым, Украина. Мероприятие было организовано Московским институтом электроники и математики НИУ ВШЭ и собрало лучших студентов российских вузов. Данное мероприятие проводится уже в 21 раз и является значительным событием российского вузовского образования.

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


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

10.06.2013

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


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

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