ドキュメント変更要項


1. 序

 現在、任天堂から外部に出しているドキュメントは大きく分けて下記の２種
 類に分けられます。

        プログラミングマニュアル(メディア:紙、開発３部のリリース)
        マニュアル大全集(メディア:CDROM、業務部のリリース)

 実際はこれらの英語版もあるわけですが、これらのドキュメントを、平行して
 同時にアップデートするために、下記のルールを定めさせて頂きます。よろし
 くお願いします。

 なお、マニュアル大全集は、業務部の責任のもとで作成、リリースしているも
 のですが、この中の「関数リファレンス」は開発３部からの変更要請で業務部
 が変更することになっています(ただし、業務部内部の要求で変更されることも
 もちろんあります)。

 基本的に、関数リファレンスとプログラミングマニュアルは同時にアップデー
トしましょう(共通の記述が多い)。


2. 対象

 変更対象となるのは

        A. プログラミングマニュアル
        B. マニュアル大全集内の関数リファレンス
        C. その他マニュアル大全集内の記述

 です。C については 1. では書きませんでしたが、気付いたところは修正しま
しょう。


3. 通知方法

 変更の通知方法は、メールとします。メールは下記の5人に出してください。

        業務部吉良さん(kira@lic.nintendo.co.jp)
        NOA 細貝さん(SATOHO01@ncl.nintendo.co.jp)
	NOA 田原さん(Yasuta01@ncl.nintendo.co.jp)
        ３部三成さん(mitu@rd3.nintendo.co.jp)
        ３部橋田(has@rd3.nintendo.co.jp)

また、サブジェクトは以下の文字列から始めてください。

        [DOC-I:001-hashida] Prog man: 
                A. プログラミングマニュアルの変更依頼の場合

        [DOC-I:001-hashida] Func man: 
                B. 関数マニュアルの変更依頼の場合

        [DOC-I:001-hashida] Daizen: 
                C. 大全集一般の記述間違い報告の場合


なお、[] 内にある「hashida」のところには、変更依頼を出す人の名前をいれて
ください。また、「001」のところには、各人がそれぞれ管理して数字を増やし
ていってください。例えば、私が変更を3回加えたあと、三成さんが１回変更す
る際には

        [DOC-I:001-hashida] Func man: AAA
        [DOC-I:002-hashida] Prog man: BBB
        [DOC-I:003-hashida] Func man: CCC

        [DOC-I:001-mitsunari] Func man: ABCDE

というような形になります。この数字は受け取り側でメールをもれなく確実に処
理するためのものです。


なお、大きなファイルを送付しなければいけない場合(例えば、全面差し換え
の時等)は、メールで添付するのは避けてください。その場合は、NTSC-ONLINE 
の PUT 機能を用いて送付してください。上記五人のアカウントは下記の通り
です。

        業務部吉良さん(kira)
        NOA 細貝さん(shosogai)
	NOA 田原さん(yasuta01)
        ３部三成さん(mitu)
        ３部橋田(has)

手順は以下の通り：

	1. NTSC-ONLINE で、一番上のフレームの PUT をクリック
	2. 真ん中のフレームで、送信ファイル名を入力
	3. ユーザ ID 宛先の欄に、上記五人のアカウントをスペースで区切っ
	   て入力
	4. 「指定 User-ID 宛に E-mail で知らせる」というボタンをオフに
	   する(デフォルトはオン)
	5. 送信ボタンを押す
	6. 通常の場合と同様、五人にはメールでの変更依頼を出しておく(文
	   面は、NTSC-ONLINE に PUT しておいたので、GET してください、
	   等)

指定 User-ID 宛に E-mail で知らせる、をオンにしないのは、このメールは
Subject の形式がドキュメント変更依頼の形式になっていないからです。した
がって、自分でメールは送ってください。


4. 確認

 プログラミングマニュアルに関しての変更は、基本的に橋田がします。依頼を
受けたらなるべく速やかに変更します。変更したら、した旨を通知しますので、
きちんと変更されているかどうかチェックしてください。

 マニュアル大全集の変更に関しては、すぐにはこちらに届きません。が、リリー
ス前に業務部からβ版が届きますので、自分の行った変更に関して、反映されて
いるかのチェックをそのときにお願いします。


5. 注意事項

 i) なるべく具体的に変更してください。「この表現がおかしいので変えて欲し
い」ではなく、「この文章からここまでを、以下の文章に差し換えて欲しい」と
いった感じにしてください。

 ii) 半角文字の両側にはスペースを開けないでください。これはワードが勝手
に見易いようにしてくれるからです。HTML に持ってきたときはどうなのか分か
りませんが...。

 iii) 図があったり、変更個所が大部分にわたるときは、ワードのデータとして
作成したものを添付してくださって結構です。

 iv) なるべく誤解がないように、誤解されそうな表現はなるべく使わないよう
にしましょう。


6. 例

 下記に変更依頼例を示します。参考にしてください。

--<例>----------------------------------------------------------
Subject: [DOC-I:055-hashida] Prog man: 64DD 9章変更
From: Takayuki Hashida <has@rd3.nintendo.co.jp>


開発３部の橋田です。


64DD のプログラミングマニュアルの９章に不備が見つかりました。ついでの
変更も含めて、下記のように変更をお願いします。

1. 「9.2.1 ROM マップ」最初の文章を変更。

次ページ→下記


2. 「9.2.1 ROM マップ」表を修正

１行目「サイズ等」→「サウンド波形データの先頭からのオフセット」

BookData:から下のアドレスが全て
        0x2Dxxxx
となっているが、これを全て
        0x2Bxxxx
に変更(計１２個所)


3. 「9.2.2 詳細」最後の文章

「また、非ループサウンドに関しては〜0x002D8FFF が格納されています。」
        ↓
「また、非ループサウンドに関しては〜0x002B8FFF が格納されています。」
----------------------------------------------------------------