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

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

Минимизируем документацию

17.11.2017

О том, как минимизировать количество документации и почему это важно, рассказывает Том Джонсон. И хоть эта статья довольно старая (ей 8 лет), тренды, которые наметились в то время, подтвердились и актуальны по сей день. А значит, применимы и советы, данные в этом материале.


На одной из конференций по дизайну интерфейса докладчик Грант Скоусен показал такой рисунок:

 

Простота и сложность Читать дальше…



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

25.09.2017

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

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

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

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

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

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



Элементарно, мой дорогой Ватсон: Редактор как Детектив

23.08.2017

Представляем вашему вниманию статью о работе редактора. Автор: Джефф Харт, сейчас работающий на фрилансе научным редактором, а ранее в таких организациях как IBM, Лесничество Канады и Канадский лесной институт.

Нужен редактор? Их есть у нас! Выполним редакторскую и корректорскую правку Ваших текстов в сжатые сроки.

В классической детективной истории отважный сыщик начинает расследования истинной истории события — в литературе, предположим, об убийстве или воровстве. Но при редактировании мы пытаемся обнаружить истинную историю автора и реконструировать её, насколько это возможно, в единое целое, которое уложено логически и поучительно для читателя. (Мы также в какой-то степени раскрываем преступления против языка). Только понимая цепочку событий, детектив может понять, что привело к преступлению.

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

  • мотив
  • благоприятная возможность
  • средства

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



Основы технического контента: Что такое визуализация данных?

21.07.2017

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

Поможем Вам оформить отчёты, создать инфографику и другие графические материалы. Обращайтесь 🙂

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



Установка виртуальной машины с Windows 7 в Oracle VM VirtualBox

10.06.2017

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

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

1. Введение

Oracle VM VirtualBox представляет собой бесплатное приложение для виртуализации, предназначенное для запуска на различных операционных системах. Виртуализация в данном контексте означает, что программа позволяет устанавливать, запускать и использовать различные операционные системы на одном физическом устройстве. Так, например, с помощью Oracle VM VirtualBox вы можете запустить Linux и Mac на Windows. Все виртуальные машины изолированы друг от друга, что открывает широкие возможности для применения VirtualBox: знакомство с операционными системами, тестирование ПО, использование ПО, которое по тем или иным причинам не работает в основной операционной системе и многое другое.

В данном пользовательском руководстве приводится процесс установки программного обеспечения Oracle VM VirtualBox, а также рассматривается пример развертывания виртуальной машины с операционной системой Windows 7. Читать дальше…



5 причин того, что интроверты могут быть успешнее экстравертов в бизнесе

26.05.2017

В продолжение темы прошлой статьи мы приводим ответ об интровертах с портала Quora. Отвечает Джозеф Кеннеди, владелец компании Content Pathway.


Я и в самом деле считаю, что интроверты могут быть БОЛЕЕ успешны в бизнесе.

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

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



Интроверты: сильные тихони и тихие силачи

12.05.2017

Данной статьёй мы открываем тему одного из типов личности, характерных для технических писателей. Интроверт – это хорошо или нет? Мешает это или помогает в работе? Как относиться к интровертам и, главное: о чём надо знать, если вы сами – интроверт? Автор статьи: Крейг Кардимон, технический коммуникатор, ответственный по контенту и копирайтер-фрилансер. В дальнейшем мы вернёмся к материалам, на которые здесь даны ссылки.

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

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

Снова за бортом!

Любите ходить на вечеринки? Вот и я нет. Всегда предпочту тихий вечер дома. Но иногда ты ДОЛЖЕН выходить. Подумай о корпоративной вечеринке. Ты ОБЯЗАН идти, чтобы показать себя качестве командного игрока, но когда музыка становится громче, а вместе с ней и голоса, ты выныриваешь наружу, чтобы получить Тихий Перерыв. Читать дальше…



Адвокат пользователя: теория хаоса и практика — писатели и пользователи в эджайле

01.03.2017

Эджайл – беда или благо для технического писателя? Попробуем разобраться вместе с Филом Девисом, опытным техническим писателем из компании Integral Development Corp., США.


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

  • Скрам: Мир просто сочится заряженным тестостероном действием, мускулистыми потными членами команды, запертыми вместе и выступающими друг против друга. Как здесь найти место писателю? Я мяч, который топчут и выпинывают на газон?
  • Лин: Нет спецификаций? Я должен опираться на ежедневные митиниги, обсуждения лицом к лицу, потоки электронных писем, доски с задачами и систему отслеживания проблем? И я должен использовать эти источники для написания документации для продукта, который я, скорее всего не вижу или не использую?
  • Спринт: Я погружаюсь в скрам, спеша создать соответствующую документацию каждые две-четыре недели? Без спецификации? Или продукта? В то же время участвовать в ежедневных митингах по каждому скраму?

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



Анализ аудитории (часть 2)

28.12.2016

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

Подробнее о целевой аудитории и других ключевых понятиях, в которых необходимо разбираться любому техническому писателю – в нашем курсе «Разработка технических текстов и документации». Кстати, с 15 декабря по 15 января мы предоставляем скидку 15% на курс!


Адаптация под аудиторию

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

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

  • Добавляйте информацию, необходимую вашим читателям для понимания.

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



Анализ аудитории (часть 1)

23.12.2016

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

Подробнее о целевой аудитории и других ключевых понятиях, в которых необходимо разбираться любому техническому писателю – в нашем курсе «Разработка технических текстов и документации». Кстати, с 15 декабря по 15 января мы предоставляем скидку 15% на курс!


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