どちらのスタイルガイドを選ぶべきか?
SunとMicrosoftのスタイルガイド、どちらをプロジェクトに適用すべきでしょうか?
筆者の主観であることをお断りしておきますが、基本的にはSun版、Microsoftの開発ツールを利用するプロジェクトの技術者向けドキュメントならばMicrosoft版、がいいと思います。
ずいぶんMicrosoft版を推奨する範囲が狭くなってしまいましたが、Microsoft版は、純粋に日本語文章としてみた場合は不自然さを感じます(具体的に不自然な点を指摘しろと言われると困りますが、開発者の皆さまは、MSDNとJavadoc、どちらが自然だと思いますか?)。
ドキュメント作成のポイント
スタイルチェック担当者を置く
ドキュメントを作成する際は、以下の流れで行うとよいと思います。
- まずはドキュメント作成者全員にスタイルガイドを読んでもらう。
- 1人はスタイルチェック担当とし、スタイルガイドに精通してもらう。
- スタイルガイドに従いドキュメントを作成する。
- カタカナ語は用語検索データベースで検索し、表記を統一する。
- スタイルチェック担当がチェック&校正を行う。
- スタイルチェック終了後、ドキュメントそのもののレビューを行う。
- 修正点があれば、2~4を繰り返す。
スタイルチェック担当を置くのがミソです。全員が最初からスタイルガイドに精通するのは難しいので、スタイルチェック担当にチェックしてもらいましょう。
全文検索ツールの活用
スタイルチェック担当は、Google Desktop Search、Windows デスクトップ サーチ (Vistaでは標準搭載) などの全文検索ツールを活用しましょう。誤った表現を見つけたら、その表現をドキュメント全体で全文検索を行い、ひとつひとつ修正していきましょう。
最後に
「日本語スタイルガイド」は、仕様書やマニュアルを書くときだけではなく、わかりやすい日本語文章を書く上でとても参考になります。ドキュメント作成を担当される方のみならず、すべての技術者の方々にご一読をお勧めします。
