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

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

5 простых способов эффектно начать пост в блоге

15.12.2017

Продолжаем радовать копирайтеров. Первая статья из серии советов по созданию продающих текстов здесь.


Какой второй самый важный компонент статьи в блоге после заголовка?

Мастер копирайтинга Юджин Шварц частенько тратит целую неделю на первые 50 слов продающего текста – заголовок и вступление.

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

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



Продающие тексты: 9 формул, приносящих успех

08.12.2017

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

Если Вы не копирайтер, а владелец бизнеса и Вам нужны качественные статьи для продвижения сайта — не мучайтесь, изучая все эти способы написания текстов, обратитесь к нам! Наши копирайтеры с удовольствием сделают всё за Вас.

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

Ниже вы найдёте 9 основных формул копирайтинга, которые должен иметь в своём арсенале каждый профессиональный копирайтер.

1. Метод четырёх U

Хотя преподаватели по копирайтингу в American Writers and Artists учат этому методу для написания заголовков, он подходит так же хорошо и для любых текстов. По сути метод четырёх U говорит о том, что ваш контент должен: Читать дальше…



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

17.11.2017

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


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

 

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



Читкоды для технических писателей

10.11.2017

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

  • не знает, с чего начать
  • хочет карьерного роста
  • работает давно и хочет разнообразия
  • хочет начать работать удалённо
  • хочет начать зарабатывать больше
  • подумывает сменить работу, но не знает, почему и как
  • не знает, чего хочет
  • любит GTA.

Давайте посмотрим на работу как на игру?

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

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

(Если вы далеки от игровой терминологии, мысленно замените слово «читы» на «лайфхаки», а заголовок статьи на «Инструкция к карьере технического писателя» 🙂 ) Читать дальше…



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

25.09.2017

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

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

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

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

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

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



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

21.07.2017

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

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

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



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

01.03.2017

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


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

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

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



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

02.02.2017

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


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

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



5 самых дорогих ошибок при локализации игр

16.12.2016

Не хотите при локализации игр получать легендарный «надмозг» вместо «сверхразум» из локализации StarCraft 90-х? Тогда эта статья – для вас.

Вам необходимо разработать тексты для игр или вы ищите подрядчика для локализации интерфейса и документации? Специалисты компании «ПроТекст» с удовольствием помогут вам!

Локализация не всегда получает внимание, которое заслуживает, у разработчиков видеоигр и издательств, но её нельзя игнорировать на сегодняшнем рынке.

Игровая индустрия — одна из немногих действительно глобальных, наполнена страстными фэнами, которые действительно внимательны к своим любимым тайтлам. Это означает, что просто делать локализацию — недостаточно. Необходимо сосредоточить на этом внимание.

Плохая локализация может повысить стоимость их производства, завалить продажи и плохо отразиться на отзывах в прессе. Тем не менее, мы видим, как большие и малые издательства делают те же ошибки снова и снова.

Здесь изложены пять наиболее дорогих ошибок при локализации игр, которые необходимо избегать. Читать дальше…



Как правильно выделять элементы текста в документации

01.12.2016

Кирилл Богатов, технический писатель ГК «Системные Технологии», делится своим советом с техническими писателями. Собственно, по опыту нашей работы, начинающие технические писатели достаточно часто не используют описанную возможность форматирования технической документации, де-факто уже ставшей негласным стандартом.


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

 

8021_600Sublime Text с подсветкой синтаксиса

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