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

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

Ключ к написанию хорошей документации: тестирование инструкций

25.09.2017

Всем нам попадались инструкции, в которых было или сложно найти то, что нужно, или была куча непонятных терминов, или даже отсутствовали какие-то шаги в последовательности действий. А некоторые из нас и сами писали такие инструкции ? Чтобы этого избежать, необходимо проводить тестирование документации как неотъемлемой части разрабатываемых продуктов. Статья посвящена организации тестирования документации на предприятии и проблемам, которые при этом возникают. Автор: Том Джонсон, технический писатель из США.

Нет времени писать и/или тестировать инструкции? Заказать разработку инструкции в компании «ПроТекст» — лучшее решение!

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

О тестировании

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

Прохождение каждого шага в документации от своего лица, как технического писателя, крайне важно для создания хорошей документации. Однако чем сложнее структура документа, тем сложнее пройти все шаги. Особенно в случае с документацией для разработчиков, эта задача не тривиальна. Но она является неотъемлемой частью создания и пользовательской документации тоже. Читать дальше…



Программы-антиплагиаторы: развенчиваем 5 заблуждений

24.12.2015

01Мы начинаем серию статей, посвящённую программам-антиплагиаторам и соответствующим веб-сервисам. Часто возникают вопросы в связи с использованием этих автоматизированных средств. Авторы указывают на то, что антиплагиаторы не всегда точны, и это правда. Заказчики контента желают получить 100%-но уникальные тексты, и это желание понятно, но не при всех начальных условиях этот результат достижим и объективно необходим. Попробуем разобраться в границах применимости автоматических антиплагиаторов и методах правильной интерпретации их результатов.


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

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



Как текстовая техподдержка может сократить затраты

05.11.2015

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


Большинство компаний оказывают техподдержку в основном по телефону или электронной почте, так что, когда некоторые из них начинали осуществлять её через текстовые сообщения, у таких компаний ощущалась некоторая тревога. По сведениям сайта practicalecommerce.com, 4,3 миллиарда людей владеют устройствами, работающими с SMS, и 96% из них отправляют текстовые сообщения регулярно. Те, кто хотя бы несколько раз пользовался текстовой техподдержкой в качестве альтернативы телефонной поддержке, в дальнейшем предпочли именно текстовую. Так, исследование Harris Poll показало, что 64% клиентов предпочитают SMS-сообщения голосовым звонкам при решении технических проблем. Читать дальше…



Зачем мне технический писатель?

14.10.2015

01«Зачем мне технический писатель, если есть разработчик продукта, который запросто сможет создать документацию к нему?» – такой вопрос часто задают себе руководители компаний по разработке программного обеспечения. Те из них, кто в ходе рассуждений приходят к выводу, что технический писатель в компании не нужен и со всеми задачами по документации справятся разработчики – не правы. Почему – вы узнаете из сегодняшней статьи.

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


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



13 статистических фактов о копирайтинге для вашего бизнеса

25.06.2015

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

Специалисты компании «ПроТекст» будут рады разработать тексты, которые станут для Вашей компании инструментом продаж. Подробности на этой странице.

Инвестиции в копирайтинг могут реально изменить ваш бизнес. Эти факты показывают важность правильной организации копирайтинга и то, каким образом достичь значительных результатов с помощью нескольких улучшений. Читать дальше…



10 причин отдать техническое документирование на аутсорс

12.03.2015

12.03Следующие десять причин были выделены на основе многих лет опыта компании Young Copy, накопленного при предоставлении услуг технического документирования на аутсорсе очень успешным технологичным компаниям. Десять причин, которые вы увидите ниже, приводят к реальным результатам в реальных компаниях каждый день. Прочитайте статью Дэйва Янга, профессионального писателя и основателя компании Young Copy и переведите своё документирование на аутсорсинг сегодня!


1. Вы получаете эксперта или группу экспертов.

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



Адвокат пользователя: структурированный контент и потребности пользователя

06.03.2015

01Марк Бейкер завершает свою серию статей под названием «Адвокат пользователя» и строит мост к новой серии публикаций под своим авторством. В данной статье речь идёт о том, насколько структурированное писательство отвечает интересам пользователей.


Это моя последняя колонка из серии «Адвокат пользователя». Я не покидаю TechWirl, а скоро начну публикацию серии статей по структурированному контенту. В этой заключительной статье цикла мне хотелось бы построить мост между старой колонкой и новыми статьями: рассказать о роли структурированного контента в удовлетворении потребностей пользователя.

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



Пишем на английском для глобальной аудитории

20.02.2015

english-global-audiences-bannerСара Фишер рассказывает, что представляет собой глобальный контент, который будет одинаково хорошо читаться и носителями языка, и пользователями из других стран, что нужно знать, чтобы начать создавать контент на «глобальном английском» и о том, как не переборщить с локализацией.

Ищите подрядчика для локализации вашего контента на иностранные языки или, наоборот, для перевода каких-либо текстов на русский? Специалисты компании «ПроТекст» с удовольствием помогут выполнить все стоящие перед вами задачи по переводу и локализации! Подробнее на этой странице.

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

У глобальных брендов до сих пор есть и локальная аудитория; так как же мы соблюдаем баланс между требованиями локализации и необходимой согласованностью нашего контента? Мы смотрим, где и как локализовать без потери вашего бренда, вашего голоса или ваших клиентов.

Сейчас для многих, кто говорит и читает на английском, он является вторым языком, а не первым. От Нигерии до Южной Америки люди понимают английский язык и говорят на нём на работе, в обычных разговорах и онлайн. Любой контекст употребления английского привносит свои индивидуальные особенности и местные характеристики. Читать дальше…



Почему технический контент и маркетинг идут вместе

12.02.2015

01Где в организационной структуре предприятия место техническим писателям? В разных компаниях руководители считают по-разному: это может быть отдел разработки, обособленный отдел документирования, также техписы могут трудиться, находясь в разных отделах… По мнению Дуга Морана (Doug Moran), лучшего места, чем отдел маркетинга, для технических писателей не найти, и он называет 5 причин для этого. И к его резонным доводам стоит прислушаться, хотя идея «сажать» техписов к маркетологам звучит и непривычно.

У вас есть вопросы или сомнения относительно организации технического документирования в вашей компании? Специалисты компании «ПроТекст» помогут вам решить проблемы и вывести указанный процесс и его результаты на качественно новый уровень.

 

5 причин, почему техническая документация является частью маркетинга

В обычных высокотехнологичных организациях группы по техническому контенту натыканы по великому множеству отделов, но обычно оседают где-то в разработке. Это потому что технический контент – также известный как технические публикации или техническая документация, или разработка информации, или… ну, вы знаете – играет необычную, по мне, уникальную роль. Я уже слышу, как вы говорите: «Подожди, разве это не то, чем занимается продуктовый маркетинг?» Совершенно верно. Читать дальше…



Как организовать цикл обратной связи по переводам, который действительно работает

30.01.2015

29.01Самое главное в любом переводе – чтобы он был качественным и максимально близко соответствовал оригиналу. При этом сроки, как правило, очень ограничены. Сегодняшняя статья Ли Денсмер (Lee Densmer) – о цикле обратной связи и об инструменте, который поможет добиться того, чтобы переводчики перестали делать одни и те же ошибки, совершенствовали свои навыки на основе полученной обратной связи. Также этот инструмент поможет вам выявить слабые звенья в вашей переводческой команде.


 

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