短縮形
短縮形の使い方についての説明です。
やわらかめのドキュメントで使う
短縮形は、やわらかめ(フォーマルではない)のドキュメントを書く際に使われます。例えば「can't」、「don't」、「isn't」、「you'll」、「there's」です。
使用許諾契約など一部を除き、IT関連ドキュメントでは短縮形を基本とします。
例1
This isn't ideal. You don't want to send too many notifications to your users.
(引用元:Android Developers、2023-03-01閲覧)
次の例2は使用許諾契約の中の一文です。短縮形は使われていません(「do not」)。
例2
You may not use the SDK if you do not accept the License Agreement.
(引用元:Android Developers、2023-03-01閲覧)
同じドキュメント内で、短縮する形としない形が混在しないようにしましょう。例えば「can't」と「cannot」はどちらか一方を使います。
関連資料
- Google developer documentation style guide
- Microsoft Style Guide