Новости ПроТекст
Курсы технических писателей в Минске, Беларусь
15.07.2014
В начале этого года компания «ПроТекст» начала сотрудничество с Белорусским государственным университетом. Мы предложили учебную программу, и совместно с руководством ИНО БГУ было принято решение о новом формате проведения курса для ознакомления общественности с достаточно новой для Беларуси профессией технического писателя, а также изучения дальнейшего спроса на обучение. В учебных аудиториях БГУ мы провели несколько бесплатных занятий, посвящённых азам профессии и основным методикам работы.
Среди слушателей были представители разных специальностей: программисты; обучающиеся на различных курсах переподготовки ИНО БГУ; копирайтеры и многие другие. После завершения бесплатных лекций часть слушателей выразила желание записаться на полный платный курс (аналогичный проводимому нашей компанией в онлайн-режиме). Для них обучение начнётся через несколько дней.
Программа курса в ИНО БГУ идентична программе, по которой мы читаем онлайн-курс для наших слушателей. Форма занятий – очно-заочная. Каждый сможет выбрать для себя наиболее удобный вариант: приходить на занятия в университет, слушать записи дома или же совмещать оба варианта. В любом случае, все студенты прослушают лекции и выполнят практическую часть: под руководством преподавателя разработают три настоящих технических документа разного направления: руководство пользователя, аналитическую статью и презентацию. После успешного завершения учёбы слушатели получат сертификат государственного образца о прохождении курса. Стоимость занятий уточняется и составит около 4 млн белорусских рублей.
Если вы желаете приобрести компетенцию технического писателя в дополнение к своей профессии или хотите получить дополнительные навыки для дальнейшей смены деятельности (а наша программа позволяет и это), или уже являетесь техническим писателем и хотите усовершенствовать своё умение, поработать над ошибками, узнать больше профессиональных секретов и пообщаться с коллегами — мы будем рады видеть вас. Вы можете присоединиться к текущей группе или записаться на обучение, которое будет проходить осенью. Дополнительная информация появится на нашем сайте и на сайте ИНО БГУ. Записаться можно по телефонам: +375 29 388 16 87; +375 29 820 60 63. Для справок звоните по этим же телефонам (кафедра БГУ), а если хотите задать вопрос непосредственно преподавателю, пишите на info@protext.su.
Как писать документацию к программному обеспечению (часть 1)
14.07.2014
Создание документации к программному обеспечению – одно из самых востребованных направлений деятельности технического писателя. А значит, чтобы стать незаменимым (а в нашей сфере деятельности незаменимые бывают) специалистом, нужно освоить и это направление.
Или Вы технический писатель и желаете повысить свою квалификацию? Тогда — добро пожаловать на наш курс «Разработка технических текстов и документации».
Хорошая документация к программному обеспечению, будь то спецификация для программистов и тестеров, технический документ для внутренних пользователей или программное руководство и файлы справки для конечных пользователей, помогает человеку, работающему с программным обеспечением, понять его особенности и функции. Хорошая документация к программному обеспечению специфична, кратка, актуальна и предоставляет всю информацию, нужную человеку, использующему программное обеспечение. Ниже приведены инструкции о том, как написать документацию к программному обеспечению для технических специалистов и конечных пользователей. Читать дальше…
Пять вопросов, которые нужно задать себе при создании нового отдела документирования (часть 2)
11.07.2014
Мы продолжаем публикацию статьи о тонкостях руководства отделом документирования. Она может быть полезна не только людям, уже занимающим пост начальника такого отдела, но и тем, кто хочет в обозримом будущем сменить направление деятельности или подняться по карьерной лестнице.
Кого нужно нанять, чтобы это сделать?
После создания наброска этой таблицы (см. начало статьи) вы поймёте, сколько работников понадобится, чтобы закончить работу в сроки, необходимые компании. Запишите нужное количество сотрудников, задачи, за которые они будут отвечать, навыки, которыми должны обладать, а потом передайте информацию на согласование руководству. Возможно, для определённой вакансии понадобятся специфические навыки, например, умение документировать API, а также указать размер зарплаты. Такие источники как Обзор зарплаты от Сообщества Технических Коммуникаций (STC) помогут найти информацию о зарплатах в отрасли (Примечание. Данные с этого портала, конечно, не будут соответствовать российским реалиям, но для общей информации ознакомиться с ними может быть интересно. В России подобных подробных обзоров мы не нашли, но для ознакомления со средними зарплатами можно, как и в любой отрасли, проанализировать вакансии, выложенные на крупных порталах). HR-отдел компании должен стать ключевым активом в создании команды, поэтому обязательно создайте тёплые отношения с сотрудниками, которые отвечают за наём. Эти рабочие отношения будут полезны позже в случае возникновения проблем с персоналом. Как правило, HR-сотрудники являются специалистами по документированию проблем и справедливого их разрешения. Читать дальше…
Пять вопросов, которые нужно задать себе при создании нового отдела документации (часть 1)
09.07.2014
Сегодня мы решили затронуть тему не создания документации как таковой, а создания команды, которая может писать эту документацию. Формировать какое-то направление «с нуля» – очень непростое дело, поэтому мы публикуем несколько практических советов. Надеемся, они будут полезны руководителям отделов документирования.
Поздравляем! Вы – руководитель формирующегося отдела документации, и ваша работа только началась. Для создания эффективной клиентской документации нужно не только собрать крепкую команду, но и наладить отношения со всеми остальными отделами компании.
У меня было два контракта, где я на выезде создавал отделы документации в очень разных условиях. Первый был для стартапа софтверной компании в 1999 г. Единственной документацией компании до этого была тоненькая брошюрка, написанная программистом. Читать дальше…
Видеоуроки – 10 советов, как сделать обучающие видеоролики более эффективными (часть 3)
07.07.2014
Мы заканчиваем статью о том, как делать хорошие обучающие ролики. Разумеется, все секреты и хитрости не уложатся в 10 пунктов, поэтому ждём ваших комментариев. Поделитесь с нами своим опытом создания качественного видео. А может у вас есть яркие примеры ужасающих, как по форме, так и содержанию, видеороликов? Тогда мы сможем учиться «от обратного».
8. Учитесь на онлайн-примерах
Как упоминалось ранее, в Сети есть много примеров учебного видео или обучающих роликов, как хороших, так и плохих, по которым можно учиться. Критикуя их, вы научитесь делать ролики самостоятельно.
- Может, они слишком небрежны? Можете ли вы понять суть? Уверены ли вы, что сможете выполнить процессы, о которых рассказывается? Рассказ идёт слишком быстро или наоборот, очень долго тянется? Может у них сложный и отвлекающий фон?
Thai Foodcast, серия о тайской кухне из нескольких частей, была создана парой бывших штатных сотрудников Videomaker прямо дома в течение нескольких выходных. Они очистили площадь в гостиной от мебели и декора, повесили бамбуковый фон, чтобы подчеркнуть тему шоу, и использовали обычный микрофон и два источника света. Вводная часть во всех сериях снимается одинаково на этом простом фоне для общей согласованности, затем они делают крупный план приготовления пищи в их крошечной кухне, и представляют блюда на складном столе с приятной однотонной скатертью. Это один из многих удачных примеров. Читать дальше…
Видеоуроки – 10 советов, как сделать обучающие видеоролики более эффективными (часть 2)
04.07.2014
Мы вместе с вами продолжаем учиться делать качественные видеоролики. В век YouTube и Instagram эти навыки оказываются весьма полезными в борьбе за место на рынке.
4. Простой фон и освещение
Сложный фон не является необходимым для большинства видеоуроков и вдобавок часто отвлекает от рассматриваемого вопроса.
- В большинстве случаев вы будете демонстрировать что-то на столе или переднем фоне – сделайте фон простым, не перенасыщайте его.
- Вы можете купить готовые шторы или поехать в магазин тканей и найти материал со скидкой. Большинство тканей имеют от 45 до 60 дюймов в ширину, и вы можете купить её метражом или в рулоне. Простыни тоже подойдут, они даже шире.
- Придерживайтесь нейтральных оттенков, тёмный цвет хорошо подчеркнёт большинство предметов, но не пожалейте денег и на светлую ткань, если нужно спрятать тёмные предметы, такие как камера.
- Держитесь подальше от белого фона, который имеет тенденцию конфликтовать с экспозицией, если только у вас нет профессионального оборудования.
- Установите два источника света примерно на 45 градусов от центра области съёмок, по одному с каждой стороны. Подойдут даже простые торшеры, но смысл в том, чтобы сделать свет ровнее.
Видеоуроки — 10 советов, как сделать обучающие видеоролики более эффективными (часть 1)
02.07.2014
Многие компании стремятся разместить на своём сайте видеоролики, будь то обучающие или рекламные материалы. И хорошие ролики — это действительно отличный способ продвижения компании и её продуктов, а также донести информацию о том, как решить с помощью вашего продукта ту или иную задачу, без «многабукв», которые так часто не любят клиенты. Но как сделать видео таким, чтобы оно привлекало клиентов, а не отпугивало их? Сегодня мы начинаем публиковать статью, посвящённую этому вопросу.
Видеоуроки и обучающие видео повсюду – начиная с инструкций, как установить двигатель автомобиля, до курсов, как оседлать лошадь или построить модель поезда. Многие думают, что, раз они достаточно хорошо знают, как что-то делать, то могут использовать видеоуроки, чтобы учить этому других. Не обязательно.
YouTube и простота видеообмена нам дали возможность легко изучать, как другие люди делают видео. В основном плохие видео, но на плохом можно учиться не хуже, чем на хорошем.
Как и любой специализированный жанр кино или видео, учебные видео имеют особые потребности. Документальные фильмы не должны рассказывать, как древние строили пирамиду, им нужно сосредоточиться на том, как это могло бы произойти. Боевики не должны показывать, как обезвредить бомбу, там просто говорится, что нужно всего лишь перерезать зелёный провод (ой, подождите, может, белый провод?)… и зрители в это верят.
Видеоурокам и обучающим видео нужны определенные «точки зацепа», чтобы дать аудитории не только инструкции, как сделать эту модель поезда, но и уверенность, что всё делается правильно. Лучшие учебные видео следуют жёсткому формату, и эти 10 элементов могут помочь вам создать лучшие учебные видео, и побудить аудиторию захотеть добавки: Читать дальше…
Встречайте MadCap Pulse
30.06.2014
Мы завершаем серию статей о продуктах компании MadCap Software. Сегодня речь пойдёт о MadCap Pulse — веб-портала для работы над документацией, одинаково удобного как для пользователей документации, так и для её создателей.
MadCap Pulse — единственная платформа для документации, которая объединяет скрытую от пользователя отчётность и аналитику наряду с открытым социальным взаимодействием, позволяющая заказчикам контента подключаться, взаимодействовать и делиться знаниями.
Аналитика, отчётность и социальное взаимодействие для вашей документации
MadCap Pulse добавляет аналитику и отчётность, рейтинги и социальное взаимодействие в вашу документацию, — три компонента используются по отдельности или вместе — чтобы предоставить возможность понять, как пользователи используют и взаимодействуют с вашим контентом.
- Будьте в курсе с помощью потрясающих возможностей аналитики и отчётности
- Рейтинги для обратной связи по качеству контента и полезности
- Используйте силу социальных технологий
Читерские коды для хорошей документации (часть 2)
26.06.2014
Мы продолжаем статью разработчика-идеолога Брендона Уэста о важности грамотного подхода к созданию документации. Возможно, она вдохновит кого-то на глобальные перемены в компании.
Большое количество документации – проблема разработчиков
Давайте ещё раз рассмотрим эти категории. «Описательная» категория должна в основном заполняться маркетинговой командой. Таким документам не обязательно быть сильно техническими, но они должны направлять людей к более техническим разделам документации, которая может быть востребована аудиторией. Технический справочник и код требуют участия разработчиков, которые будут либо передавать писателю технические детали, либо лично писать образцы кода. Учебные материалы требуют, чтобы разработчики формулировали и создавали решения. А интерактивные системы требуют от технической группы ресурсы для реализации (и, возможно, поддержки).
Три из четырёх категорий требуют участия разработчиков, и мы обнаружили, что это работает не только в теории, но и на практике: в хранилище документов компании SendGrid около 230 HTML-страниц, но больше 2100 блоков кода. Эти коды писали кодеры, а не писатели. Если ваши разработчики будут заинтересованы в документации, то они будут заинтересованы и в её создании с точки зрения её содержания. И конечно, если вы захотите настроить под себя платформу, на которой создано хранилище документации, вам нужен разработчик. Читать дальше…
Читерские коды для хорошей документации (часть 1)
25.06.2014
Брендон Уэст – разработчик-идеолог в компании SendGrid – необычный человек. Согласитесь, не часто встретишь разработчика, который заботится о качестве документации, да ещё и пропагандирует такой подход среди коллег. Сегодня мы познакомимся с его статьёй о важности качественной документации.
Все, особенно разработчики, обожают работу над документацией. Они понимают важность документов и их влияние на принятие покупателем продукта и опыт клиента. Они всегда учитывают документацию при планировании и выпуске кода. Постойте, над чем это вы смеётесь?
У многих компаний есть проблемы с документацией. Из-за огромного количества типичных проблем сложно отстоять документацию; информация устаревает, ей не хватает полноты, контент плохо организован и противоречив, читатели не могут найти то, что ищут, а образцы кода могут быть неверными. Если вы зайдёте в отдел разработки и попросите добровольцев для обновления документации, вас встретят тишиной, если не откровенной насмешкой.
Правда в том, что нет читерских кодов, чтобы создать культуру, где ценят документацию, или чтобы создавать качественный контент, но я хочу поделиться практическими уловками, которым я научился, пытаясь создавать такую культуру для сервиса SendGrid. Надеюсь, я подарю вам пару дополнительных жизней (ну или хотя бы дополнительное здоровье) в этой игре. Читать дальше…