Changelog を英語で書く際に参考になるようなテンプレートをまとめてみました.git や svn のコミットログにも使えます.
- このエントリは今後も逐次更新を続けます(最終更新2018/11/01)
- リリースノートの英文についてはRelease note のための英文テンプレート集 - pyopyopyo - Linuxとかプログラミングの覚え書き -に分離しました
- git等のcommit メッセージにも使えます
以下,例文.
バグ修正した場合
修正した場合 → fix を使うのが定番です
- Fixed a performance regression. (パフォーマンスが低下するバグを修正しました)
- Fix possible memory leak
- Fixed an issue where some devices would display the wrong image. (いくつかのデバイスで間違った画像を表示するバグを修正しました)
- Fixed a possible AAA attack against BBB
- Fixed stability problems with GeForce 8 GPU. (GeForce 8 GPUで動作が不安定になる問題を修正しました)
- Fixed an "AAA" bug that was causing the B to C. (BがCしちゃう,いわゆるAAAバグを修正しました)
- Fixed missing A in B() (関数B内でAが抜けていた不具合を修正しました)
- This fixes a regression for 〜
- This fixes the following bug reported by A. (Aさんが報告してくれた以下の不具合を修正しました)
- Various fixes to the install wizard.
- Some fixes to make installer work.
巻き戻した場合,変更を取り消した場合 → revert を使います.
その他
- Avoid possible crashes on A (時々クラッシュするバグを回避するように修正しました)
- Avoid segfault on A
- Don't crash on A
- Removed obsolete username_max_length.
- Don't use Location header on IIS
- this problem has been fixed この問題は修正済です.
- this problem will be fixed shortly この問題は近々修正されます.
- We recommend that you upgrade your XXX. アップグレードすることをお勧めします.
機能追加した場合
新規機能追加 → Add
- Added support for bridgeless SLI with GeForce 8 GPUs.
その他
- New 3D buttons (新しい3Dボタン (を追加しました))
- New session management, saving up to 3 queries per request.
- Provide more helpful features
- Allow "\n" at the end of line
変更した場合
仕様変更 → Change
- Changed A to B (BできるようにAを変えました)
- Minor changes in A (Aにて,小さな変更を行いました)
- Major changes in A (Aにて,大きな変更を行いました)
仕様変更 → now を使う
- Minimized pages are now hidden (最小化したページは今後は隠されるようになります)
- Avatars are now resized only when needed
改良した場合 → Improve
- Improved compatibility with recent Linux 2.6 kernels. (最近リリースされたlinux-2.6カーネルとの互換性を向上させました)
- Improved device handling. (デバイスの扱いを改良しました)
- Various template improvements.
バージョンアップ → Upgrade
- Upgraded A to version 1.0 (Aのバージョンを1.0に上げました)
その他
よく使う動詞
- fix
- add
- update
- change
- modify
- remove
- set / unset
- enable / disable
- extend
- enhance
- optimize
- improve
- reduce
便利な言い回し
- possible 時々
- a possible crash 時々落ちるバグ
- a possible null pointer dereference 時々ヌルポする件
- the issue 不具合(致命的でないバグは,issueぐらいでやんわりと表現する場合があります)
- the stability issue (不安定になる不具合)
- an issue where the date is not saved into the database (データがDBに保存されない不具合)
なお例文に付けた訳は意訳です.コメントなど歓迎します.
例文の引用元は
- http://www.php.net/ChangeLog-5.php
- http://www.kernel.org/
- http://www.nvidia.com/
- http://usebb.sourceforge.net/cvs/Changelog.txt
- http://www.apache.org/
です.
マスターしておきたい技術英語の基本
posted with amazlet at 09.04.05
おすすめ度の平均:
良書かもしれないが、、理系大学生・院生にお勧めの一冊です.
良書だと思います。
ネイティブチェッカーのような本です。
ビジュアルが素晴らしい
必携技術英文の書き方55のルール
posted with amazlet at 09.04.05
おすすめ度の平均:
携帯して活用座右におきたい本