SHOEISHA iD

※旧SEメンバーシップ会員の方は、同じ登録情報(メールアドレス&パスワード)でログインいただけます

DeveloperZine(デベロッパージン)- エンジニアの意思決定を支える技術情報メディア ProductZine

CodeZine編集部では、現場で活躍するデベロッパーをスターにするためのカンファレンス「Developers Summit」や、エンジニアの生きざまをブーストするためのイベント「Developers Boost」など、さまざまなカンファレンスを企画・運営しています。

特集記事

ドキュメント作成に役立つ「日本語スタイルガイド」の紹介

読みやすいドキュメントを書くために


どちらのスタイルガイドを選ぶべきか?

 SunとMicrosoftのスタイルガイド、どちらをプロジェクトに適用すべきでしょうか?

 筆者の主観であることをお断りしておきますが、基本的にはSun版、Microsoftの開発ツールを利用するプロジェクトの技術者向けドキュメントならばMicrosoft版、がいいと思います。

 ずいぶんMicrosoft版を推奨する範囲が狭くなってしまいましたが、Microsoft版は、純粋に日本語文章としてみた場合は不自然さを感じます(具体的に不自然な点を指摘しろと言われると困りますが、開発者の皆さまは、MSDNとJavadoc、どちらが自然だと思いますか?)。

ドキュメント作成のポイント

スタイルチェック担当者を置く

 ドキュメントを作成する際は、以下の流れで行うとよいと思います。

  1. まずはドキュメント作成者全員にスタイルガイドを読んでもらう。
    • 1人はスタイルチェック担当とし、スタイルガイドに精通してもらう。
  2. スタイルガイドに従いドキュメントを作成する。
    • カタカナ語は用語検索データベースで検索し、表記を統一する。
  3. スタイルチェック担当がチェック&校正を行う。
  4. スタイルチェック終了後、ドキュメントそのもののレビューを行う。
  5. 修正点があれば、2~4を繰り返す。

 スタイルチェック担当を置くのがミソです。全員が最初からスタイルガイドに精通するのは難しいので、スタイルチェック担当にチェックしてもらいましょう。

全文検索ツールの活用

 スタイルチェック担当は、Google Desktop SearchWindows デスクトップ サーチ (Vistaでは標準搭載) などの全文検索ツールを活用しましょう。誤った表現を見つけたら、その表現をドキュメント全体で全文検索を行い、ひとつひとつ修正していきましょう。

最後に

 「日本語スタイルガイド」は、仕様書やマニュアルを書くときだけではなく、わかりやすい日本語文章を書く上でとても参考になります。ドキュメント作成を担当される方のみならず、すべての技術者の方々にご一読をお勧めします。

この記事は参考になりましたか?

連載通知を行うには会員登録(無料)が必要です。
既に会員の方はを行ってください。
特集記事連載記事一覧

もっと読む

この記事の著者

佐藤 龍之介(サトウ リュウノスケ)

某SIer にて、主にWeb系開発プロジェクトに従事。 趣味はラーメン食べ歩き。 

※プロフィールは、執筆時点、または直近の記事の寄稿時点での内容です

この記事は参考になりましたか?

この記事をシェア

CodeZine(コードジン)
https://codezine.jp/article/detail/2669 2008/08/26 14:17

イベント

CodeZine編集部では、現場で活躍するデベロッパーをスターにするためのカンファレンス「Developers Summit」や、エンジニアの生きざまをブーストするためのイベント「Developers Boost」など、さまざまなカンファレンスを企画・運営しています。

新規会員登録無料のご案内

  • ・全ての過去記事が閲覧できます
  • ・会員限定メルマガを受信できます

メールバックナンバー