ソフトウエアの変更種類をあらわすシンボルとして何がふさわしいでしょうか?


ソフトウエアをバージョンアップする場合、
今回のバージョンアップはどういう内容の変更かを示す
簡単なドキュメントファイルを添付したいと思います。
その場合、変更の種類を冒頭につけるとして
バグ対応なら、

 BUGFIX: ログイン名が128文字を超えるとバッファオーバーフロー

というように、BUGFIXというシンボルをつけます。
同様なシンボルをつけるとして、他に以下の種類分けに対応した
シンボルとして何がふさわしいでしょうか?

1:機能の追加
2:すでにある仕様の変更
3:処理方式の変更(機能や仕様の追加変更は無い)
4:コードをキレイにしただけ(機能や仕様、方式の追加変更は無い)

文字数は英単語x2程度の長さまで、
英語としておかしくない。がのぞましいです。

あるいは、このような変更の種類分けとシンボルについて
「このようにする」というような例が示されているページがあれば
それを紹介してください。

回答の条件
  • URL必須
  • 1人2回まで
  • 登録:2005/06/11 08:02:05
  • 終了:--

回答(4件)

id:Nara-Chan No.1

Nara-Chan回答回数186ベストアンサー獲得回数12005/06/11 08:47:56

ポイント25pt

id:aukjs

ベタですね。

2005/06/11 12:06:04
id:tonolove No.2

tonolove回答回数158ベストアンサー獲得回数02005/06/11 09:55:50

ポイント25pt

現場で特に規定が無い場合は、

+----------------------------------

| 2005/06/07

| APPEND: XXX機能の追加

|      詳細~XXXXXXXXXXXXXX

| MODIFY: XXX機能の変更

| 2005/06/06

| APPEND: XXX機能の追加

|      詳細~XXXXXXXXXXXXXX

| MODIFY: XXX機能の変更

|      詳細~XXXXXXXXXXXXXX

| REMOVE: XXX機能の破棄

|      詳細~XXXXXXXXXXXXXX

| ADJUST: コードの調整 <------ これは今さき思いつき

|      詳細~XXXXXXXXXXXXXX


とか


+----------------------------------

| APPEND20050606: XXX機能の追加

|      詳細~XXXXXXXXXXXXXX

| MODIFY20050606: XXX機能の変更

|      詳細~XXXXXXXXXXXXXX


としています。


修正箇所が多岐に渡る場合で、

修正箇所をコード内にマークしたい場合は、

上記キーワードにYYYMMDDを連結して

コメントやプリプロセッサの条件にしてしまいます。

ライブラリ管理をきちんとしていない現場で、

少なくとも自分のいじった箇所を忘れないように、

このようなものを埋め込んだりしていました。


ex)


#APPEND20050606 author START

:

#APPEND20050606 END


#ifdef REMOVE20050606 START

:

#endif REMOVE20050606 END


#IF MODIFY20050606 Then

:

#Else

:

#End If


//ADJUST20050606 xxxx


何をしたかが明確になるような

そんなキーワードがふさわしいかと思います。

文字数はどれも同じだし見栄えはどうでしょうか。

私はこれになれてしまっています。

id:aukjs

実際に利用されている例の紹介は

ありがたいです。

2005/06/11 12:07:28
id:dungeon-master No.3

dungeon-master回答回数571ベストアンサー獲得回数402005/06/11 12:04:13

ポイント25pt

http://www.hatena.ne.jp/ダミー:detail]

うちでは機能追加も仕様変更のうちと考えておりあまり区別しません。

普段は記号+日本語でマークアップしているので、英単語に変えてみました。


A SPEC-CHANGE(ADD)計画したVersionUpにかかわる機能追加、新機能

B SPEC-CHANGE(REV)計画したVersionUpにかかわる機能変更、機能強化

C ADJUSTMENT  リリース後の仕様変更、細部調整(パッチなどで対応)

D LOGIC-ENHANCE 効率化、アルゴリズム代替、例外対応、ライブラリ化など

E CORD-CLEAN-UP コード整理


aukjsさんの意味付けに対応させると 1⇒A、2⇒B,C、3⇒D、4⇒E でしょうか。

id:aukjs

ふむふむ

2005/06/11 12:08:03
id:shozzy No.4

shozzy回答回数11ベストアンサー獲得回数02005/06/14 00:35:46

ポイント25pt

このようなものではいかがでしょうか?

(これもベタですけど、、、)


1:機能の追加

 ADDED


2:すでにある仕様の変更

 CHANGED


3:処理方式の変更(機能や仕様の追加変更は無い)

 MODIFIED


4:コードをキレイにしただけ(機能や仕様、方式の追加変更は無い)

 CLEANED

id:aukjs

ベタですね。

-----

動きが無いようなので終了します。

2005/06/14 18:57:52

コメントはまだありません

この質問への反応(ブックマークコメント)

トラックバック

「あの人に答えてほしい」「この質問はあの人が答えられそう」というときに、回答リクエストを送ってみてましょう。

これ以上回答リクエストを送信することはできません。制限について

絞り込み :
はてなココの「ともだち」を表示します。
回答リクエストを送信したユーザーはいません