Red Hatの森若です。
今回はRed Hatのドキュメントへのフィードバックを簡単に行うための仕組みを紹介していきます。
ドキュメントへのフィードバック
ドキュメントを読んでいておかしい点や、それらしい章を読んでも知りたいことがわからないような場合には、フィードバックを送りたくなります。従来はサポートケースを開いて修正依頼やフィードバックをいただいていたのですが、もっと簡単に今読んでいるドキュメントにフィードバックを送る仕組みがあればお客様がフィードバックを送りやすくなり、結果的にドキュメントの品質が向上することも期待できます。
Red Hatのドキュメントチームはフィードバックを簡単にするために、1年以上前から徐々に準備を進めています。既に一部のドキュメントでパイロット的な運用がはじまっているのですが、新しい仕組みを利用してドキュメントへのフィードバックが簡単にできるようになりつつあります。
フィードバックの仕組み
先日公開された RHEL 8 Betaのドキュメントを例にしてこの仕組みを見ていきましょう。
フィードバックを行うにはログインが必要なので、まずRed Hatカスタマーポータルにログインします。 ここでは以下のドキュメントを例にとってみます。
Chapter 2. Getting started with virtualization in RHEL 8 - Red Hat Customer Portal
既存フィードバックの確認
以下で赤く囲んだところに「Feedback」と書かれています。
このボタンをクリックすると、ページごとにフィードバックの一覧が表示され、ここで過去に記入されたフィードバックが見えるようになっています。
新規にフィードバックをおこなう
実際に気になる箇所にフィードバックをしてみましょう。ドキュメント中の気になる箇所を選択すると、「Add Feedback」と書かれた青い吹き出しが表示されます。
この吹き出しをクリックすることで、さきほど既存のフィードバックを確認した箇所にフィードバックの記入欄が表示されます。ここに英語でコメントを書き込みます。
Submitボタンを押すと、このドキュメントについてのbugzillaのケースが自動的に作成されます。(英語をさておけば)簡単ですよね?
フィードバックをする時の注意点
現在フィードバックフォームを利用できるのは、一部の新しいドキュメントを英語の"Multi-page HTML"形式で表示している場合に限られます。特にリリースノートなどは"HTML Single"で表示することが多いかと思いますが、その場合はこの仕組みを利用できないためご注意ください。
このフィードバックは一般に公開され、特に第三者からコメント内容を隠すようなオプションは存在しません。フィードバック中に注意が必要な情報を含む場合には従来どおりサポートケースをご利用ください。
