Как создать инструмент для создания справки с помощью WordPress

Хороший технический писатель всегда рядом со своим надежным инструментом для создания справки (HAT).

Рабочая лошадка в сфере технического письма — вспомогательный инструмент для авторов, берет на себя нагрузку и трансформирует искусство «упрощать сложные вещи»… ну, проще простого.

HAT — это максимизатор производительности для технических писателей. Технические писатели 10x твердо придерживаются этой стороны своей игры.

С таким количеством этапов повторяющихся раундов формирования и редактирования текста, чтобы он идеально подходил для цели…

…вам действительно нужна Шляпа, которая будет работать вместе с вами и поможет сосредоточить все ваши усилия на создании наилучшего литературного произведения.

Концепция HAT не нова.

Они были вокруг.

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

Например, во многих случаях наличие редактора WYSIWYG считается премиальной функцией.

Но если задуматься в более широком плане, есть ли смысл применять универсальность и многогранные переносимые преимущества системы управления контентом (CMS) для катапультирования HAT в 21 век?

Мы бы поспорили, что в случае с WordPress CMS — ведущей в мире платформой для создания веб-сайтов и самым популярным программным обеспечением CMS на милю страны…

…ответ: ДА.

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

Вот оно, руководство HeroThemes по созданию инструмента для создания справки с использованием WordPress.

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

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

• Государственная государственная политика
• ИТ-вычисления
• Финансовые инвестиции
• Недвижимость

… список можно продолжить.

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

По словам Хидра Сулемана, технического писателя по проектированию и обеспечению услуг в цифровой службе правительства Великобритании, в его обычные ежедневные обязанности входит следующее:

• участие в исследованиях пользователей
• создание контент-стратегий
• представление планов старшим заинтересованным сторонам
• проектирование и прототипирование пользовательских путей
• обсуждение, редактирование и (конечно) написание контента

Довольно разнообразно.

Тем не менее, последнее, но не менее важное в этом списке было (конечно) делать то, что они действительно делают.

Но писательство (и особенно техническое письмо) — это скорее процесс, чем деятельность.

Эстафета обязанностей, которые в совокупности приводят к доставке документации.

В двух словах, техническое письмо можно описать как процесс «…сбора, организации и сохранения знаний о быстро меняющихся программных системах» — Atom Bank

Таким образом, повседневная работа технического писателя — это работа с репозиториями и базами знаний.

Например, запись цитат или фрагментов комментариев экспертов. А также получение золотых самородков в виде фактов или данных для проверки аргументов.

Короче говоря, простота хранения данных, поиска и определения местоположения или обнаружения — помимо написания — также являются важными сопутствующими функциями инструмента создания справки.

Что такое инструмент создания справки в 2022 году?

Если верить большинству определений Google на странице 1 для инструмента разработки справки, точное описание должно включать:

1. Изготовление
2. Управление
3. Издательский

… документы.

Большинство утверждают, что лучшей идентификацией была бы «система управления контентом».

Допустим, что этот термин, как правило, включается в статьи, написанные поставщиками CMS (и в этом отношении эта статья ничем не отличается), но если мы рассмотрим точность использования, CMS, в конце концов, является подходящим ярлыком для HAT.

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

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

Это действительно будет зависеть от:

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

В большинстве случаев HAT сосредотачивается на правильном составлении и редактировании основ.

И предложите немного, шаблоны, стили и кодирование сверху.

Но вопрос в том…

…достаточно ли одних этих функций, чтобы удовлетворить высокие требования современного технического писателя?

Почему бы нам просто не спросить несколько?…

1. В этом отрывке отзыва респондент (технический писатель) дает сравнительный обзор традиционной функциональности HAT и традиционной CMS (Drupal):

«Как администратор в Drupal, вы можете просматривать список страниц, но вы можете редактировать свойства только одной страницы за раз. Здесь нет множественного выбора и перетаскивания . Поэтому управление темами может быть очень трудоемким».

«Если вы удалите страницу, все ссылки, указывающие на нее, сломаются , и никаких предупреждающих сообщений не будет.

При создании ссылки на странице вы должны знать путь и имя страницы назначения — полезных списков доступных страниц нет».

«Из коробки нет редактора WYSIWYG . Для большинства пользователей HAT это обязательно. Вы можете писать свой контент только в полном/отфильтрованном html».

(Источник: Вишневый лист)

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

«Фактический поиск: когда пользователь щелкает вкладку поиска и ищет элемент, он может сузить результаты поиска , используя похожие аспекты, как показано на следующем изображении».

