Публикации
Писательские навыки против технических, или что я понял, решая судоку (часть 1)
28.04.2014
Мы часто задаёмся вопросом, должен ли технический писатель быть в первую очередь технарём или писателем. Может ли языковед стать техписом, и достаточно ли инженерных знаний, чтобы написать руководство пользователя. Том Джонсон, технический писатель из Калифорнии, попытался ответить.
Недавно мне пришёл вопрос от читателя:
У меня две специализации в английском, я преподаю в университете штата Пенсильвания. Я пытаюсь выяснить, сколько технических навыков мне придётся приобрести, чтобы стать техническим писателем. Где-то я прочитал, что технический писатель на 90% технарь и на 10% писатель. Как вы думаете, насколько глубокие технические знания нужно иметь?
Позвольте мне ответить, основываясь на недавнем опыте. На днях моя дочка-третьеклассница принесла домой пазл Судоку 6?6 в качестве домашнего задания и озадачилась его решением. Я никогда не пробовал свои силы в судоку, да и вообще никогда не интересовался подобными головоломками. Я сказал ей, что её мама, вероятно, справится лучше, но дочка объяснила, что мама уже пыталась. Мама (Шеннон) заметила из другой комнаты, что её «мозг не заточен под судоку». Это меня заинтриговало, так что я сел и попытался решить головоломку. Читать дальше…
Зачем мне нужна DITA? (часть 2)
25.04.2014
Мы завершаем статью, рассказывающую о преимуществе DITA над другими средствами авторинга. Но не считайте, что мы навязываем эту среду всем нашим читателям. Реалии таковы, что DITA не всегда может окупиться или стать самым оптимальным решением для каждого. Следите за нашим блогом, мы постараемся привести плюсы и минусы лучших из существующих решений.
DITA повышает удобство использования
DITAпредставляет переход от главо- и книгоориентированного авторинга к топикоориентированному, где каждый фрагмент информации является ясным и полным сам по себе. Кроме того, каждый фрагмент или топик имеет четкую цель. Ядро DITA включает в себя различные типы топиков, каждый написан, чтобы выполнить конкретную цель пользователей: концепт-топик для объяснения, топик-задача для инструктажа и топик-сноска для подробной информации.
Разделение контента на отдельные, часто используемые, но чёткие топики делает его более доступным для поиска. Пользователи могут перемещаться прямо к необходимой им информации, читать только соответствующую информацию (потому что остальное отбрасывается), а затем заниматься своими делами.
Зачем мне нужна DITA? (часть 1)
23.04.2014
Мы снова вернулись к одной из самых обсуждаемых тем нашего блога – DITA и важность её внедрения. Давайте ещё раз вспомним все преимущества этого стандарта.
Дарвиновская Архитектура Типизированной Информации (DITA) является стандартом на базе XML, который используется в основном для технической и всё чаще и для других типов документации. Мы уже представляли вам статью «Что такое DITA и зачем нам это нужно?». Мы подробно остановились на «что», а теперь хотели бы ещё раз подчеркнуть «зачем». И это вопрос, который вам нужно задать себе, если работа над созданием технического контента – часть вашей ежедневной работы.
Ответ обманчиво прост: Никуда от этого не денешься; если вы не применяете DITA как стандарт документации, вы работаете гораздо медленнее и менее эффективно, чем должны бы.
Требует ли внедрение DITA времени, усилий и знаний? Да, это так. И тогда вы сможете пожинать плоды в течение следующих… нуууу… в течение всего обозримого будущего. Читать дальше…
Хотите улучшить свои навыки по написанию бизнес-блогов? (часть 2)
21.04.2014
Заканчиваем статью, посвященную вопросам и проблемам создания бизнес-блогов. Простые и банальные, казалось бы, советы могут на самом деле привести к отличным результатам. Не пожалейте времени на прочтение данной публикации.
10. Создайте свой блог
Хорошему блогу нужен хороший дом. Вложите деньги в блог на WordPress, который будет соответствовать вашему бренду и с которым несложно работать.
Ключевые действия:
- Убедитесь, что выбрали адаптивный интерфейс – налицо рост мобильных пользователей. См. статистику
- Создайте стили и дизайн, которые выделят ваш блог из массы
- Блоги растут, включая всё больше визуального контента – добавьте стили, которые помогут создать хороший визуальный макет; думайте скорее не о блоге, а о журнале
Хотите улучшить свои навыки по написанию бизнес-блогов? (часть 1)
18.04.2014
Мы решили уделить больше внимания вопросам написания корпоративных блогов. Сегодня представляем вам статью Гари Фокса с небольшими, но детальными советами. Основная цель автора – помочь нам избежать главной проблемы всех начинающих блогеров – чрезмерного распыления.
Представляем вам 21 пошаговый совет по написанию бизнес-блогов. По каждому шагу вы найдёте несколько подсказок, как получить больше переходов, больше трафика и создать собственное сообщество.
21 Совет по написанию бизнес-блога
Мой отец всегда учил меня серьёзно подходить к основам, всегда доводить до конца исследования или работу, чтобы понимать, что ты делаешь. Подростком я постоянно игнорировал этот совет, хотя он был хорош, и шёл сложным путём (к счастью никто серьёзно не пострадал, не считая нескольких мелких происшествий, например, когда домик на дереве, где сидели мы с другом, внезапно рухнул). Его подход весьма разумен, несмотря на моё стремление делать всё сразу и быстро.
Работа на несколько эджайл-команд (часть 2)
16.04.2014
Заканчиваем статью Алиссы Фокс, посвящённую одному из аспектов эджайл-процесса. Публикация заставляет задуматься, а не ввести ли эджайл-процессы в своей компании. Тем более что выбор среди возможных стратегий довольно велик.
Когда вы работаете на несколько команд, вы можете тратить 4-5 часов в неделю (или больше) на совещания для каждого назначенного проекта. Переговорите с руководителем или менеджером, чтобы распределить нагрузку таким образом, что вы можете делегировать обязательства посещений совещаний другим. Вот несколько предложений:
- Участвуйте только в совещаниях, которые относятся к самому приоритетному проекту на данный момент.
- Попросите человека, проводящего совещания, отправлять отчеты по электронной почте, чтобы помочь тем, кто не может присутствовать на каждом заседании для каждого проекта.
- Попросите руководителя или менеджера посещать некоторые важные встречи, когда вы не можете.
- Перестаньте посещать ненужные встречи. Даже если исторически сложилось, что вы присутствуете на определенного рода встречах, если вы не получаете от них достаточно, чтобы расширить свои знания о продукте или внести вклад в контент, над которым вы работаете, возможно, ваш лучше потратить это время на что-то другое.
- Всё больше и больше распределенных команд работают в эджайл-среде. Многие команды используют онлайн-инструменты для совместной работы для проведения совещаний и создания постоянных отчётов об обсуждениях. Рассмотрите возможность использования онлайн-инструментов для совместной работы для одной или нескольких ваших команд, что позволит вам, если вы пропустите встречу, проверить запись позже.
Работа на несколько эджайл-команд (часть 1)
14.04.2014
Мы продолжаем публикации на тему эджайл-разработки. Сегодня Алисса Фокс поделится опытом, как организовать одновременную работу над несколькими проектами без ущерба для качества.
Обзор
Казалось бы, клише «делать больше с меньшими затратами» в большинстве компаний сегодня является суровой реальностью. Людям надо делать больше, а времени и средств на это у них меньше. Для софтверных компаний один из способов это осуществить – частое и постоянное движение ресурсов между несколькими проектами. Когда моя команда начала использовать процессы эджайл-разработки, мы долго искали информацию о том, как использовать этот процесс при работе на несколько эджайл-команд. Мы обнаружили, что большинство писателей, занимающихся эджайл-разработкой, работали всего с одной командой разработчиков. Как у «плавающих» писателей, у нас теперь есть уникальные проблемы в эджайл-разработке.
Измените подход к написанию контента: альтернативы DITA (часть 2)
11.04.2014
Предлагаем вашему вниманию продолжение списка самых интересных альтернатив DITA. Многие из них пока не получили широкого распространения, однако это не повод не принимать их во внимание. Возможно, именно эти узкоспециализированные инструменты идеально подойдут именно вашей компании.
S1000D: В основном используется в аэрокосмической промышленности. Спецификация S1000D подходит для длинных таблиц с подробными спецификациями частей. В аэрокосмической промышленности наблюдается расхождение мнений о полезности этого стандарта и его способности вырасти в продукт, который действительно необходим. Вместо него некоторые участники аэрокосмической промышленности используют DITA.
SPFE: Разработка Марка Бейкера SPFE (Synthesis, Presentation, Formatting, and Encoding – Синтез, Презентация, Форматирование и Кодировка) является запросоориентированным структурированным авторским подходом, который многообещающе выглядит, но пока не имеет ни широкого распространения, ни поддержки. SPFE (или «spiffy», как называют его в англоговорящих странах) представляет собой архитектуру для построения структурированного авторинга и издательских систем, который использует функции базы данных XML в обход необходимости внедрения дорогого CCMS.
Измените подход к написанию контента: альтернативы DITA (часть 1)
09.04.2014
Мы много рассказывали о преимуществах DITA, но не хотим, чтобы наши читатели считали, что DITA – это единственное решение для технического авторинга и своего рода «панацея» от всех проблем, с ним связанных. Представляем вам обзор других, иногда не менее удобных и полезных, инструментов технического писателя.
Когда вы и ваша команда, и даже ваш босс придёте к выводу, что «должен быть лучший способ» писать технический контент, ваши поиски, скорее всего, приведут к DITA (Дарвиновская Архитектура Типизированной Информации) как альтернативе ночным кошмарам обработки, копипасты, форматирования и поддержки версий в Word, с которым вы так долго работали. Но, прежде чем запрыгнуть в автобус с конечной станцией «DITA: Земля обетованная», помните, что существуют жизнеспособные альтернативы DITA, которые могут даже лучше удовлетворять вашим потребностям.
Советы и хитрости: FrameMaker 12. Функции, доступные каждому
07.04.2014
Консультант, тренер, разработчик курсов и преподаватель Seneca College Бернард Ашванден принимает непосредственное участие в разработке инструментов для технических коммуникаций. Он часто публикует обзоры новых приложений, уделяя внимание не только общеизвестной информации, но и «скрытым» функциям, о которых не многие догадываются. Представляем вам список таких функций продукта FrameMaker 12.
Пользователи Adobe FrameMaker могут не знать о новейших функциях FrameMaker 12, которые Adobe добавила, чтобы помочь сделать технический контент более полезным и доступным для аудитории. Чтобы помочь вам начать работу с некоторыми простыми в реализации функциями, мы рады предоставить несколько хитростей и рекомендаций, о которых могут не знать даже опытные пользователи. Конечно, у нас есть советы для пользователей с различным уровнем квалификации/опыта.