Version: 2019.1
オフラインドキュメンテーション
パッケージ

ドキュメント編集レビュー

Unity のユーザーマニュアルには「編集レビュー」という状態を含むものがあります。

「編集レビュー」とは何を意味するのか?

これは、テクニカルライターが開発者から手を加えていない記述を取得し、開発者と協力して、ドキュメントが正しく、完全で、良い文章で書かれ、分かりやすいことを確認するためのドキュメンテーション処理です。

  • 「編集レビューなし」は、そのページにドキュメンテーション処理を行わず、何も手を加えていない記述が含まれていることを意味します。
  • 「編集レビュー済」は、そのページにドキュメンテーション処理を行ったことを意味します。
  • 「限られた編集レビュー」は、そのページの一部の文章や節にドキュメンテーション処理を行ったことを意味します。ページ全体で処理が完了しているわけではありません。

技術ドキュメンテーション処理に関する情報は Technical writing, Technical communicationTechnical editing を参照してください。

なぜ Unity は編集レビューなしにドキュメントを公開するのでしょうか?

編集レビューには時間がかかります。Unity が編集レビューなしにドキュメントを公開するのは、ユーザーにできる限り早く情報を伝えたいからです。

編集レビューなしのページはあまりよくないですか?

一般的には、そのようなことはないです。編集レビューなしのベージは、開発者の説明で、内容が濃く、情報がもっとも正しいソースです。しかし、編集レビューなしのページは、技術ドキュメンテーションの標準を満たすように編集されていないため、読みにくかったり理解しにくかったりする場合があります。

なぜ一部のページには編集レビューの状況が示されていないのですか?

新しく作成されたページと、2017 年 5 月 8 日以降に更新されたページにのみこの情報が表示されています。

ドキュメンテーション編集レビューに関してフィードバックがほしいですか?

はい、お願いします。ページに評価をつけ、各ページの一番下にある フィードバックフォーム を使って、フィードバックを提出できます。

ドキュメンテーションフィードバックフォームから一般のサポートを行うことはできません。サポートが必要な場合は、ユーザーチャンネルを通して サポートリクエスト を送信し バグレポート に報告してください。


オフラインドキュメンテーション
パッケージ