Бассейн для всех: Не только технические писатели могут использовать DITA

22.01.2015

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

Джекки Сэмюэлс, владелец Writing Wise, в сегодняшней статье рассуждает о том, можно ли использовать преимущества технологии DITA не только в среде технических писателей, разбирающихся в этой технологии от и до, но и среди других технических специалистов, участвующих в разработке продукта и рецензирующих создаваемую документацию.

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

Вакансия технического писателя

20.01.2015

Внимание, вакансия!

Мы ищем трёх человек для принятия в штат на должность технического писателя для работы в крупном долгосрочном проекте. Работа в основном удалённая, но есть необходимость периодически посещать офис.

Требования к кандидатам:

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

Мы гарантируем белую зарплату выше средней и интересную работу. Отклики с резюме присылайте на адрес info@protext.su с темой «Вакансия технического писателя». Тем, кто не хочет выполнять тестовое задание, просьба не беспокоить. Приложенное к письму портфолио будет плюсом.

Адвокат пользователя: винить ли автора, если коммуникация не удалась (часть 3)

16.01.2015

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

Миран Липовача, автор уважаемой, хотя и эксцентричной книги «Выучи Haskell, и будет тебе счастье» пишет о том, как он изучал язык программирования Haskell:

Когда я начинал учить Haskell, я пользовался не одним источником. Я читал различные руководства и статьи, потому что каждое из них объясняло немного по-другому. Изучая несколько ресурсов, я смог сложить вместе все куски, а потом они встали на свои места. Так что это попытка добавить ещё один полезный ресурс для обучения Haskell, и у вас теперь есть больше шансов найти тот, который вам полюбится. Читать дальше…

Адвокат пользователя: винить ли автора, если коммуникация не удалась? (часть 2)

14.01.2015

Марк Бейкер решил разобраться в одном из важнейших вопросов нашей профессии – что делать, если писатель не может найти общий язык со своим читателем.

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

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

Адвокат пользователя: Винить ли автора, если коммуникация не удалась? (часть 1)

12.01.2015

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

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

Я считаю, что читатель не только в равной степени ответственен за успешную коммуникацию, но и мы, как писатели, должны привлекать читателя к этой ответственности. И причина проста: если мы считаем, что читатель не играет никакой роли в успешной коммуникации, это делает наш контент хуже, не лучше. Читать дальше…

С Новым годом!

29.12.2014

Дорогие друзья!

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

Спасибо нашим клиентам, партнёрам, слушателям и читателям, что были и остаётесь с нами!

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

До встречи в новом году!

Руководство по выживанию в праздники для технических писателей 1.0

26.12.2014

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

Праздники уже не за горами. Это время семейных посиделок. И переполненных парковок, длинных очередей в каждом магазине и праздничной музыки, бьющей по ушам, куда бы мы не пошли. Вы вешаете гирлянды, напевая Jingle Bells себе под нос, и, пока пальцы не начинают замерзать, потягиваете пряничное латте. Эти времена могут быть стрессовыми, поэтому ознакомьтесь с Руководством по выживанию в праздничные дни от технических писателей из STC New England, чтобы пережить эти дни с минимальным стрессом, и, возможно, даже немного расслабиться. Читать дальше…

Пишем техническое задание для проекта разработки мобильного приложения (Часть 2)

24.12.2014

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

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

Так, давайте подробнее остановимся на том, как написать хорошее ТЗ на разработку мобильных приложений. Читать дальше…

Пишем техническое задание для проекта разработки мобильного приложения (часть 1)

22.12.2014

Техническое задание. Одно это словосочетание может вызвать мурашки, если вам приходилось сталкиваться с непрофессионально написанными ТЗ. Вы когда-нибудь бились над неграмотным ТЗ, выданным вам клиентом? А может вам самому нужно написать техническое задание, а вы не знаете, с чего начать? Рекомендуем прочитать (а также ненавязчиво переслать клиентам) нашу сегодняшнюю статью.

Как вы пишете технические задания (ТЗ)? Это станет очень часто задаваемым вопросом, если вы решите, что вам нужно разработать для бизнеса какое-то программное обеспечение. Компании, особенно если они не далеки от области разработки ПО, могут сильно запутаться, когда возникнет потребность в написании ТЗ к конкретному программному обеспечению. Например: если вам нужно мобильное приложение и вы решили прибегнуть к помощи другой компании по разработке мобильных приложений, они, вероятно, попросят у вас техзадание на проект. В этой статье мы рассмотрим наиболее общие пункты, которые должно затрагивать любое ТЗ, и исследуем ТЗ на разработку мобильных приложений. Читать дальше…

Как продвигать отдел документирования (Часть 2)

19.12.2014

Как часто мы видим ситуации, когда отличный специалист с инженерным образованием и выдающимся даром слова не может найти заказ? К сожалению, очень часто. И тут нужно вспомнить о слове «маркетинг». Себя и свои услуги нужно продвигать и продавать, а если вы работаете в команде, то и продвигать нужно всю команду. А теперь представьте, что этим будет заниматься каждый сотрудник по мере сил и умений. Открываются довольно приятные перспективы для всего отдела, не правда ли?

Продвигаем с помощью положительных ответов

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