ドキュメント作成で気を付けるべきポイント ~体裁編~
新人の皆さんは、テストを担当することも多いかと思います。
そこで、
今回は仕様書作成にあたって、とくに仕様書の体裁についてフォーカスして、
先輩方にアドバイスいただいたことを思い出しながら、ご紹介していこうと思います。
以下のポイントを踏まえて、仕様書やエビデンス作成を頼まれた際は、参考にしていただければと思います。
ドキュメント作成で意識すべきポイントは?
印刷プレビューです。
納品物であるドキュメントは、今はあまりないかもしれませんが、
お客様によっては、紙媒体で共有する場面があるかもしれません。
どのため
ドキュメントを印刷したとき、見やすいものになっているかな?と意識するようにしましょう。
作成中はあまり意識しにくいと思うので、注意が必要です。
顧客会社名
主に、表紙や各ページフッターに記載されることが多いです。
特に数年前に作成されたドキュメント(仕様書などのこと)の改定版を作成する場合、
顧客会社名が稀に改名されている場合があります。
お客様の会社名を間違うことは大変失礼なことになるため、絶対間違えてはいけないポイントですね。
コピーライト
コピーライトという言葉を初めて聞いたという人もいるかと思います。
納品物のドキュメントを印刷プレビュー機能などで見てみると、
フッター部分にこのコピーライトが付いると思います。
コピーライトとは、単純に著作権のことを指します。
簡単に言ってしまうと、よく商品などについている「Ⓒ~」のあれです!
コピーライトとは?
コピーライト(Copyright**)とは、単純に著作権のことを指します。 著作権は、著作物に対する権利を主張できるものであり、それは本だったり、音楽、映画、漫画なども著作物になります。 そして、Webページも著作物に含まれます。 また、著作権表示とは著作物につけられている発行年等を表す表示のことです。
ページ番号
ドキュメントによっては、
ページ番号が付いていた方が見やすくなります。
印刷プレビュー機能を使って、ページ番号が付いていることを確認しましょう。
…もし、ページ番号を付いていない場合
[ページレイアウト]からヘッダーやフッターにページ番号を設定することができます。
改ページ
印刷物をイメージして、仕様書の不要部分を除いた印刷範囲を指定するようにしましょう。
特に、ドキュメントの中には、テスト結果のエビデンス(画面キャプチャなど)が含まれている場合があります。
ドキュメントに画面キャプチャが張り付けられている場合は要注意です。
画像キャプチャが印刷範囲からはみ出している場合があるからです。
下記のように、改ページを調整するようにしましょう。
印刷範囲に画像キャプチャが収まるように縮小する
「改ページ挿入」機能で画像に合わせて、改ページを挿入する
こんなときどうする?!
まとめ
納品物のドキュメントを作る際は、
印刷したときのことも考えて作成しよう!
ということでした。
あくまで、私の案件の場合は、という話かもしれませんが、
ご参考までに。