Re: Document shepherd writeup formats

Alexey Melnikov <alexey.melnikov@isode.com> Tue, 26 November 2019 06:23 UTC

Return-Path: <alexey.melnikov@isode.com>
X-Original-To: wgchairs@ietfa.amsl.com
Delivered-To: wgchairs@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 8612E120129 for <wgchairs@ietfa.amsl.com>; Mon, 25 Nov 2019 22:23:32 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.999
X-Spam-Level:
X-Spam-Status: No, score=-1.999 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, URIBL_BLOCKED=0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (1024-bit key) header.d=isode.com
Received: from mail.ietf.org ([4.31.198.44]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id I8yUkP88BZl7 for <wgchairs@ietfa.amsl.com>; Mon, 25 Nov 2019 22:23:31 -0800 (PST)
Received: from waldorf.isode.com (waldorf.isode.com [62.232.206.188]) by ietfa.amsl.com (Postfix) with ESMTP id 72F2F120C85 for <wgchairs@ietf.org>; Mon, 25 Nov 2019 22:23:25 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; t=1574749404; d=isode.com; s=june2016; i=@isode.com; bh=ZxkT5/6F3Rax8o+mlm8BHD8PSY44ukJkoul6K34eWdY=; h=From:Sender:Reply-To:Subject:Date:Message-ID:To:Cc:MIME-Version: In-Reply-To:References:Content-Type:Content-Transfer-Encoding: Content-ID:Content-Description; b=okUZd1FQOP7gkoHhe4y+FFRYDemxpUek5K3vXJLJVj76ze1nTGskSYoOn5ufy1IQ+GP4yh nCDBkMQp260VW5RytlHFiPg890gtZzHCUc6vwlV06HO0UGp1OBOn+RxEapl6uXlg5ItmNT GhwRCk00JZwr2bXd9Q/3mSo50Fabk9s=;
Received: from [192.168.0.12] (cpc121086-nmal24-2-0-cust54.19-2.cable.virginm.net [77.97.145.55]) by waldorf.isode.com (submission channel) via TCP with ESMTPSA id <XdzE3ABbdwYU@waldorf.isode.com>; Tue, 26 Nov 2019 06:23:24 +0000
Subject: Re: Document shepherd writeup formats
From: Alexey Melnikov <alexey.melnikov@isode.com>
X-Mailer: iPad Mail (16G102)
In-Reply-To: <14334f87-1870-0aa2-d066-3cb2a417f649@bluepopcorn.net>
Date: Tue, 26 Nov 2019 06:23:23 +0000
Cc: IETF WG Chairs <wgchairs@ietf.org>
Message-Id: <1C5E38E2-541D-4628-A72A-8DB6E0B87223@isode.com>
References: <14334f87-1870-0aa2-d066-3cb2a417f649@bluepopcorn.net>
To: Jim Fenton <fenton@bluepopcorn.net>
MIME-Version: 1.0
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: quoted-printable
Archived-At: <https://mailarchive.ietf.org/arch/msg/wgchairs/1tKVGCCDl9ltM_sIeQel-QRM2Jg>
X-BeenThere: wgchairs@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Working Group Chairs <wgchairs.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/wgchairs>, <mailto:wgchairs-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/wgchairs/>
List-Post: <mailto:wgchairs@ietf.org>
List-Help: <mailto:wgchairs-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/wgchairs>, <mailto:wgchairs-request@ietf.org?subject=subscribe>
X-List-Received-Date: Tue, 26 Nov 2019 06:23:32 -0000

Hi Jim,

> On 25 Nov 2019, at 21:22, Jim Fenton <fenton@bluepopcorn.net> wrote:
> 
> I just completed a document shepherd writeup in the "newer essay-style
> version" described on the DocumentShepherding page of the Chairs' wiki.
> But when I went to submit it, the form popped up with a template for the
> question-and-answer format, which led me to believe that format is
> preferred.
> 
> Is the essay-style format actually preferred? I'm wondering if it's a
> good idea to have two writeup formats rather than a single one. Or do
> preferences vary by AD?

Yes :-)

For new WG chairs I prefer the question-and-answer format. In my experience new shepherds miss lots of checks which AD has to do if essay-style is used.

When doing essay-style I also ask my chairs to mention existing and/or expected deployments (unless there is a section in the document), as this information is needed in IESG ballot and is frequently missing in essay-style writeup.

Best Regards,
Alexey