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

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

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

05.11.2015

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


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



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

14.10.2015

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

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


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



5 навыков, нужных техническим писателям для работы в стартапах

10.09.2015

url76-780x330Перечисленные в статье навыки пригодятся вам для работы не только в стартапах, но и в любой небольшой компании, где вы будете единственным документатором – соответственно, любой вызов по части документирования и текстов достанется именно вам. Так что, устраиваясь работать в небольшую фирму, будьте морально готовы ко всему. Предупреждён – значит вооружён!


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



Руководитель проекта приведёт перевод к успеху – 9 пунктов, которые нужно выполнять (часть 2)

07.11.2014

07.11.14Вы ищите исполнителей локализаторского проекта? А может вы сами такой исполнитель и ищите пути оптимизировать процесс? Тогда наша статья для вас.

Ищите подрядчика для локализации интерфейса или документации? Специалисты компании «ПроТекст» с удовольствием помогут вам!
Начало данной статьи читайте тут: Руководитель проекта приведёт перевод к успеху – 9 пунктов, которые нужно выполнять (часть 1)

 

  1. Руководитель проекта собирает переводческую команду

Вам нужны эксперты по предмету в 20 разных странах, говорящие на 10 разных языках? Справиться с таким самостоятельно будет в лучшем случае сложно, в худшем – кошмарно. Руководитель проекта – тот, кто соберёт переводческую команду, независимо от того, сколько в проект вовлечено стран и языков. Читать дальше…



Руководитель проекта приведёт перевод к успеху – 9 пунктов, которые нужно выполнять (часть 1)

05.11.2014

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

Ищите подрядчика для локализации интерфейса или документации? Специалисты компании «ПроТекст» с удовольствием помогут вам!
Продолжение данной статьи читайте тут: Руководитель проекта приведёт перевод к успеху – 9 пунктов, которые нужно выполнять (часть 2)

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

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

Управление проектами по существу – профилактика рисков. Проекты по переводу и локализации состоят из многих «подвижных частей» и многих областей, где что-то может пойти не так. Руководитель берёт на себя естественные риски этих проектов, освобождая вас от лишних проблем, давлений и беспокойства, в то же время улучшая как процесс, так и конечный результат. Читать дальше…



Пять вопросов, которые нужно задать себе при создании нового отдела документации (часть 1)

09.07.2014

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


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

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



Встречайте Contributor и Analyzer от MadCap!

09.06.2014

00Представляем вашему вниманию очередные два инструмента от компании MadCap, с помощью которых автоматизируются, упрощаются и качественно улучшаются такие процессы, как совместная работа над документом авторов, редакторов, рецензентов и руководителей – это обеспечивает MadCap Contributor, и аналитика документации – за этот процесс отвечает MadCap Analyzer.


 

MadCap Contributor

С MadCap Contributor каждый сотрудник вашей организации сможет легко рецензировать документацию и вносить в неё свой вклад. Руководители и эксперты по предмету (ЭП) могут редактировать и рецензировать топики, создавать примечания и обновлять контент с помощью простого, лёгкого в использовании интерфейса. Тесная интеграция с MadCap Flare делает MadCap Contributor необходимым инструментом в процессе доводки и рецензирования документации.

Добавление и просмотр контента каждым сотрудником вашей организации Читать дальше…



Главные вопросы технической коммуникации

28.05.2014

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


Какова ценность технической коммуникации?

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

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

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



Эджайл и технические коммуникации: командный подход (часть 3)

07.03.2014

07.03В завершающей части статьи речь пойдёт о сворминге – что это, и чем хорош этот подход в эджайл-разработке, о работе над ошибками, а также о том, как допускать как можно меньше ошибок при командной работе и, таким образом, копить как можно меньше «технических задолженностей».


Сворминг

Чтобы командный подход стал успешным, инженерам по качеству и членам группы разработки информации нужны хорошая поддержка и обучение, которые помогут им адаптироваться к быстрому темпу эджайл-разработки. Тесное сотрудничество внутри команды может потребовать от ее членов освоения новых навыков, и действительно важно дать им время для этого. Одним из способов это осуществить является сворминг (от англ. Swarming — роение, обозначает совместную работу «всем скопом»).

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



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

05.03.2014

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


Качество — это ответственность всей команды

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

Мы обнаружили, что для достижения наших целей в каждом спринте нам необходимо как можно больше автоматизировать тестирование. Автоматизированное тестирование быстрее, надежнее и менее подвержено ошибкам. Инженеры по качеству взаимодействует с группой разработки, чтобы обеспечить выполнение модульных тестов (unit tests) и повысить внимание к моментам, в которых существуют пробелы. Инженер по качеству должен также направлять усилия  на разработку и автоматизацию приемочных тестов (acceptance tests), а также на выполнение исследовательских тестов (exploratory tests). Другими словами, ручное тестирование — это не самый гибкий (agile) способ получения высококачественного продукта. Для получения дополнительной информации о гибком тестировании и различных видах тестирования смотрите блог Лизы Криспин (Lisa Crispin) www.lisacrispin.com.

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