Как отличить технического писателя от автора маркетинговых текстов

27.08.2015

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

Технические коммуникации VS Маркетинговые коммуникации. Рисунок за авторством Antonio Prohias был впервые опубликован в январе 1961 года в журнале Mad Magazine (#60)

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

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

Git, Github, управление версиями и вы

19.08.2015

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

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

Три домена в структуре контента

13.08.2015

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

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

От идеи к точкам

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

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

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

Оптимизация просмотра веб-страниц для мобильных устройств посредством отзывчивого дизайна

07.08.2015

Если вы ещё сомневаетесь, стоит ли менять дизайн своего сайта на отзывчивый, то определиться вам поможет данный аналитический обзор. Из него вы узнаете, какие именно преимущества получают компании, имеющие «отзывчивые» сайты, для кого в первую очередь нужен отзывчивый дизайн и какими способами добиться того, чтобы дизайн вашего сайта был как эстетически приятен, так и удобен пользователям любым устройств. Автор обзора – Джефф Харт (Geoff Hart) – в прошлом сотрудник компаний IBM, Канадской лесной службы и Канадского лесотехнического научно-исследовательского института, а с 2004 года он работает как фрилансер-научный редактор, технический писатель и переводчик, и иногда входит в различные управляющие группы.

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

21 совет по веб-дизайну для начинающих

28.07.2015

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

Каждый хочет стать успешным профессиональным веб-дизайнером, но немногие становятся.

Что они делают для того, чтобы стать успешными?

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

Советы по графическому дизайну для начинающих

24.07.2015

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

Каждый нынче хочет делать всё самостоятельно. «Сделай сам» (Do-it-yourself, DIY) является трендом уже довольно давно. Клиенты осознают, что им больше не нужно покупать что-то готовое или нанимать кого-то на работу. С помощью Google и Pinterest не так уж много можно найти того, что вы не можете сделать самостоятельно с помощью правильных инструментов и материалов. Читать дальше…

Лаконичность без примитивизма

20.07.2015

Ранее мы уже публиковали статью на тему УТР – упрощённого технического русского языка, присланную одним из читателей нашего блога. Сегодня мы публикуем другую статью на эту же тему, которая затрагивает не только принципы русского языка, но и инструменты, необходимые для внедрения принципов УТР в организации. Тема эта актуальна, и это подтверждается в том числе тем, что автор данной публикации – тоже читатель нашего блога, который делится своим опытом, за что ему большое спасибо!
Автор: Владислав Москалёнок, старший технический переводчик, Bercut Ltd.

Упрощенный технический русский язык

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

Построение контент-стратегии для интернета вещей

16.07.2015

Интернет вещей и контент-стратегия. Бен Бароне-Нюгент — ведущий контент-стратег R/GA New York (в Твиттере: @benbn) — даёт своё видение связи этих понятий и рассказывает, на что в их контексте нужно обратить первоочередное внимание в нашем меняющемся технологичном мире.

В связном мире маркетологи должны использовать контент для того, чтобы давать людям сильные впечатления, а не просто рекламные сообщения.

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

Как написать техническую базу знаний для вашего сайта

08.07.2015

Размышляете о создании базы знаний для вашего бизнеса? Эта статья рассказывает об основах того, как обеспечить хороший уровень технического документирования вашего сайта.

Что такое техническая база знаний и зачем она вам нужна?

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

Новые услуги для Вашего документирования

07.07.2015

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

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

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

Чуть позже, систематизировав накопленный нашими ключевыми сотрудниками опыт, мы создали первую версию учебного курса для технических писателей «Разработка технической документации и текстов» (2012 год), который с тех пор увеличился в объёме более чем в три раза и продолжает постоянно совершенствоваться. Читать дальше…