WordPressを使用してヘルプオーサリングツールを構築する方法

公開: 2022-04-28

優れたテクニカルライターは、信頼できるヘルプオーサリングツール（HAT）から遠く離れることはありません。

テクニカルライティング業界の主力製品であるヘルプオーサリングツールは、負担を軽減し、「複雑なものをわかりやすくする」という芸術を変革します。

HATは、テクニカルライターの生産性を最大化するものです。 10倍のテクニカルライターは、ゲームのこちら側をしっかりと設定しています。

コピーを形作り、編集する反復ラウンドの非常に多くのフェーズで、目的に完全に適合するように着陸させます…

…あなたは本当にあなたと一緒に働き、あなたが最高の文学製品を処方することにあなたのすべての努力を集中するのを助けるHATを必要としています。

HATの概念は新しいものではありません。

彼らは周りにいます。

そして、家族の写真だったとしたら、犬の耳がわずかになり、セピア色になり、関連性が薄れてしまうかもしれないと言う人もいるかもしれません。

たとえば、多くの場合、WYSIWYGエディターを所有することはプレミアム機能と見なされます。

しかし、もっと横方向に考えると、コンテンツ管理システム（CMS）の多様性と多面的な転送可能な利点を適用してHATを21世紀にカタパルトするケースはありますか？

WordPress CMSの場合、世界をリードするWeb構築プラットフォームであり、カントリーマイルで最も人気のあるCMSソフトウェアであると主張します…

…答えは：はい。

しかし、私たちの言葉をそのまま受け入れるのではなく、次の数分で、~~スライスされたパンの~~エスプレッソコーヒー以来、WordPressCMSがテクニカルライターにとって次善の策である理由をもう少し深く掘り下げてみませんか。

これが、WordPressを使用してヘルプオーサリングツールを構築するためのHeroThemesガイドです。

今日のテクニカルライターの典型的な要求

今日のテクニカルライティングは、多くの専門分野にまたがっています。

政府の公共政策
ITコンピューティング
金融投資
不動産

…リストは続きます。

しかし、全体を通して共通しているのは、技術の世界への複雑さの翻訳者であるという厳しい要求が日常業務です。

UK Government DigitalServiceのテクニカルライター、サービスデザインおよびアシュアランスであるKhidr Sulemanによると、彼の通常の日常業務は次のとおりです。

ユーザー調査への参加
コンテンツ戦略の作成
上級の利害関係者に計画を提示する
ユーザージャーニーの設計とプロトタイピング
コンテンツについて話し合い、編集し、（もちろん）書く

かなり多様です。

それでも、最後になりましたが、そのリストの重要な点は、（もちろん）彼らが実際に行っていることを行っていたことです。

しかし、執筆（特にテクニカルライティング）は、活動ではなくプロセスです。

集合的に文書の配信につながる職務のリレーレース。

一言で言えば、テクニカルライティングは、 「…急速に変化するソフトウェアシステムに関する知識の取得、整理、および維持」のプロセスであると説明できます– Atom Bank

そのため、テクニカルライターの生活に共通する特徴は、リポジトリとナレッジベースの処理です。

たとえば、引用や専門家の解説の抜粋を記録します。また、引数を検証するためにファクトまたはデータの形式でゴールデンナゲットを取得します。

要するに、データの保存、検索、場所の特定、または発見の容易さは、書き込み以外にも、ヘルプオーサリングツールの重要な関連機能です。

2022年のヘルプオーサリングツールとは何ですか？

ヘルプオーサリングツールの1ページ目のGoogle定義の大部分を信じる場合、正確な説明には次のものを含める必要があります。

作る
管理します
出版

…ドキュメント。

ほとんどの人は、より良いアイデンティティは「コンテンツ管理システム」であると主張しています。

この用語はCMSベンダーによって書かれた記事に含まれる傾向があることは確かですが（その点では、この記事に違いはありません）、正確さの使用を検討すると、CMSは結局HATに適したラベルです。

文字通り、テクニカルライターの作成者のヘルプドキュメントを支援します。

私たちが助けによって何を意味するのかを正確に特定する限り、あなたがそれをどれだけ広く取ることができるかについての厳格な規則はないと思います。

それは本当に依存するでしょう：

ソフトウェアメーカーがテクニカルライティングの分野をどれほど深く知っているか、そして;
彼らが必要を満たすためにどれほど説得されたか

