査読のやりかた

FreeBSD QandA
FreeBSD QandA Project

以下の内容は、QandA プロジェクトのメンバ向けのものです。QandA@jp.FreeBSD.org 宛に情報提供される方は 必ずしも守る必要はありません。しかし査読時の労力削減のために、QandA プロジェクトのメンバでない方も 一読してもらえるとありがたいです。

基本的なお約束事

正規表現で言うと、質問は /^Q\. ?/ にマッチするもの、回答は /^A\. ?/ にマッチするもの、です。

--cut here-- は、正規表現 m/^[\-\s]*cut[\-\s]*(here)?[\-\s]*$/ にマッチする形式なら可です。

/^Q\. / が始まる前の部分は、ステータス情報を記述します。


ステータス情報

査読結果には、ステータス情報を付けることができます。 このヘッダは 'Q. ' の前に置かれ、メールのヘッダのように
フィールド名: 値
という形をとります。現在定義されているフィールド名は以下の通りです。

フィールド名 意味
genre ジャンル名 指定したジャンルに登録されます。ジャンルの一覧は こちら を参照してください。
group グループ名 同じグループの QandA は 管理番号 1456 のように、末尾に同一グループへのリンクが付きます。 グループ名は自由に決めて下さい。
place intro QandA は管理番号の若い順に並べられますが、place: intro とすると、 ジャンル: プリンタ のように、先頭に表示されます。intro 以外の値を書くと無視されます。
announce no 査読された QandA を正式に登録する際、QandA 管理者が FreeBSD-users-jpFreeBSD-beginners-jp に更新のお知らせメールを送っています ( 例: [FreeBSD-users-jp 59529])。 タイプミス修正、URL 変更など、些細な修正の場合は、査読時に 「announce: no」として下さい。更新時のお知らせメールから省かれます。

新規 QandA の査読時には必ずジャンル指定が必要ですが、 既に登録されている QandA を更新する際は、ジャンル指定を省略することができます。 省略した場合は、引続き同じジャンルに属することになります。 改めてジャンルを指定した場合は、ジャンルが変更されます。

その他のフィールドは 付けても付けなくても構いません。

例:

  genre: Xinstall (1つのジャンルに属する場合)
  genre: install,adm (複数のジャンルに属する場合はカンマ(半角)で区切る)
  place: intro (place の値は intro しか指定できません)
  group: netscape-navigator
  announce: no (announce の値は no しか指定できません)


リンク

HTMLへ変換するとき、スクリプトで自動的に処理されます。

用語/日本語

QandA では、ある程度用語を統一しています。

インデント

QandA 本文中に「Q. 」「A. 」分の3文字のインデントを入れるかどうかは お好みでどうぞ。つまり、
    ---cut here---
    Q. FreeBSDってなんですか。

    A. FreeBSDとはUCBの作ったBSDというアレがアレで、
       4.3BSD NET/2から386BSDとNetBSD、BSDIがわかれて、
       4.4BSD Lite2を採り入れたものがFreeBSD3.0で…
    ---cut here---
とインデントを入れてもいいですし、
    ---cut here---
    Q. FreeBSDってなんですか。

    A. FreeBSDとはUCBの作ったBSDというアレがアレで、
    4.3BSD NET/2から386BSDとNetBSD、BSDIがわかれて、
    4.4BSD Lite2を採り入れたものがFreeBSD3.0で…
    ---cut here---
でもいいですし、
    ---cut here---
    Q.
    FreeBSDってなんですか。

    A. 
    FreeBSDとはUCBの作ったBSDというアレがアレで、
    4.3BSD NET/2から386BSDとNetBSD、BSDIがわかれて、
    4.4BSD Lite2を採り入れたものがFreeBSD3.0で…
    ---cut here---
でも OK です。登録時に自動的に整形されますので、 上の3つの例は同じ査読結果となります。

Subject

QandA@jp.FreeBSD.org、QandA-work@jp.FreeBSD.org に流れるメールの Subject: ヘッダの内容に よって、その QandA の状態が決まるようになっています。

具体的には、QandA 番号を組み合わせて、

  Subject: [QandA 234] [Update 345]
  Subject: [QandA 456] [Delete 567] about hoge hoge
                                          ↑後ろの方に普通の Subject を付けてもよい
などと書きます。査読作業は以下のような流れになりますので、その状況に応じた キーワードを付けてください。 査読の進行状況QandA of QandA Project を あわせて見ると理解しやすいでしょう。
   フロー                  実施者          コメント
