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

06.08.2014

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

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

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

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

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

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

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

04.08.2014

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

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

Создание обучающих видео с помощью Camtasia

01.08.2014

Мы уже публиковали статью про создание обучающих роликов. Сегодня мы хотим рассмотреть один из интересных и несложных в использовании инструментов. У него есть много аналогов, как например, Adobe Captivate и MadCap Mimic. Каждый из них представляет собственный набор опций на любой вкус и кошелёк.

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

Шаг 1: Создайте сценарий

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

Подойдёт ли вам профессия технического коммуникатора? (часть 3)

30.07.2014

Есть такая профессия – документацию создавать. И включает она не только документацию как таковую, но и полный анализ процессов в компании, «добывание», а то и «вытряхивание» информации из коллег и умение складывать слова в красивые (а главное понятные) предложения. Нам эта профессия нравится, а вам?

Уважают ли технических коммуникаторов?

Технических коммуникаторов мало уважают. Мне всё равно, сколько у вас научных степеней или как быстро вы можете работать; технических коммуникаторов не уважают. Отчасти, это связано с тем, что технические коммуникаторы – интроверты, но тут всё зависит скорее от ситуации. Вот как это работает:

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

Подойдёт ли вам профессия технического коммуникатора? (часть 2)

28.07.2014

Продолжаем размышлять на тему идеальной работы. Конечно, идеальная – это та, где уметь надо мало, а платят много. Справедливо ли это утверждение для технических писателей? Попробуем разобраться.

Какое образование вам понадобится?

Некоторые вакансии технических коммуникаторов требуют особых навыков; например, если вы документируете медицинское оборудование, могут понадобиться специальные курсы или образование. С другой стороны, вам вообще могут не понадобиться какие-то навыки, кроме умения писать. Писательские курсы – неплохая идея, так как там обучают основам планирования, письма и организаторским навыкам, от чего выиграет любой технический коммуникатор.

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

Подойдёт ли вам профессия технического коммуникатора? (часть 1)

25.07.2014

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

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

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

Что такое техническая коммуникация? Читать дальше…

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

23.07.2014

Мы не раз уже писали о важности наличия хоть какой-то (а в идеале качественной) документации. Эми Скаварда абсолютно с нами согласна. Представляем вам её размышления по этому поводу.

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

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

Три ошибки, которые пользователи допускают при использовании шаблонов Word

21.07.2014

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

Вы не захотите повторять эти частые ошибки при работе с шаблонами Word.

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

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

Светлая сторона технической документации

18.07.2014

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

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

Была ли жизнь писателей проще до появления компьютеров?

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

Как писать документацию к программному обеспечению (часть 2)

16.07.2014

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

Начало этой статьи: Как писать документацию к программному обеспечению (часть 1)

Метод 2 из 2: Пишем документацию для конечных пользователей

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

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