皆さん、こんにちは！
前回の動画では、製品ドキュメントの作成と編集方法についてお話しました。また、動画、画像、メディア、コードの埋め込み方法もご紹介しました。これにより、お客様に技術プラットフォームやソリューションについてさらに理解していただくための製品ドキュメントを作成できます。
今回は、Docsie製品ドキュメントプラットフォームの詳細に踏み込んで、ソフトウェアドキュメントを簡単に作成する方法をご紹介します。
Docsieで公開する方法についての簡単なチュートリアルです。
Docsieのナレッジポータルでの公開方法はいくつかあります。この動画では、Docsieのナレッジポータル、ブック、シェルフ、記事を1行のコードで公開する方法を説明します。
この例では、「Writing your first Django app, part 2」という特定のブックを公開したいと思います。
すでに作成したソフトウェアドキュメントには「Brand new portal that I am working on」というバージョンがあります。その横にある「鉛筆」ツールをクリックすると、公開されたポータルを「アクティブ」または「プライマリ」にしたり、これらの機能をオフにしたりするオプションがあります。これは素晴らしい機能です。なぜなら、あなたとチームは、作成した製品ドキュメントをウェブサイト上で公開する準備ができるまで、お客様に見えないようにしながら、ドキュメントを作成または更新できるからです。
公開の準備ができたら、ドキュメントをデプロイしましょう！まず、Docsieプラットフォームの右上にある3つのドットをクリックし、次にアカウントをクリックします。
プロフィールと設定ページに移動したら、「Deployments」というタブをクリックします。これでデプロイメントページに移動し、ウェブサイトに配置する埋め込みコードの作成をサポートします。
次に「Configure a new deployment +」をクリックします。
素晴らしい！ダッシュボードにアクセスできたら、カスタムドメインをデプロイするだけです。「Deploy a domain:」タブバーを開き、「custom deployment」をクリックするだけで簡単にできます。
次の2つのステップは簡単です：
-
最初のステップはドメインを入力することです（ドメイン名の前にhttp://またはhttps://を使うことを忘れないでください）
-
2番目のステップは、公開したいものを選ぶことです。ブックまたはシェルフ全体を公開する選択肢があります。この例では、「Writing your first Django app, part 2」というブックを公開しています。
素晴らしい！コードを取得する前の最後のステップは、「+More Options」をクリックすることです。
ここでは、様々なプラグイン、機能、その他のドキュメントオプションを使用して、ナレッジポータルを充実させ、ユーザーにとってより便利なものにすることができます。これらの機能、プラグイン、製品ドキュメントツールは非常に便利で、ナレッジポータルをより堅牢にします。
注：これらの追加機能やプラグイン、その他の製品ドキュメントツールはいつでも変更できます。
完了したら「Create web portal」をクリックします。
次に、一番下までスクロールして「+ Get deployment script」をクリックします。
スクリプトをコピーしてHTMLに貼り付けます：
スクリプトにアクセスできたら、CSSユーザーガイドを使って見栄えを良くすることができます。ブランドのルックアンドフィールに合った、スタイリッシュなDocsieナレッジポータルを作成するのに役立ちます。こちらのリンクでスタイリングユーザーガイドをご確認ください：Docsieのスタイリングガイド
このチュートリアルが気に入っていただければ幸いです。今後もDocsieのチュートリアルをお楽しみに！
Docsieがどのようにお役に立てるかについてご質問があり、ツールのデモをご覧になりたい場合は、こちらをクリックしてデモのご予約をお願いします。