ほとんどの場合、HATは製図と編集の基本を正しく行うことに重点を置いています。

そして、少し、テンプレート化、スタイリング、コーディングを上に提供します。

しかし、問題は…

…これらの機能だけで、現代のテクニカルライターの急な要求を満たすのに十分ですか？

少しだけ聞いてみませんか？…

このフィードバックの抜粋では、回答者（テクニカルライター）が従来のHAT機能と従来のCMS（Drupal）の比較レビューを行っています。

「Drupalの管理者は、ページのリストを表示できますが、一度に編集できるのは1ページのプロパティのみです。 複数選択やドラッグアンドドロップはありません。 そのため、トピック管理は非常に面倒な場合があります。」
「ページを削除すると、そのページを指すすべてのリンクが壊れ、警告するメッセージは表示されません。

ページにリンクを作成するときは、リンク先ページのパスと名前を知っている必要があります。利用可能なページの役立つリストはありません。」
「箱から出して、WYSIWYGエディターはありません。 大多数のHATユーザーにとって、これは必須です。 コンテンツは、完全な/フィルタリングされたhtmlでのみ書き込むことができます。」
（出典：チェリーリーフ）

このコメントでは、別のキャリアテクニカルライターが、HATソフトウェアの将来のトレンドになると彼が考える2つの理想的な機能について説明しました。

「ファクト検索：ユーザーが検索タブをクリックしてアイテムを検索すると、次の画像に示すように、ユーザーは同様のファセットを使用して検索結果を絞り込むことができます。」

「標準のオーサリングツール（Flare、RoboHelp、Author-It、Doc-to-Help）のいずれかを使用すると、単一の組織の単一の視点から作業して、情報。 そのモデルはサポートできず、スケーラブルではないため、 HATは、協調的なWebベースのオーサリングテクノロジーを優先して衰退します。」
（出典：私はむしろブログを書きたい）

上記の洞察は、HATの従来の感覚の範囲を拡大し、テクニカルライティングの生産性を高めるためのより動的で協調的なプラットフォームを含みます。

ヘルプオーサリングにコンポーネントコンテンツ管理システム（CCMS）の使用を検討する必要がありますか？

粒度ギフトコントロール。

また、テクニカルライティングの分野では、生産サイクル内での制御が強化されるという利点により、効率が向上し、プロジェクトのROIが向上します。

これがまさにコンポーネントコンテンツ管理システムの出番です。

コンポーネントコンテンツ管理システム（CCMS）とは何ですか？

コンポーネントコンテンツ管理システムは、コンテンツのアイテムがページや投稿ではなく、スニペット、段落、コンテンツ部分であるCMSです。

CMSで新しいコンテンツを作成する場合と同じように、新しいページまたは投稿を開始します。

CCMSを使用すると、新しいコンポーネント（ページまたは投稿の一部）を開始します。

多くの部分がページ全体を構成するため、ページ全体と投稿の最終結果は同じですが、それらの作成方法は小さなチャンクに分割されます。

なんで？

規模の経済。

確かに、1つの自由に流れる全体ではなく、複数の部分（それぞれが独自のメタデータや依存関係などを持つ）に基づいてページを構築する方が、間違いなく多くの作業になります。

しかし、多くのトピックのクロスオーバーと内部参照を伴う大規模で複雑なコンテンツプロジェクトでは、コンポーネントレベルでの再利用性ときめ細かい互換性があります…

…CCMSは、チームを作成する上で長期的に大きな利点を提供します。

つまり、物事をより迅速かつ正確に行うことです。

HATの主な機能は何ですか？

そのため、従来のアプローチに加えて、HAT、HATの機能、および考慮すべき外部の利点についての見方を徐々に固めています。

しかし、HATが行うすべてのことについて、包括的なリファレンスを用意することは、それでも価値があります。

このようにして、投資の選択を検討する際に「リンゴとリンゴ」を比較できます。

最も一般的で最も包括的なHATソフトウェア機能のリストは次のとおりです。