«Использование любого из стандартных инструментов разработки — Flare, RoboHelp, Author-It, Doc-to-Help — оставляет вас с нелепой моделью одного автора, работающего с одной точки зрения из одной организации, пытающейся собрать воедино океан Информация. Поскольку эта модель несостоятельна и не масштабируема, HAT уступят место совместным веб-технологиям разработки ».

(Источник: я лучше буду вести блог)

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

Следует ли вам рассмотреть возможность использования системы управления содержимым компонентов (CCMS) для создания справки?

Гранулярность контроля подарков.

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

Именно здесь на помощь приходит компонентная система управления контентом.

Что такое компонентная система управления контентом (CCMS)?

Компонентная система управления контентом — это CMS, элементами контента которой являются не страницы и посты, а фрагменты, абзацы и части контента.

Точно так же, когда вы начинаете создавать новую часть контента в CMS, вы начинаете новую страницу или публикуете.

С CCMS вы запустите новый компонент (часть страницы или сообщение).

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

Почему?

Экономия от масштаба.

Конечно, создание страниц на основе нескольких частей (каждая со своими метаданными, зависимостями и т. д.) требует больше усилий, чем одна свободная цельная часть.

Но с крупномасштабными проектами сложного контента с большим количеством актуальных перекрестных ссылок и внутренних ссылок возможность повторного использования и детальная взаимозаменяемость на уровне компонентов…

… CCMS предлагает большое долгосрочное преимущество командам писателей.

А именно, делать вещи быстрее и точнее.

Рекомендуемые статьи с советами по авторскому инструменту

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

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

Чтобы помочь вам в некоторых рекомендуемых экспертами консультациях по этой теме, мы составили этот краткий список полезных статей, связанных с HAT:

1. Почему шляпы исчезнут
2. 5 причин, по которым я рекомендую использовать облачный инструмент для разработки
3. Что HAT дает вам по сравнению с Drupal?
4. 6 причин использовать программное обеспечение HAT
5. 5 типов авторских инструментов, которые используют технические писатели

Авторы вышеприведенных статей достаточно хорошо говорят о HAT и дают ряд внутренних советов по принятию правильного решения.

Каковы основные особенности HAT?

Итак, мы постепенно формируем наше представление о HAT, о том, что они делают, и о внешних преимуществах, которые мы должны учитывать помимо традиционного подхода.

Но нам все равно стоило бы иметь исчерпывающий справочник по всем вещам, которые HAT деос.

Таким образом, мы можем сравнивать «яблоки за яблоки» при рассмотрении инвестиционного выбора.

Вот список самых распространенных и наиболее полных программных функций HAT:

• Несколько форматов ввода и вывода : импортируйте и экспортируйте данные, используя множество типов файлов.
• Полнофункциональный текстовый процессор : редактор на основе кода и визуальный WYSIWYG-редактор
• Создавайте теги : назначайте тематические теги, чтобы тематически связать статьи.
• Шаблоны тем: получите преимущество в каждой статье с помощью готовых шаблонов.  
• Подсветка синтаксиса : полезные выделения по грамматическим проблемам, которые необходимо решить  
• Теги слияния для общей метаинформации проекта : с легкостью вставляйте многократно используемые фрагменты, используя теги слияния, экономя время и ограничивая количество ошибок.
• Пользовательский HTML, CSS, Javascript: применяйте индивидуальные штрихи к функциям и дизайну с помощью пользовательского веб-кода.
• Объединение содержимого проекта : объединение содержимого в рамках одного проекта для получения смешанного результата.  
• Настраиваемая веб-тема : переключатели, ползунки и флажки для совершенствования внешнего интерфейса инструмента для улучшения взаимодействия с пользователем.
• Репозиторий мультимедиа : аккуратное место для хранения всех ваших изображений, PDF-файлов, аудио- и видеофайлов.  
• Простой пользовательский интерфейс : простота использования со всеми соответствующими элементами управления на легкодоступном расстоянии и в удобном расположении  
• Перевод : многоязычная доставка
• Оглавление : простые в использовании ссылки для перехода в каждой статье для беглого чтения содержимого.  

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

Преимущества создания собственной HAT

Если бы мне нужно было резюмировать главное преимущество создания собственного HAT, я бы сказал:

Владение собственным набором инструментов.

Индивидуальный набор инструментов

Когда у вас как у профессионала есть «то, что вы хотите», «где и как вы хотите», окупаемость инвестиций в виде сэкономленного времени и улучшенных результатов неизмерима.

Вы просто не можете сравнить опыт использования инструментов, сделанных «как раз то, что нужно» для достижения успеха, с набором общих инструментов «сделай сам».

