*「ヘルプ補足」諸注意 [#q864e906] #contents *「ヘルプ補足」について(閲覧される方向け) [#z4651f93] 「ヘルプ補足」に掲載されている内容は、SRCの一般利用者の有志によって作成されたものです。(SRC-Wikiのほぼ全体に言えることですが) そのため殆どの記事は、SRC作者であるKeiさんやSRC公式HP管理人から提供されたいわゆる''公式情報ではありません'' -Wikiの性質上、最新の本体バージョンに対応した内容であるとは限りません。 -各トピックはヘルプの各項目に対応して作成されていますが、いわゆるオンラインヘルプでは''ありません''。~ 利用する際には''必ず、本体添付のヘルプファイルと併読''してください。 -バグ情報関連は基本的に掲載されていません。バグ報告掲示板等を参照するようにしてください。 -開発版で実装されている新機能に関連する記事は、原則として掲載されていません。 #br -本Wikiの他ページと同様、記載されていない情報をお持ちな方はお気軽に追加していただいて構いません。~ その際は、後述の ※「ヘルプ補足」の編集方針(編集する方向け) も参照してください。~ Wikiの編集に不慣れな方向けに、各ページにフォーム(コメント欄)が設置されています。((レイアウトや分類方針などについての話題は、[[ヘルプ補足トップページ>ヘルプ補足]]のコメント欄を用いるようにしてください)) ---- ***記事の分類表記 [#q1e97a4f] 「ヘルプ補足」に含まれる各記事には、その内容に応じて以下のものが付けられています。 >&color(red){◆未掲載仕様}; >&color(red){◆仕様補足説明}; >&color(red){◆保証未確認動作}; >&color(red){◆}; これらは記事内容の"安定性"とでも言うべきものに繋がっていますので、~ シナリオ中で利用する場合の判断材料にしてください。 #hr &color(red){◆未掲載仕様};~ 「仕様である」との見解が示されたものの、ヘルプファイルには記載されていない内容の記事です。 >基本的に、示された見解がそのまま転記されています。 #hr &color(red){◆仕様補足説明};~ ヘルプの説明から読み取れる内容の補足説明や解説になっている記事です。 >データやシナリオ中での具体的な記述例、類似効果を持つもののリストや関連項目へのリンクに加え、~ ヘルプの複数ページに別々に書かれている内容をまとめたものなどもこれに該当します。 #hr &color(red){◆保証未確認動作};~ 仕様であるかどうかは不明だが、こういう動作をする、という内容の記事です。 >仕様だと明言されているわけではないので、SRCのバージョンによって告知無く動作内容が変化している可能性があります。~ &br;これが付いている内容をシナリオで利用する場合には特に注意してください。 #hr &color(red){◆};~ 書きかけであったり、上記の3種類のいずれに該当するのかが分類されていない記事です。 >(書きかけの記事の中にも、分類表記がついているものがあります)~ なお、書きかけの記事には、原則的にその旨が記載されています。 ---- *「ヘルプ補足」の編集方針(編集する方向け) [#d7acc663] [[書き込む際の注意]]も併読してください。 #br ***収録する内容 [#h193fa1f] -開発版で実装されている新機能に関連する内容は原則として記載しないでください。 >これは、開発版の新機能の場合、通常の機能よりもはるかに頻繁な仕様変更が予想されるため、情報の混乱が予想されるからです。 -''明らかなヘルプの記述ミス(誤字含む)や、ヘルプに書かれている内容と実際の動作との食い違いなどは記載しないでください。&br;これらの情報は[[バグ報告掲示板>http://www.src.jpn.org/neko/lightbbs/bug/src_custom.cgi]]にて報告するようにしてください。'' -すでに、Wiki内の別カテゴリ([[シナリオ作成基礎編]]・[[応用編>シナリオ作成応用編]]など)に、表現は違っても内容が同じ記事がある場合、~ 「ヘルプ補足」と「シナリオ作成〜編」のどちらか一方にすることを基本にしてください。(記事のメンテナンス性を損なわないためです)~ その際、内容が記載されていない方には、もう一方への誘導リンクを張るようにしてください。 #hr ***ページ・トピック・記事の作成 [#uc134f7b] [[記事作成例>../記事作成例]]も参照してください。 -「ヘルプ補足」に含まれるページやトピックは、ヘルプの各項目に対応して作成します。~ 記事は、各トピックに対応して作成してください。(一つのトピックに複数の記事を書いても問題ありません)~ その際、必要に応じてページを分割・統合したり、新たなトピックを追加しても構いません。 >例: -"ユニットコマンド"というタイトルのページに、 ヘルプの "移動"〜"待機" 各項に対応する内容を収録する。 -"命中率に関連するもの" というタイトルで、特殊能力や状態の項目へのリンク集的なトピックを作る。 -各ページには、コメント欄を設けておいてください。(Wikiの編集に不慣れな人のために) -書きかけの記事は、書きかけであることがわかるようにしておいてください。 #hr ***記事を書いたら [#vf25e7c4] -各記事には、その内容に応じて >&color(red){◆未掲載仕様}; >&color(red){◆仕様補足説明}; >&color(red){◆保証未確認動作}; の、どれかを付けてください。~ ただし、どれに該当するかの判断が難しい場合は、無理に分類せずに「&color(red){◆};」のみを付けてください。 -関連した内容であっても、…例えば、その記事中に◆仕様補足説明 である部分と◆保証未確認動作 の部分とがある場合などは、~ その違いに合わせて記事を分割して記述するか、~ どこからどこまでが仕様補足説明で、どこが保証未確認動作なのかが、明確に判別できるようにしてください。 >(文章として綺麗、汚いではなく、誤解無く判別できることを第一にお願いします) #br ◆未掲載仕様、◆仕様補足説明、◆保証未確認動作、それぞれに該当する内容と諸注意は下のようになります。 #hr &color(red){◆未掲載仕様};~ 内容:バグ報告に対するレス中で「仕様である」との見解が示されたもの。 >ヘルプファイル中の説明だけでは、仕様だと判断できないものに限ります。~ ヘルプファイル中の説明や記述から読み取れる内容であれば ◆仕様補足説明 を付けます。~ できるだけ、見解が示されたときの表現をそのまま収録してください。~ &br;これに該当する記事を追加する場合、見解が示された日時とその時の最新本体バージョンも併記してください。~ &br;バージョンアップによってヘルプに掲載された内容であっても、記事そのものは削除しないでください。~ (古いバージョンの本体を使用している利用者にとっては有益な情報になります)~ (この際、収録されはじめたバージョンが追記されていると、より有用な情報になります) #hr &color(red){◆仕様補足説明};~ 内容:ヘルプの説明から読み取れる内容の補足説明や解説。 (能力・コマンドなどの具体的な記述例や、関連項目の事情も合わせた説明、関連項目の記載、類似能力との仕様の違い、など) >ヘルプファイル中の説明だけでは、仕様だとは言い切れないものは、◆保証未確認動作 を付けます。~ 現在、多くのシナリオで利用されている内容であっても、~ それが仕様だと言い切れないものであれば、基本的に◆保証未確認動作 を付けるようにしてください。 #hr &color(red){◆保証未確認動作};~ 内容:仕様であるという確認が取れていない内容に関する記事全般。 >記事の内容通りの動作をする本体バージョンを併記してください。~ (本体バージョンに依存する可能性が比較的高いからです)~ &br;バージョンアップによって動作が変わっていたとしても、以前の動作内容に関する記事は残してください。~ &br;仕様確認が行われたが回答が無かった場合、その旨を、仕様確認が行われた日時と合わせて追記してください。~ 過去の仕様確認結果を掲載する場合は「明確なソースの無い情報」だということを必ず併記してください。~ &br;バージョンアップ後に動作を再検証するために必要な記述を残しておく場合、コメントアウトして記述してください。~ (記事内容を理解することを助ける事を目的とした "例" とは区別してください)