-------------------------  ------------  -----------------------
(1) 原稿投稿               QandA作成者   一般ユーザからの受け付け
      |
      |
(2) 内容チェック                         質問のみのメールや、SPAMメールだった場合は
      |                                 削除 (discard) する。
      |                                 また、複数のQandAが含まれる場合は
      |                                 分割して再度 QandAへ送り直す。
      |                                 その際、元質問は discard する。
      ↓
(3) 査読投稿               査読者        査読した結果を投稿する
      |                                 ジャンル指定を忘れないこと
      ↓          
(4) 原稿確認               他のメンバ    査読結果を確認する
      |                                 内容に過不足や誤記がある場合、
      |                                 コメントを付ける
      |
---------------(査読後、誰からもコメントが付けられず4日経過したら)-----------------------------
      |
      ↓
(5) 登録                   追加担当      査読されたQandAをwebに追加する。
                                         この時点で初めてwebに反映される。


(1)の投稿のみ 'QandA' それ以降はすべて 'QandA-work' で行う。
投稿するときは Subject: で指定されたキーワードを 付けて出す。 
更に詳細コメント


メールで情報取得

QandA についての情報は web から入手できますが、メールの方がよいという方は、 以下のメールアドレスにメールを送ると自動的に各情報が返送されます。

Sample 1: QandA xxxを査読する場合

      +-------------------------------------------------
      |From hogehoge@foo.or.jp
      |To: QandA-work@jp.FreeBSD.org
      |Subject: Re: [QandA xxx] about hoge hoge
      |
      |
      |こんにちは。QandA xxxの査読結果です。 ←ここにはお好きなコメントをどうぞ
      |〜についての説明を追加しました。 ←どこを修正したのか簡単に書いて下さい
      |
      |----- cut here ------ ←先頭と最後の --cut here--は必須
      |genre: FAQ,user
      |
      |Q. FreeBSD ってなんですか?
      |
      |A. FreeBSD というのは 云々・・・
      |・・・・・
      |---- cut here ------- ←先頭と最後の --cut here--は必須
      |
      |内容に誤りがありましたら、指摘お願いします。 ←最後のcut hereの後には何を書いてもいいです

Sample 2: QandA xxxを査読し、登録済 QandA yyyを更新する場合

つまり、QandA xxxは「管理番号 yyyの修正案」なわけです。
      +-------------------------------------------------
      |From hogehoge@foo.or.jp
      |To: QandA-work@jp.FreeBSD.org
      |Subject: [QandA xxx] [Update yyy] about hoge hoge
      |                        ↑更新したい管理番号を書く
      |
      |一部言い回しを変えました。それ以外変更なしです。
      |
      |----- cut here ------ ←先頭と最後の --cut here--は必須
      |genre: FAQ,user
      |
      |Q. FreeBSD ってなんですか?
      |
      |A. FreeBSD というのは 云々・・・
      |また、[管理番号 100]も参考になります。
      |             ↑自動的に管理番号100へのリンクが張られます
      |----- cut here ------ ←先頭と最後の --cut here--は必須

Sample 3: 登録済 QandA xxxを更新する場合 (Project メンバのみ)

QandA@jp.FreeBSD.orgには「QandA xxxの修正依頼」は届いていないが、 間違いを発見した場合。

これは査読済として扱われますので、プロジェクトのメンバ以外はやってはいけません。 また、内容に間違いがないことがわかっている場合のみお願いします。

プロジェクトのメンバ以外の方は、QandA@jp.FreeBSD.org に 「管理番号 xxx に間違いがあります」というメールを送ってください。 →例

      +-------------------------------------------------
      |From hogehoge@foo.or.jp
      |To: QandA@jp.FreeBSD.org  ←QandA-work宛ではないことに注意
      |Subject: [Update yyy] about hoge hoge ←更新したい管理番号を書く
      |
      |----- cut here ------ ←先頭と最後の --cut here--は必須
      |←ジャンル指定がないので、引続き現在のジャンルに属することになる
      |Q. FreeBSD ってなんですか?
      |
      |A. FreeBSD というのは 云々・・・
      |また、<URL:http://www.jp.FreeBSD.org/> でいろいろな情報が得られます。
      |                ↑自動的に http://www.jp.FreeBSD.org/へのリンクが張られます
      |----- cut here ------ ←先頭と最後の --cut here--は必須

QandA@jp.FreeBSD.org
Copyright (C) 1997-2002 The FreeBSD Project (Japan). All rights reserved.
$Date: 2002/04/16 14:01:17 $