PWG Mail Archive: RE: PWG> Annotated sequence of PWG documen

RE: PWG> Annotated sequence of PWG document filenames

From: McDonald, Ira (imcdonald@sharplabs.com)
Date: Tue Mar 23 2004 - 11:46:57 EST

  • Next message: Harry Lewis: "PWG> PWG Process document meeting reminder"

    Hi Dennis,

    Thanks for all those good comments. My responses are
    inline below.

    I will NOT be able to update this sequence with your
    feedback before this Thursday's process telecon.
    I'm operating on zero sleep. And I have two more
    all-night telecons with FSG Japan tonight and
    tomorrow night. I'll try to attend the Thursday
    process telecon.

    Cheers,
    - Ira

    Ira McDonald (Musician / Software Architect)
    Blue Roof Music / High North Inc
    PO Box 221 Grand Marais, MI 49839
    phone: +1-906-494-2434
    email: imcdonald@sharplabs.com

    -----Original Message-----
    From: Dennis Carney [mailto:dcarney@us.ibm.com]
    Sent: Saturday, March 20, 2004 12:32 PM
    To: pwg@pwg.org
    Cc: McDonald, Ira
    Subject: RE: PWG> Annotated sequence of PWG document filenames

    Hi Ira,

    Good writeup!

    A few comments:

    - Entries should be added for when a draft becomes an full standard. And
    probably for what happens after that if something needs to be changed.

      <ira> Agree

    - ABNF and example entries should be added for the working group charter.

      <ira> Agree

    - I was surprised that your ABNF did not force "whitefile"s to have the
    "abc10" substring in the filename. Was this an oversight or done on purpose?

      <ira> Open on purpose - because an individual contributor could write a
      white paper at any time on any topic, outside a chartered working group.

    - I was surprised to see the Requirements doc becoming a Candidate Standard,
    including even getting a "standard number" (510x.y). I guess it makes sense,
    since it has to go through a last call and formal vote, but somehow it seems
    wrong. For example, would the Requirements doc have to progress to full
    standard before the protocol can progress to full standard--I wouldn't have
    thought so. Also, since the charter needs formal approval, it would also go
    to Candidate Standard in this plan. Does this bother anyone else?

      <ira> Process/2.0 REQUIRES the Requirements to be adopted with Formal Vote
    and
      document number. As has just been done with several requirements
    documents.
      About charter - NO it should not get a document number - just a Formal
    Vote.

    - In the last example entry (#22), the filename should probably have 5109.3
    instead of 5109.2, shouldn't it?

      <ira> No - a PWG protocol gets a single document number forever, just
      like IEEE and ISO standards do. New versions MUST not change the
      document number (only the date and major/minor version parts).

    - Did we agree that there would be "readme"/"status" files in the various
    directories? For example, there might be a file in the "candidates"
    directory that said for a given standard whether it was currently being
    revised (that is, had a newer 'wd' file in another directory). If we want to
    do this, this should be added to your example entries--for example, entry
    #11 might have another line like:
    - .../candidates/current_status.doc/pdf updated to state work in progress on
    ABC/1.0 protocol
      
      <ira> Agree - I'll look into this.

    Dennis Carney
    IBM Printing Systems

    "McDonald, Ira" <imcdonald@sharplabs.com>

    "McDonald, Ira" <imcdonald@sharplabs.com>
    Sent by: owner-pwg@pwg.org
    03/18/04 03:00 AM

    To
    "'pwg@pwg.org'" <pwg@pwg.org>

    cc

    Subject
    RE: PWG> Annotated sequence of PWG document filenames

    Hi,

    A reminder that the sequence of filenames below should
    be reviewed tomorrow at the process telecon, if possible.

    Cheers,
    - Ira

    Ira McDonald (Musician / Software Architect)
    Blue Roof Music / High North Inc
    PO Box 221 Grand Marais, MI 49839
    phone: +1-906-494-2434
    email: imcdonald@sharplabs.com

    -----Original Message-----
    From: McDonald, Ira [mailto:imcdonald@sharplabs.com]
    Sent: Saturday, March 06, 2004 6:10 PM
    To: 'pwg@pwg.org'
    Subject: PWG> Annotated sequence of PWG document filenames

    Hi, Saturday (6 March 2004)

    Per our discussion at last Thursday's PWG Process telecon, below is a
    sequence of document filenames, created by a hypothetical PWG working
    group 'ABC', showing the 'life cycle' of PWG documents:

    (a) development of requirements document;
    (b) development of protocol document;
    (c) editorial update of protocol document - same minor version
       - WITHOUT parameter, encoding, attribute, or value changes;
    (d) technical update of protocol document - new minor version
       - WITH parameter, encoding, attribute, or value changes.

    Notes:

    (1) A commented ABNF for PWG document filenames is specified below.

    (2) Working drafts of previous Candidate Standards undergoing revision
       SHOULD drop their standards number (51xy.z) until the revised
       document is finally approved by Formal Vote.

    (3) The file prefix 'wp' (white paper) has been combined with 'tb'
       (technical brief) as the common informal note document type
       (also, 'wp' was too close to 'wd' for clarity).

    (4) The file prefix 'dg' (developer's guide) has been combined with
       'bp' (best practice) and SHOULD require a Formal Vote of approval
       (because it uses SHOULD and SHOULD NOT).

    (5) IETF concept of 'class' is introduced, with 'white paper', 'draft',
       and 'standards track' document types (see ABNF below).

    (6) ISO/W3C concept of 'edition' is introduced, appended to major/minor
       version (in document titles ONLY, not filenames), to disambiguate
       purely editorial revisions (see examples in sequence below).

    Comments?

    Cheers,
    - Ira

    Ira McDonald (Musician / Software Architect)
    Blue Roof Music / High North Inc
    PO Box 221 Grand Marais, MI 49839
    phone: +1-906-494-2434
    email: imcdonald@sharplabs.com

    ------------------------------------------------------------------------
    PWG document filename ABNF (see RFC 2234 for ABNF types used below):

    pwgfilename = whitefile / draftfile / stdfile

    whitefile = whitepfx "-" 1*(lowalpha / digit / "-") "-" date "." ext
    draftfile = draftpfx "-" wg [spec] version "-" date "." ext
    stdfile = stdpfx "-" wg [spec] version "-" date "-" stdnum "." ext

    whitepfx = "faq" / ; frequently asked questions
                 "ht" / ; hints & tips (no SHOULD/MUST)
                 "tb" ; technical brief (note)
    draftpfx = "wd" / ; working draft
                 "lcrc" ; last call review comments
    stdpfx = "std" / ; Standard (w/ MUST)
                 "cs" / ; Candidate Standard (w/ MUST)
                 "bp" ; Best Practice (w/ SHOULD)

    wg = 2*(lowalpha) ; working group email list
    spec = 2*(lowalpha) ; omitted for base protocol
    version = major minor ; version of protocol/interface
    major = 1*digit ; NEED NOT be compatible
    minor = 1digit ; MUST be backwards compatible

    date = year month day ; 8-digit date
    year = 4digit
    month = 2digit
    day = 2digit

    stdnum = "51" 2digit "." 1*digit ; IEEE/ISTO PWG standard number
    ext = "doc" / ; MS Word document source
                 "htm" / ; HTML document source
                 "pdf" / ; Adobe PDF document formatted
                 "txt" / ; UTF-8 document plaintext
                 "xml" / ; XML document source
                 "xsd" / ; XML schema source
                 1*3lowalpha ; other 1-3 character extension

    ------------------------------------------------------------------------

    1) ABC WG is chartered
       - with the 'abc@pwg.org' mailing list name

    2) ABC WG directories are created, including:
       - ftp://ftp.pwg.org/pub/pwg/abc - primary directory
       - ftp://ftp.pwg.org/pub/pwg/abc/wd - working drafts
       - ftp://ftp.pwg.org/pub/pwg/abc/white - FAQs/technical briefs/hints
       - ftp://ftp.pwg.org/pub/pwg/abc/schemas - XML schemas
       - ftp://ftp.pwg.org/pub/pwg/abc/minutes - minutes of WG meetings
       - ftp://ftp.pwg.org/pub/pwg/abc/slides - slides and presentations

    3) first draft ABC requirements (working draft)
       - .../abc/wd/wd-abcreq10-20040505.doc/pdf

    4) last draft to PWG Announce - 30 day 'last call' (working draft)
       - .../abc/wd/wd-abcreq10-20040814.doc/pdf

    5) last draft to PWG Announce - 30 day Formal Vote (working draft)
       - .../abc/wd/wd-abcreq10-20040814.doc/pdf

    6) "PWG ABC Requirments/1.0 - 1st Edition" (Candidate Standard)
       - .../candidates/cs-abcreq10-20041108-5109.1.doc/pdf

    7) first draft ABC protocol (working draft)
       - .../abc/wd/wd-abc10-20041212.doc/pdf

    8) last draft to PWG Announce - 30 day 'last call' (working draft)
       - .../abc/wd/wd-abc10-20050404.doc/pdf

    9) last draft to PWG Announce - 30 day Formal Vote (working draft)
       - .../abc/wd/wd-abc10-20050404.doc/pdf

    10) "PWG ABC Protocol/1.0 - 1st Edition" (Candidate Standard)
       - .../candidates/cs-abc10-20050715-5109.2.doc/pdf

    11) first draft ABC protocol update (working draft)
       - ONLY editorial revisions - same minor version
       - .../abc/wd/wd-abc10-20050802.doc/pdf

    12) last draft to PWG Announce - 30 day 'last call' (working draft)
       - .../abc/wd/wd-abc10-20051005.doc/pdf

    13) last call review comments - with embedded issues and resolutions
       - .../abc/wd/lcrc-abc10-20051105.doc/pdf

    14) last draft to PWG Announce - 30 day Formal Vote (working draft)
       - .../abc/wd/wd-abc10-20051120.doc/pdf

    15) "PWG ABC Protocol/1.0 - 2nd Edition" (Candidate Standard)
       - .../candidates/cs-abc10-20051225-5109.2.doc/pdf

    16) technical brief about ABC protocol performance (white paper)
       - .../abc/white/tb-abc10-performance-20060113.doc/pdf

    17) FAQ about ABC protocol (white paper)
       - .../abc/white/faq-abc10-20060220.doc/pdf

    18) first draft ABC protocol update (working draft)
       - technical revisions - new minor version
       - .../abc/wd/wd-abc11-20060310.doc/pdf

    19) last draft to PWG Announce - 30 day 'last call' (working draft)
       - .../abc/wd/wd-abc11-20060812.doc/pdf

    20) last call review comments - with embedded issues and resolutions
       - .../abc/wd/lcrc-abc11-20060912.doc/pdf

    21) last draft to PWG Announce - 30 day Formal Vote (working draft)
       - .../abc/wd/wd-abc11-20060930.doc/pdf

    22) "PWG ABC Protocol/1.1 - 1st Edition" (Candidate Standard)
       - .../candidates/cs-abc11-20061123-5109.2.doc/pdf



    This archive was generated by hypermail 2b29 : Tue Mar 23 2004 - 11:47:18 EST