人力検索はてな
モバイル版を表示しています。PC版はこちら
i-mobile

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

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

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

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

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

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

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

●質問者: aukjs
●カテゴリ:コンピュータ 科学・統計資料
✍キーワード:キレイ コード シンボル ソフトウエア ドキュメント
○ 状態 :終了
└ 回答数 : 4/4件

▽最新の回答へ

1 ● Nara-Chan
●25ポイント

http://www.sra.co.jp/wingnut/standards-j_toc.html

GNU ???????? ◎質問者からの返答

ベタですね。


2 ● tonolove
●25ポイント

http://d.hatena.ne.jp/dummyddddddddd

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

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

| 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


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

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

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

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

◎質問者からの返答

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

ありがたいです。


3 ● dungeon-master
●25ポイント

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 でしょうか。

◎質問者からの返答

ふむふむ


4 ● shozzy
●25ポイント

http://hatena.jp/dummy/

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

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


1:機能の追加

ADDED


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

CHANGED


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

MODIFIED


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

CLEANED

◎質問者からの返答

ベタですね。

-----

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

関連質問


●質問をもっと探す●



0.人力検索はてなトップ
8.このページを友達に紹介
9.このページの先頭へ
対応機種一覧
お問い合わせ
ヘルプ/お知らせ
ログイン
無料ユーザー登録
はてなトップ