Таким образом, настройка вашей собственной HAT может потребовать значительных предварительных усилий и суеты.

Но в конечном счете все готово для того, чтобы вы побивали свой личный рекорд в каждом проекте.

Расширяемый

Ожидание намеченных улучшений или получение премиальных обновлений не обязательно должно происходить с пользовательским HAT.

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

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

Улучшенная всесторонняя производительность

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

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

Вы легко сделаете то, что раньше считали возможным.

Создание инструмента для создания справки WordPress с помощью плагина базы знаний Heroic

Итак, к настоящему времени, если вы готовы бросить вызов новым водам и сделать решительный шаг в создании собственной шляпы, у нас есть решение для вас.

Легко использовать.

Построен на платформе, используемой более чем 40% всех веб-сайтов в Интернете.

Со всеми лучшими функциями и даже больше.

Вот оно… наше краткое руководство о том, кто может сделать HAT с помощью WordPress.

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

Вот состав:

1. Организация и категоризация страниц и файлов
2. Поиск, голосование, отзывы и аналитика
3. Репликация компонента часто задаваемых вопросов
4. Служба поддержки для обработки запросов через тикеты
5. Индекс страницы оглавления
6. Глоссарий терминов

Коротко о том, «почему WordPress».

Для большинства профессионалов самое главное иметь лучшие инструменты для работы (независимо от того, как это называется).

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

Именно здесь WordPress идеально подходит в качестве платформы для создания собственного HAT.

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

Такие функции, как WYSIWYG и кодирование HTML, CSS и JS, являются стандартными функциями, предлагаемыми WordPress (ведущей в мире системой управления контентом).

Но WordPress также поддерживает хостинг, плагины и темы на полтриллиона долларов.

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

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

Вот обзор рекомендуемых нами шагов для создания собственного онлайн-рынка с использованием WordPress:

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

Используйте подключаемый модуль базы знаний Heroic для создания автоматически связанной и детализированной линейки вашего ранее опубликованного контента HAT.

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

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

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

Используйте плагин Heroic FAQs, чтобы оснастить свою HAT встроенными многоразовыми компонентами с простой установкой и серо-кодом.

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

Используйте плагин Heroic Inbox, чтобы интегрировать почтовый ящик вашей деловой электронной почты в панель администратора WordPress. Это дает вам унифицированный коммуникационный центр в вашей HAT, экономя ваше время, потраченное на навигацию по несвязанному рабочему процессу.

Heroic Table of Contents: ссылки для быстрого чтения ваших статей помогают читателям усваивать информацию и извлекать пользу. Сделайте свои изделия еще более удобными с помощью классического ToC.

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

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

Используйте плагин Heroic Glossary, чтобы установить глоссарий с возможностью поиска в ваш WordPress HAT — без усилий и (опять же) без кода.

Aspose.Words: мгновенно конвертируйте сообщения или страницы WordPress в файлы DOC или DOCX и наоборот. Устраните пробелы в рабочих процессах и сделайте вашу новую систему совместимой с устаревшими документами GDocs или Word.

Используйте плагин Aspose.Words, чтобы включить двунаправленное преобразование файлов между WordPress и GDocs или Word.

Syntax Highlighter Evolved: сделайте веб-код выдающимся, внося пользовательские изменения, помогая вам сосредоточиться на деталях, не отвлекаясь.

Используйте Syntax Highlighter Evolved , чтобы сделать код красивым, когда вы вносите свои изменения в веб.

Вывод

Специально созданные HAT в наши дни таких продвинутых CMS, вероятно, заново изобретают велосипед.

На самом деле не так много (если вообще что-либо) того, что даже самая продвинутая HAT может сделать, чего не может CMS с некоторой конфигурацией.

Кроме того, с CMS у вас есть дополнительные функциональные возможности, которые добавляют преимущества к уже конкурентоспособному предложению.

Дополнительный потенциал, предоставляемый CMS (лидирующий на рынке WordPress с его плагинами), может расширить аналогичное решение HAT за пределы ваших ожиданий.

Достаточно места, чтобы подавить свои собственные зуды и продолжить инновации с WordPress — плюс не требуется кодирование.

Быстро расширяющаяся экосистема сторонних плагинов поддерживает преимущество WordPress на рынке благодаря специализированным продуктам, расширяющим границы возможного.

В целом, мы убеждены, что если вы хотите инвестировать в HAT с расчетом на будущее, WordPress CMS — идеальная цифровая платформа.

Почему бы не начать сегодня?