Публикации
Doc-To-Help представляет первый бесплатный облачный хостинг технической документации
12.05.2014
Как мы и обещали, продолжаем публиковать обзоры самых интересных инструментов для технических писателей. Продукт Doc-To-Help, о котором мы уже не раз упоминали, расширяет возможности. Думаем, это будет интересно многим.
Doc-To-Help, компания с мировым именем и лидер рынка инструментов авторинга и публикации контента, объявила о релизе бета-версии NestServer. Nest Server – бесплатный облачный сервис для хостинга конечных файлов NetHelp, который работает совместно с Doc-To-Help.
«Doc-To-Help уже хорошо известен как продукт для производства современной, высококачественной и отзывчивой веб-справки, и сейчас совместно с Nest Server мы продолжаем развивать его, предоставляя пользователям бесплатное «Гнездо» (nest – гнездо, прим. пер.) для размещения созданных файлов», – объявил Дэн Билл, менеджер по продукту компании ComponentOne, подразделения GrapeCity. Читать дальше…
Единый источник (часть 2)
07.05.2014
Заканчиваем публикацию на тему единого источника. Возможно, она побудит вас задуматься о возможности перехода на эту технологию.
Например, ваша компания находится в процессе выпуска комплексного программного приложения. Для поддержки нового софта понадобятся несколько типов документов:
- Маркетинговые материалы;
- Онлайн-справка;
- Учебные материалы;
- Руководство.
При использовании традиционных методов контент-авторинга для каждого типа будет создан отдельный документ. Но поддержка четырёх различных документов требует больше времени и усилий на их написание и обновление. Если обновление необходимо, то изменения можно внести во все документы, содержащие данный контент. Единый источник поможет вам сократить количество работы автора над различными документами для разных выходных форматов.
Зачем озадачиваться единым источником?
Основные аргументы за технологию единого источника – стоимость и постоянство. Читать дальше…
Единый источник (часть 1)
05.05.2014
Много внимания в публикациях мы уделяем системе DITA и связанным с ней инструментам. При этом часто употребляется термин «единый источник». Что же конкретно подразумевается под этим понятием? Небезызвестная нам Сьюзен Бодник может ответить.
Передача информации становится все более сложным делом, так как информация должна адаптироваться к новым технологиям поставки контента. Информация передаётся в различных форматах и для разных аудиторий. Если вы ищете решение проблемы поставки контента в нескольких конечных форматах и для различных аудиторий, возможно, вас заинтересует единый источник. Технология единого источника – процесс, при котором вы создаете контент в одном общем источнике, обычно в формате XML. В этом едином источнике вы можете использовать процессы, которые публикуют контент в нескольких форматах. Например, ваши документы можно опубликовать как интерактивную справку (chm), PDF или HTML. С помощью единого источника вам нужно всего лишь один раз создать контент, а потом использовать его в многочисленных типах выходных документов.
Как единый источник мне поможет?
Публикация при помощи единого источника – больше, чем просто публикация документов в нескольких версиях в любой среде. Единый источник позволяет: Читать дальше…
Писательские навыки против технических, или что я понял, решая судоку (часть 2)
30.04.2014
Думаем, предыдущая статья заинтриговала наших читателей. Казалось бы, как связаны судоку и карьера технического писателя? Но Тома Джонсона эта несложная головоломка навела на интересные мысли. Начало истории тут.
Утром я показал дочери, как решать головоломку. Стратегия поставила её в тупик.
Этот опыт заставил меня задуматься о головоломках и моём мозге. Несмотря на то, что меня всё равно никогда никто не увидит решающим судоку для собственного удовольствия, подобные испытания мне даже нравятся. Как технический писатель, каждый день я сталкиваюсь с маленькими неизвестностями, которые приходится решать. Создание алгоритма для решения конкретного вопроса — один из путей решения головоломок / решения проблем. Я обнаружил, что мой мозг замыкается на решении головоломки/кода/проблемы, и не отпускает, пока я не решу задачу.
Это одна из причин, по которой я решил теснее связать свою карьеру с документацией для разработчиков. Мне нравятся головоломки по решению логических проблем. Это намного интереснее, чем простое редактирование уже написанных статей.
Также мне нравится представлять, как части работают вместе, отдельно от кода. Я часто устраиваю безжалостное тестирование методом проб и ошибок, чтобы понять, как всё работает. Как только я разобрался, я тут же пишу описание с объяснением и перехожу к следующей проблеме. Читать дальше…
Обновление сайта
28.04.2014
Дорогие друзья!
С радостью сообщаем, что сегодня наш сайт начинает новую жизнь – он стал более удобным, современным и, как нам хочется верить, красивым. Один из главных разделов, ради которых существует сайт – новости о техническом писательстве – теперь находится в удобном месте на главной странице, дизайн радует глаз (по крайней мере, наш 🙂 ), а самая главная новая особенность – теперь сайт открывается одинаково хорошо как на больших мониторах, так и на любых мобильных устройствах.
Второй ключевой момент: на сайте появился новый большой раздел, посвящённый продаже программного обеспечения для технических писателей. В данный момент раздел находится на стадии доработки, а мы готовимся к старту продаж. Следите за нашими новостями, и, мы уверены, с нашей помощью вам удастся решить наболевшие проблемы с инструментами для документирования.
Спасибо компании Zevoro за качественную разработку и за терпение при работе со всеми мелочами, которые возникали в процессе.
Писательские навыки против технических, или что я понял, решая судоку (часть 1)
Мы часто задаёмся вопросом, должен ли технический писатель быть в первую очередь технарём или писателем. Может ли языковед стать техписом, и достаточно ли инженерных знаний, чтобы написать руководство пользователя. Том Джонсон, технический писатель из Калифорнии, попытался ответить.
Недавно мне пришёл вопрос от читателя:
У меня две специализации в английском, я преподаю в университете штата Пенсильвания. Я пытаюсь выяснить, сколько технических навыков мне придётся приобрести, чтобы стать техническим писателем. Где-то я прочитал, что технический писатель на 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 Совет по написанию бизнес-блога
Мой отец всегда учил меня серьёзно подходить к основам, всегда доводить до конца исследования или работу, чтобы понимать, что ты делаешь. Подростком я постоянно игнорировал этот совет, хотя он был хорош, и шёл сложным путём (к счастью никто серьёзно не пострадал, не считая нескольких мелких происшествий, например, когда домик на дереве, где сидели мы с другом, внезапно рухнул). Его подход весьма разумен, несмотря на моё стремление делать всё сразу и быстро.