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

БЛОГ

Что такое структурированное писательство?

18.06.2015

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

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


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

Давайте начнём с как можно более общего определения типа «обхвати-руками-всё-сразу»:

Структурированное писательство — это акт создания контента, удовлетворяющего одному или более ограничениям.

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


9 факторов, влияющих на качество контента

10.06.2015

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


Встаньте на путь к хорошему контенту, оценив качество по показателям

Посмотрите в нескольких словарях определение слова «качество» и вы обнаружите много вариантов. Поговорите с людьми, которые управляют организациями, руководят командами по обеспечению качества или ведут блог о моде или еде, и у вас появится ещё больше определений. Одно из базовых определений описывает качество так: «в какой степени что-то хорошо или плохо». Другое продвигается на шаг вперёд и предполагает, что именно указывает на качество: «высокий уровень полезности и мастерства» (оба взяты отсюда: http://www.merriam-webster.com/dictionary/quality). Значит, определить, что представляет собой качественная документация, учебные материалы или вебсайты, раз уж вы взаимодействуете с этими материалами – легко, верно? Ну, да вы уже знаете ответ на этот вопрос. Читать дальше…


Представляем MadCap Capture 7

04.06.2015

01-127 мая вышла новая версия программы для работы со скриншотами — Capture 7. В обновлении появились новые возможности, а также была улучшена интеграция с MadCap Flare. Недавно вышла новая версия флагманского продукта компании MadCap Software — Flare 11 и сопутствующих продуктов. На MadCap Flare 11 и пакет MadPak в течение июня распространяются скидки.

Приобрести программное обеспечение MadCap Software и других производителей Вы можете в нашем интернет-магазине.

 

MadCap Capture – профессиональный инструмент для захвата экрана и редактирования изображений, с которым вам проще простого снабжать контент изображениями. Лёгкая обрезка и повторный захват изображений, добавление сопроводительных надписей, использование изображений из единого источника с пользовательской настройкой интеграции с вашими проектами во Flare, пакетная замена библиотек изображений, хранение общих настроек изображений в профилях — всё это и многое другое реализовано в этом инструменте. Читать дальше…


4 совета для придания импульса вашему проекту по локализации игр

28.05.2015

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

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

 

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


3 основные ошибки управления контентом в компаниях

21.05.2015

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


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


40 советов, хитростей и подсказок по удобному использованию Office 2013

14.05.2015

01Возможно, вы ещё не успели попробовать в работе Office 2013, либо пользуетесь именно им, но не изучили пока всех его многочисленных особенностей и фишек. Дэвид Нилд (David Nield) делится секретами по эффективному и удобному использованию пакета Microsoft Office 2013.


 

Пользуетесь ли вы отдельными приложениями, всем пакетом Office 2013 или же подписались на Office 365, в этих (относительно) новых версиях Word, Excel и PowerPoint появилось много фишек, за которые их можно полюбить.

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

Мы постарались сосредоточиться на новых особенностях Office 2013 (хотя вы и найдёте несколько советов, которые подойдут для любой версии), предоставив сочетание простых подсказок и более углублённых хитростей, которое будет доступно пользователю с любым уровнем знаний. Читать дальше…


111 источников идей для вашего блога

07.05.2015

07.05Корпоративный блог – в современном мире это необходимый инструмент для продвижения в сети компании любой сферы деятельности. Но как постоянно находить новые идеи для блога? Поначалу эта задача может показаться трудной, но стоит только войти во вкус… Брайан Ленг (Brian Lang) – эксперт в области контента ­– даёт огромное количество советов по поиску идей для вашего блога, среди которых вы точно найдете что-то, применимое для вас.

Как, у вас ещё нет корпоративного блога?.. Тогда мы идём к вам!

Наши специалисты по созданию и ведению корпоративных блогов к Вашим услугам.

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


Публикация документации онлайн – 18 миллиардов причин начать

30.04.2015

18.04Каждый разработчик хочет, чтобы потенциальные клиенты находили его продукт в Интернете. Очевидный факт – чтобы сайт находился поисковиками, на нём должна быть соответствующая информация, и чем больше – тем лучше. Думаете, это затратно? Есть один способ, который потребует от вас минимум усилий и расходов, но даст массу такой необходимой для продвижения вашего продукта информации. О нём рассказывает производитель систем для создания справочных порталов ClickHelp.

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

Так много причин – слишком много, чтобы составить список… И вам интересно, откуда взялась такая огромная цифра. Давайте выясним это вместе. Читать дальше…


VMware vSphere 6 для технических писателей: Кода

24.04.2015

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

Все статьи цикла:

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


Сервер управления виртуальной инфраструктурой VMware vCenter Server

Достаточно часто программное обеспечение, работающее в виртуальных средах VMware vSphere, интегрируется на уровне сервера VMware vCenter Server, и поэтому технические писатели вынуждены устанавливать этот компонент. Установить его можно на ту же виртуальную систему Windows Server 2012 R2, куда мы устанавливали клиент VMware. Читать дальше…


VMware vSphere 6 для технических писателей: Болеро

17.04.2015

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

Все статьи цикла:

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


Моральный настрой

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