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

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

Установка виртуальной машины с 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

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


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

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

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



Лучшие умы человечества о документировании (часть 3)

24.03.2017

Если вы ещё не устали от шуточных цитат Георгия Полищука, но устали от сплошной философии, то держите продолжение в известных стихах (и не только).

Первая часть: Лучшие умы человечества о документировании

Вторая часть: Лучшие умы человечества о документировании-2

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



Лучшие умы человечества о документировании (часть 2)

17.03.2017

Представляем вам вторую часть юмористической заметки от нашего выпускника Георгия Полищука. Первая часть: Лучшие умы человечества о документировании

С пятницей! 🙂 Читать дальше…



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

01.03.2017

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


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

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

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



Лучшие умы человечества о документировании

22.02.2017

Сегодня мы не будем грузить вас рассказами о софте, особенностях документирования чего-либо, и уж тем более статьями уважаемого Марка Бейкера. Прочитайте шутки от нашего выпускника Георгия Полищука о нас с вами, коллеги, и улыбнитесь в этот предпраздничный день! Кстати, в нашем блоге есть и серьёзная статья Георгия.

 

Не читай документацию, Гертруда!

(У.Шекспир)

 

Шуточки Название работы / цитата ИРЛ
Документация — опиум для службы поддержки (К.Маркс) Религия — опиум для народа (К.Маркс)
Заметили ли, что документирование закрепощает аналитический ум? Ломает крылья бизнес-анализу? Что становишься тем более аналитиком, чем более становишься техписателем? — Серое небо абстракции как-бы бороздят молнии; свет достаточно силён для всего филигранного в вещах; задачи в JIRA с типом Epic близки к завершению; проект, озираемый как бы с позиции заказчика. — Я определил только что трудовой пафос. — И неожиданно ко мне в почтовый ящик падают новые письма, маленький град из уведомлений и прочего бреда, из незадокументированых задач… (Ф.Ницше) Заметили ли, что музыка делает свободным ум? Даёт крылья мысли? Что становишься тем более философом, чем более становишься музыкантом? — Серое небо абстракции как бы бороздят молнии; свет достаточно силён для всего филигранного в вещах; великие проблемы близки к постижению; мир, озираемый как бы с горы. — Я определил только что философский пафос. — И неожиданно ко мне на колени падают ответы, маленький град из льда и мудрости, из решённых проблем…

(Ф.Ницше)

Без документации жизнь была бы ошибкой (Ф.Ницше) Без музыки жизнь была бы ошибкой (Ф.Ницше)
Аналитика есть бессознательное метафизическое упражнение души, не ведающей, что скоро она должна будет еще и документировать (А.Шопенгауэр) Музыка есть бессознательное метафизическое упражнение души, не ведающей, что она философствует (А.Шопенгауэр)
Документируй так, как если бы максима твоего технического текста могла бы быть всеобщим законом для пользователей продукта (И.Кант) Поступай так, как если бы максима твоей воли могла бы быть всеобщим законом (И.Кант)
Вечное возвращение документации. С цикла согласования (Ф.Ницше) Вечное возвращение (Ф.Ницше)
Единственное преступление — это бездарная документация (О.Уайльд) Единственное преступление — это бездарность (О.Уайльд)
О чем нельзя говорить, то следует задокументировать (Л.Витгенштейн) О чем невозможно говорить, о том следует молчать (Л.Витгенштейн)
Документировать или идти обедать, — вот в чем вопрос (У.Шекспир) Быть или не быть, — вот в чем вопрос (У.Шекспир)

 

Продолжение следует…



Первый взгляд: Adobe Technical Communication Suite (релиз 2017)

10.02.2017

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


Инструмент для контента, который стал больше, лучше и круче

Технический писатель. Разработчик информации. Разработчик инструкций. Менеджер по контенту. Производитель. Менеджер по документированию. Копирайтер. Эксперт. Не имеет значения, где вы сталкиваетесь с производством контента, перед вами наверняка встаёт проблема выбора правильных инструментов для управления постоянно изменяющимся и всё возрастающим потоком работы. Вы создаёте контент для традиционной печати или вывода в PDF, помощь, встроенную в приложение или для клиентов разрабатываете порталы, которые содержат обучение, самостоятельную помощь и другой контент? Adobe Technical Communication Suite (релиз 2017) предлагает для этого гораздо больше, чем кажется на первый взгляд. Читать дальше…



Управление контентом и потреблением: онлайн-сообщества движутся вперёд и в центр

02.02.2017

Мы начинаем публиковать серию статей, посвящённых онлайн-сообществам и их контенту. Автор серии – Конни Джиордано (Connie Giordano), которая стоит у истоков онлайн-журнала TechWhirl, является одним из его основателей и редактором.


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

Две хорошо известные аксиомы, видимые под разными углами зрения, могут описать постоянно меняющийся мир создателей контента в 21-ом веке. Читать дальше…



Алгоритмы связывания и структурированное писательство

27.01.2017

Статья входит в цикл «Понимание и применение структурированного писательства».

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

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

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