複数の入力および出力形式：多くのファイルタイプを使用してデータをインポートおよびエクスポートします
フル機能のワードプロセッサ：コードベースとビジュアルの両方のWYSIWYGエディタ
タグの作成：トピックタグを割り当てて、記事をテーマ別に関連付けます
トピックテンプレート：事前に作成されたテンプレートを使用して、すべてのピースで有利なスタートを切る
シンタックスハイライト：解決する文法上の問題に関する役立つハイライト
プロジェクト全体のメタ情報のタグをマージ：マージタグを使用して再利用可能なスニペットを簡単に挿入し、時間を節約し、エラーを制限します
カスタムHTML、CSS、Javascript：カスタムWebコードを使用して機能とデザインに合わせたタッチを適用します
プロジェクトコンテンツのマージ：同じプロジェクト内のコンテンツを組み合わせて、ブレンドされた結果を生成します。
カスタマイズ可能なWebテーマ：ツールのフロントエンドを完成させてユーザーエクスペリエンスを向上させるためのスイッチ、スライド、チェックボックス
メディアリポジトリ：すべての画像、PDF、オーディオ、ビデオファイル用のすっきりとしたストレージエリア
簡単なユーザーインターフェース：距離とポジショニングに簡単に到達できるように、関連するすべてのコントロールで簡単に使用できます
翻訳：多言語配信
目次：コンテンツを読み飛ばすための各記事の使いやすいジャンプリンク

そこにある専用のHATの中で、上記のポイントは、内部で予想されることの大部分をカバーしています。

カスタムHATを構築する利点

カスタムHATを構築することの主な利点を要約する必要がある場合、次のように言います。

独自のツールセットの習得。

カスタマイズされたツールセット

専門家として「必要なもの」、「必要な場所と方法」がある場合、時間の節約と改善された結果への投資収益率は計り知れません。

成功のために「ちょうどいい」ツールを使用した経験と、一般的な「makedo」機器のセットを使用した経験を比較することはできません。

したがって、独自のHATをカスタマイズするには、かなりの先行作業と手間がかかる可能性があります。

しかし、長期的には、すべてのプロジェクトで自分のベストを打ち負かすシーンが設定されています。

拡張可能

ロードマップされた改善を待ったり、プレミアムアップグレードに絞り込まれたりすることは、カスタムHATで発生する必要はありません。

もちろん、ツールの保守と改善は自分で行う必要がありますが、ほんの少しのDIY時間で、HATの有効期間を適切に延長できます。

要するに、HATが良くなるにつれて、結果も良くなります。

オールラウンドなパフォーマンスの向上

カスタムビルドのHATは、テクニカルライティングワークフローからすべてのささいなまたは邪魔な煩わしさを取り除きます。

すべてのボトルネックと時間の浪費を取り除き、次の風でプロジェクトを終了するための競争を可能にする機能、オプション、および構成に置き換えます。

以前は可能だったと思っていたものを簡単にピップできます。

Heroicナレッジベースプラグインを使用したWordPressヘルプオーサリングツールの作成

ですから、もしあなたが新しい海に勇敢に立ち向かい、思い切ってあなた自身のHATを作る準備ができているなら、私たちはあなたのための解決策を持っています。

使いやすい。

オンラインのすべてのWebサイトの40％以上で使用されているプラットフォーム上に構築されています。

すべての最高の機能に加えて、さらに多くの機能を備えています。

これが…WordPressを使用してHATを作成する人に関するクイックガイドです。

そして最良の部分は、コードがまったく含まれていないことです。この方法は非常に初心者に優しいです。

ラインナップは次のとおりです。

ページとファイルの整理と分類
検索、投票、フィードバック、分析
FAQコンポーネントの複製
チケットを介した問い合わせを処理するためのヘルプデスク
目次ページの索引
用語集ライブラリ

「なぜWordPressなのか」について簡単に説明します。

ほとんどの専門家にとって、仕事に最適なツールを持っていることは（それが何と呼ばれているかに関係なく）最も重要なことです。

あなたが成果物に没頭し、あなたを掘り出すためにいくらかのトルクを備えたエンジンを必要とするので、意味論または名前の呼びかけはあまり重要ではありません。

これは、WordPressがカスタムHATを作成するためのプラットフォームとして理想的な場所です。

まず、この記事で前述した機能ラインナップのすべての重要なボックスにチェックマークを付けます。そしてそれは、そのコア製品で箱から出してすぐに、それを簡単に行います。

WYSIWYGやHTML、CSS、JSコーディングなどの機能は、WordPress（世界をリードするコンテンツ管理システム）が提供する標準機能です。

しかし、WordPressは、5兆ドルのホスティング、プラグイン、テーマエコノミーもホストしています。

