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

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

Пишем, чтобы быть готовыми ко всему: Что нужно знать техническому писателю (часть 1)

01.09.2014

01.09.14Глобализация сегодня – уже не просто далёкий и непонятный термин. Она охватывает всё больше сфер жизни, не обойдя стороной и нашу специальность. Перевод и локализация идут рука об руку с техническим писательством, а значит, нужно учитывать это при работе. Вал Свишер, генеральный директор компании Content Rules, делится идеями.


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

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



Эджайл и технические коммуникации: задаче-ориентированный контент в функцие-ориентированном процессе

20.08.2014

Ojective(Lens glass) isolated ion white.Мы продолжаем уже знакомую вам серию статей от Алиссы Фокс. Она детально углубляется во все тонкости эджайл-процессов и создаёт публикации, чтобы предостеречь нас от возможных ошибок.


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

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



Две истории о том, как писать справку (часть 2)

15.08.2014

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


История № 2

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

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



Две истории о том, как писать справку (часть 1)

13.08.2014

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


То, как большинство техписов подходят к написанию справки, в корне неправильно. Прочитайте эти две истории о разных подходах и мышлении разных писателей.

История № 1

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



Аутсорсинг медицинских коммуникаций

11.08.2014

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


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

Каковы преимущества переноса медицинских коммуникаций компании на аутсорсинг?

Снижение затрат на заработную плату Читать дальше…



Ценность документированных процессов (часть 2)

06.08.2014

06.08.14Продолжаем рассказ Марсии Уидон о том, зачем нужно создавать документацию и почему это лучше сделать, пока ваш бизнес ещё относительно мал.


 

Текучка персонала

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

Даже самые надёжные сотрудники могут однажды неожиданно уйти из компании. Люди болеют, попадают в аварии, могут понадобиться родным, умирают. Если не документировать процессы, то все знания и наработки уйдут вместе с этим сотрудником.

За стенами компании

Как бы компания не блистала на вершине, есть события и функции, которые требуют работы, адаптации и соблюдения вне стен компании. Читать дальше…



Ценность документированных процессов (часть 1)

04.08.2014

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


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



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

11.07.2014

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


 

Кого нужно нанять, чтобы это сделать?

После создания наброска этой таблицы (см. начало статьи) вы поймёте, сколько работников понадобится, чтобы закончить работу в сроки, необходимые компании. Запишите нужное количество сотрудников, задачи, за которые они будут отвечать, навыки, которыми должны обладать, а потом передайте информацию на согласование руководству. Возможно, для определённой вакансии понадобятся специфические навыки, например, умение документировать API, а также указать размер зарплаты. Такие источники как Обзор зарплаты от Сообщества Технических Коммуникаций (STC) помогут найти информацию о зарплатах в отрасли (Примечание. Данные с этого портала, конечно, не будут соответствовать российским реалиям, но для общей информации ознакомиться с ними может быть интересно. В России подобных подробных обзоров мы не нашли, но для ознакомления со средними зарплатами можно, как и в любой отрасли, проанализировать вакансии, выложенные на крупных порталах). HR-отдел компании должен стать ключевым активом в создании команды, поэтому обязательно создайте тёплые отношения с сотрудниками, которые отвечают за наём. Эти рабочие отношения будут полезны позже в случае возникновения проблем с персоналом. Как правило, HR-сотрудники являются специалистами по документированию проблем и справедливого их разрешения. Читать дальше…



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

09.07.2014

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


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

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



Встречайте MadCap Pulse

30.06.2014

00Мы завершаем серию статей о продуктах компании MadCap Software. Сегодня речь пойдёт о MadCap Pulse — веб-портала для работы над документацией, одинаково удобного как для пользователей документации, так и для её создателей.


MadCap Pulse — единственная платформа для документации, которая объединяет скрытую от пользователя отчётность и аналитику наряду с открытым социальным взаимодействием, позволяющая заказчикам контента подключаться, взаимодействовать и делиться знаниями.

Аналитика, отчётность и социальное взаимодействие для вашей документации

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

  • Будьте в курсе с помощью потрясающих возможностей аналитики и отчётности
  • Рейтинги для обратной связи по качеству контента и полезности
  • Используйте силу социальных технологий

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