設計文書のレビューは注意することがポイント

  1. 整合性:いくつかの場所で文書や不完全を見つけるためには、特別な背景知識が必要です。通常、チームは誰もが、特に新規参入者のために、この知識を理解していないでしょう。文書作成者は、この点でより多くの詳細を追加、またはバックグラウンドのこの部分を補足するために外部ドキュメントへのリンクを追加することをお勧めします。
  2. 正し:通常不注意によって引き起こされるエラーの文法、スペル、句読点など、探しでは、コードは、彼らが同様に将来を書くことを意味するものではありません。しかし、あなたはこのようなエラーのためにルールを破ることはできません。
  3. 一貫性:画像とテキストで一貫性のある説明を確実にします。文書が他の文書正反対に対向意見やアイデアが表示されていないことを確認してください。
  4. デザイン:デザインのいくつかはよく考え抜かする文書。ターゲットがスムーズに到達できるかどうか、利用可能なリソースを考えると?あなたが技術のフレームワークを使用したい(フレームワークは、その欠陥を読み、理解できますか?)どのような基礎フレームワークで使用される所望の設計方法が正しいのですか?デザインがあまりにも複雑であるかどうか?それを簡素化することができますか?それとも単純すぎますか?この設計は、何を増やす必要がありますか?
  5. インタフェースとプロトコル:文書で使用されるプロトコルの明確な定義はありますか?製品の外部インタフェースとプロトコルの完全な記述かどうか?彼らの期待と一致しているインタフェースプロトコルを実装するかどうか?他のGoogleサービスのための統一基準を満たしていますか?データ形式のプロトコルバッファをカスタマイズするために、開発者を奨励しています
  6. テスト:あなたはどのようにドキュメントに記載されているシステムまたはシステム全体をテストすることができますか?彼らはまた、ドキュメントに追加されることを確実にするために、必要に応じて、(テスト及びシステムを内部状態情報を表示するために、いくつかのインターフェースを追加するために)追加のテストフックの必要性。アカウントにテスト容易性を取ってシステムの設計、誰にもいくつかの調整をしたかどうか?私は、既存のテストフレームワークを使用することはできますか?我々はすべて何の作業を行う必要があり、テスト、および文書の内容のこの部分についての設計に追加すると推定。

おすすめ

転載: www.cnblogs.com/nlry901/p/11444750.html