これらのプレーヤーは、ツールを目的に合わせてカスタマイズするファーストクラスの拡張機能とパフォーマンス支援を提供する責任があります。

全体として、WordPressとそのプラグインコンパニオンは、独自のセットアップをDIYしたいテクニカルライターのためにHATを提供する夢のチームになります。

WordPressを使用して独自のオンラインマーケットプレイスを構築するための推奨手順の概要は次のとおりです。

サイロ化されたカテゴリのディレクトリホームページ：完了したプロジェクトと調査したリソースの参照ライブラリインデックスとして機能するハブページ。テクニカルライティングログにアクセスするためのすっきりとしたキャッチオールの場所。

Heroicナレッジベースプラグインを使用して、以前に公開したHATコンテンツの自動的にリンクされた項目別のラインナップを作成します。

検索、投票、フィードバック、分析： WordPress HATソリューションの機能にダイナミズムとエンゲージメントを統合した記事の中で、貢献している技術著者からのコラボレーションの呼びかけに注目してください。検索、フィードバック、洞察を提供することは、より大きな改善を開発するのに役立つだけです。

Heroicナレッジベースプラグインを使用して、製品の反復的な改善ロードマップを指示するためのユーザー調査の機能強化を有効にします。

FAQコンポーネントの複製：よくある質問に対してきめ細かいコンポーネント制御を構成し、より大規模なプロジェクトをスケーリングするためのよりスリムな本番環境を利用できるという利点を提供します。

Heroic FAQプラグインを使用して、簡単なインストールとセロコードを備えた組み込みの再利用可能なコンポーネントでHATを調整します。

チケットを介した問い合わせを処理するためのHeroicInbox： WordPressインストール内にある応答性の高い電子メールヘルプチャネルを提供するユーザーサポートチケットを便利にフィールド化するため。

Heroic Inboxプラグインを使用して、ビジネス用メールの受信トレイをWordPress管理ダッシュボードに統合します。これにより、HAT内のユニファイドコミュニケーションハブが提供され、ばらばらのワークフローのナビゲートに費やす時間を節約できます。

英雄的な目次：記事の速読を容易にするジャンプリンクは、読者が情報を消化し、価値を引き出すのに役立ちます。クラシックなToCを使用して、作品をさらに消費しやすくします。

Heroic目次を使用して、自動入力の目次を各記事に追加します。

Heroic Glossary：プロジェクトのキーワードの定義にアクセスするためのショートカットとして有用な用語のAZリストを編集し、新しいプロジェクトをスクライブしながらアジャイルを維持します。

Heroic Glossaryプラグインを使用して、検索可能な用語集をWordPress HATにインストールします。汗をかきません。また、コードもありません。

Aspose.Words： WordPressの投稿またはページをDOCまたはDOCXファイルに即座に変換します。その逆も同様です。ワークフローのギャップを埋め、新しいシステムを従来のGDocまたはWordドキュメントアセットと互換性のあるものにします。

Aspose.Wordsプラグインを使用して、WordPressとGDocsまたはWord間の双方向ファイル変換を有効にします。

シンタックスハイライトの進化：カスタム編集を行うときにWebコードを目立たせ、気を散らすことなく詳細を把握できるようにします。

シンタックスハイライト進化を使用して、Webに精通した編集を行うときにコードを美しくします。

結論

このような高度なCMSの最近の目的に合わせたHATは、おそらく車輪を再発明しています。

実際には、最も高度な機能を備えたHATでさえ、いくつかの構成を備えたCMSでは実行できなかったことが（あるとしても）多くはありません。

さらに、CMSを使用すると、すでに競争力のある製品に利点を追加する追加機能があります。

CMS（プラグインを備えた市場をリードするWordPress）によって提供されるさらなる可能性は、あなたの期待を超えて、同様のHATソリューションを拡張することができます。

自分のかゆみを掻き取り、WordPressで革新を続けるための十分な余地があります。さらに、コーディングは必要ありません。

急速に拡大しているサードパーティのプラグインエコシステムは、WordPressの市場シェアの優位性を、可能性の限界を押し上げるための特殊な製品でサポートしています。

全体として、将来を見据えたカスタムHAT投資を検討している場合、WordPressCMSは理想的なデジタルプラットフォームであると確信しています。

今日から始めてみませんか？