Ferndesk
Ferndeskは、コードベースや実際のツールとドキュメントの正確性を照合検証し、手動レビュー用の更新下書きを作成するソフトウェアヘルプセンタープラットフォームです。
Ferndeskは、コードベースや実際のツールとドキュメントの正確性を照合検証し、手動レビュー用の更新下書きを作成するソフトウェアヘルプセンタープラットフォームです。
製品の機能と公式な位置づけ
Ferndeskは、製品ドキュメントを継続的なソフトウェアリリースと同期させ続けるために設計されたナレッジベースおよびヘルプセンターソリューションです。ソースコードリポジトリ、本番稼働中のアプリケーション、サポートチャネルに直接接続することで、製品の変更内容を監視し、既存記事内の陳腐化した記述を特定して、人間による確認用の修正案を作成します。
ドキュメントの自動検証やプルリクエスト連動の下書き作成に加え、Ferndeskにはセルフサービス配信ツールも搭載されています。これには公開Webポータル、AI対話応答を備えた埋め込み可能なアプリ内ウィジェット、インタラクティブなOpenAPIリファレンスページ、OIDCやJWTで保護された非公開ドキュメント、多言語ローカライズ管理機能が含まれます。
公式情報で確認できる活用例
開発チームはプルリクエストがマージされるたびにドキュメントの下書きを自動生成できるため、機能がデプロイされる前に製品の変更点が文書化されている状態を維持できます。
サポートチームは単一のスクリプトによるウィジェットをアプリケーション内に導入し、検索、検証済みのAI回答、チケットのエスカレーションをアクティブユーザーへ直接提供できます。
従来のヘルプデスクから移行する組織は、URL構造や検索エンジンのインデックスを維持したまま、既存の記事や画像をそのままインポートできます。
公式情報に記載された利用手順
コードリポジトリ、稼働中の製品環境、カスタマーサポートの受信トレイをFerndeskプラットフォームに連携します。
システムは既存のヘルプ記事を製品の挙動やマージされたプルリクエストと比較し、陳腐化した記述を検出します。
プラットフォームは、変更理由の説明とともに、提案されたテキストの修正、新規記事、またはスクリーンショットの更新案を用意します。
チームメンバーが提案された改訂内容を評価し、顧客向けチャネルへ公開される前に承認を行います。
Ferndeskは、カスタマーサポートの流れや実際のソフトウェア環境と並行してGitHubなどのリポジトリを監視することで、技術的な開発変更とユーザー向けサポートコンテンツの橋渡しを行います。ソフトウェアの修正を反映するために手動の執筆作業に頼るのではなく、プラットフォームが基盤となるコードロジックやUIの変更とドキュメントの記述を直接照合・検査します。
不一致が検出された場合やプルリクエストがマージされた場合、プラットフォームは機能がユーザーに届く前に関連する修正や新規記事を下書きします。提案された変更点には何がなぜ変更されたのかが明確に示され、公開前には管理者やチームメンバーによるテキストの確認と承認が求められます。
ドキュメントの保守にとどまらず、Ferndeskは顧客セルフサービス向けのマルチフォーマット配信プラットフォームとしても機能します。カスタムドメインやサブパスに設定された公開ヘルプポータルをサポートし、標準的なWeb検索エンジンや対話型AIシステムによるクロールに適した構造を備えています。
また、プラットフォームはOpenAPIスキーマに基づくAPIリファレンスを統合しており、通常のヘルプガイドのすぐ隣でインタラクティブなプレイグラウンドを提供します。トークンベースのアクセス機構を利用して限定された対象者に安全にコンテンツを配信したり、ローカライズされたルーティングによって多言語に展開したりすることが可能です。
自分の素材とワークフローで確認したい項目
確認した情報源とその日時
情報源を確認した製品情報に基づく回答
いいえ、Ferndeskは自身のシステム内でホストされているドキュメントのみを検証および更新します。外部チケットシステムはそのまま利用できますが、既存のヘルプセンターはFerndeskにインポートする必要があります。
いいえ、コンテンツが本番環境に公開される前に、チームメンバーが下書きされた更新内容をレビューして承認する必要があります。
Ferndeskは記事、画像、パスをそのままインポートし、確立されたURLと検索エンジンのインデックスを維持するために自動的にリダイレクトを作成します。
セルフサービスウィジェットで顧客の問い合わせを解決できない場合、会話をIntercom、Zendesk、またはHelp Scoutに引き継ぐことができます。
非公開ドキュメントは、マジックリンク認証、OIDC、またはJWTトークンを使用してアクセス制限および保護を行うことができます。