IETF Logo Mail Archive

Re: New document shepherd writeup

Mark Nottingham <mnot@mnot.net> Tue, 03 May 2022 22:24 UTC

Return-Path: <mnot@mnot.net>
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 F26AFC1594BB for <wgchairs@ietfa.amsl.com>; Tue, 3 May 2022 15:24:54 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.098
X-Spam-Level:
X-Spam-Status: No, score=-2.098 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, SPF_PASS=-0.001, URIBL_BLOCKED=0.001, URIBL_DBL_BLOCKED_OPENDNS=0.001, URIBL_ZEN_BLOCKED_OPENDNS=0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (2048-bit key) header.d=mnot.net header.b=B6q5areA; dkim=pass (2048-bit key) header.d=messagingengine.com header.b=v7bKQ+hU
Received: from mail.ietf.org ([50.223.129.194]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id y-sneM--Uj7C for <wgchairs@ietfa.amsl.com>; Tue, 3 May 2022 15:24:50 -0700 (PDT)
Received: from wout4-smtp.messagingengine.com (wout4-smtp.messagingengine.com [64.147.123.20]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 971A3C14F731 for <wgchairs@ietf.org>; Tue, 3 May 2022 15:24:50 -0700 (PDT)
Received: from compute3.internal (compute3.nyi.internal [10.202.2.43]) by mailout.west.internal (Postfix) with ESMTP id 8C85B3200928; Tue, 3 May 2022 18:24:48 -0400 (EDT)
Received: from mailfrontend1 ([10.202.2.162]) by compute3.internal (MEProxy); Tue, 03 May 2022 18:24:48 -0400
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=mnot.net; h=cc :cc:content-transfer-encoding:content-type:date:date:from:from :in-reply-to:in-reply-to:message-id:mime-version:references :reply-to:sender:subject:subject:to:to; s=fm2; t=1651616688; x= 1651703088; bh=bgIV/Xq1DTUPSuh457bwkZZv3mXXJcWP3M4wLySRbOg=; b=B 6q5areAdm5P4xs4GG/S8fZguNgEls9g7gRmOhnFcNFqr2W8Qg6XHMQ5VjRAdPqFM UkeAXbkQu6PDZDT2g9mDXBftUeoWlArrIE/3jiCd8CBMEuuIeUZWyRtbJj7wP2WZ ZkKq1G1TSaoR1BdPYdaBSMDIfabUijtalr0rONl00SCbufOV6g4Yl3m6+GeVIWrZ iD/j4eMQe6hxfOsr73oMm1izJ3KztiaiBRbuCWPbWNxG9wmcDB/7+TqZA/1jDNhz aY59digYkn+TqdeTCfDdKpM0jpHPnuDHsHXCPZEPHSiriOErCSUb31B5D+EwHSIO FBckTRP0Q1fsbeOJTWYpQ==
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:cc:content-transfer-encoding :content-type:date:date:from:from:in-reply-to:in-reply-to :message-id:mime-version:references:reply-to:sender:subject :subject:to:to:x-me-proxy:x-me-proxy:x-me-sender:x-me-sender :x-sasl-enc; s=fm1; t=1651616688; x=1651703088; bh=bgIV/Xq1DTUPS uh457bwkZZv3mXXJcWP3M4wLySRbOg=; b=v7bKQ+hU2MVwa9s5B2POiihD53aHN AJU1fn/LMUfxxw+PmiIQ51N9858Xf3T8/Ut8jCXjX8KqJZnbT3ix/zp6mc8MUB3L mpSUBePVlfIO6WVwyUphIbgXlHYxtqJsDSF4S70G9AxSNcJ1RMwKeezQEFSYOneX 8JCx7Wsd/oirzlAfHzOz5hDJI+/s6TEXhGT7QmWadNnlURqZcPZXxOC/mNMUS4BX YTxrPk+YldJt89vjxHLcrc4++Tb4LLvJ9AM50P+a+Ul+1ApquSLhVT47EtxBc2Kg Zvn0RW1ocGZdspl6AB0bfQm5ucua4YArduyB7AXSRZ2Mme3tIVb2teDtA==
X-ME-Sender: <xms:r6txYq95oU-X4Lg6YcaEL2Jjwwr6aQpoN8i19L3uN9E3EkFxMaZCqg> <xme:r6txYqslXjKESFQ4IqnNQeJhxUSiF3WXDAY7gJ_uwdRC-qm2BXDKGYrLPDaAZcG_K ICRANK4--RPnL5wHA>
X-ME-Received: <xmr:r6txYgAE8gJ_foGjOpNLBC5SYrAo2FJ2FD1HIsbr3GvTVgybEaX5qo_bGJxUnQPaJO7xztp9vGlc_Nxdr3Amb6MXLiB9nlWODiTcuPFAnDF-Qvv8x2BQ-GL_>
X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedvfedrvdekgddtlecutefuodetggdotefrodftvf curfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfghnecu uegrihhlohhuthemuceftddtnecusecvtfgvtghiphhivghnthhsucdlqddutddtmdenuc fjughrpegtggfuhfgjffevgffkfhfvofesthhqmhdthhdtvdenucfhrhhomhepofgrrhhk ucfpohhtthhinhhghhgrmhcuoehmnhhothesmhhnohhtrdhnvghtqeenucggtffrrghtth gvrhhnpedujeegveekteetveegkeegleetkeffteejffetfffgueehfedtudfhfeehkeet veenucffohhmrghinhepghhithhhuhgsrdgtohhmpdhivghtfhdrohhrghdpqhgrqdhsth ihlhgvqdifrhhithgvuhhpqdhtvghmphhlrghtvgdrmhgupdhhthhtphifghdrohhrghdp mhhnohhtrdhnvghtnecuvehluhhsthgvrhfuihiivgeptdenucfrrghrrghmpehmrghilh hfrhhomhepmhhnohhtsehmnhhothdrnhgvth
X-ME-Proxy: <xmx:r6txYicgh6XrDQaKewBgmzg6hY5N4m1GnfTjLCII-EaAY62jPQfqxQ> <xmx:r6txYvN-o5Ovly8MdZQ1xPfuhatDFRz_MzHiYlhLo0O_J0LZHfPYuA> <xmx:r6txYsn7lQPg88dfAZeuDkmQxVEAP7DKAeWa34Sdk5s3JL-hNGgScw> <xmx:sKtxYl1pXT2-IrMYD-4VKKRhce-fUETmTv7MaCjym2RKSoW689y5DQ>
Received: by mail.messagingengine.com (Postfix) with ESMTPA; Tue, 3 May 2022 18:24:46 -0400 (EDT)
Content-Type: text/plain; charset="us-ascii"
Mime-Version: 1.0 (Mac OS X Mail 16.0 \(3696.80.82.1.1\))
Subject: Re: New document shepherd writeup
From: Mark Nottingham <mnot@mnot.net>
In-Reply-To: <F4A44FCE-D31B-4FE8-9950-6C60CDD9DD36@eggert.org>
Date: Wed, 04 May 2022 08:24:44 +1000
Cc: IETF WG Chairs <wgchairs@ietf.org>
Content-Transfer-Encoding: quoted-printable
Message-Id: <AEFFC404-4943-4E0B-B642-12D93A79CDA2@mnot.net>
References: <F4A44FCE-D31B-4FE8-9950-6C60CDD9DD36@eggert.org>
To: Lars Eggert <lars@eggert.org>
X-Mailer: Apple Mail (2.3696.80.82.1.1)
Archived-At: <https://mailarchive.ietf.org/arch/msg/wgchairs/az_hI3KlK_T62eyl6EXlXMdlHl0>
X-BeenThere: wgchairs@ietf.org
X-Mailman-Version: 2.1.34
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, 03 May 2022 22:24:55 -0000

Thanks, Lars. 

It might be good to put a link to the markdown source into the page:
  https://github.com/ietf-chairs/chairs.ietf.org/blob/main/documents/qa-style-writeup-template.md
... since it's easier to successfully cut-and-paste it (doing so from the HTML loses features like the numbers for each question).

Also, what's the guidance on including domain-specific questions in the writeup template (like we see for YANG)? The HTTP WG has developed some guidelines that are likely to be useful for other groups that use the protocol (as is becoming more common), and the RFC Editor seems to be applying them later in the process:
  https://httpwg.org/admin/editors/style-guide

Can we add a question for that?

Cheers,



> On 3 May 2022, at 8:04 pm, Lars Eggert <lars@eggert.org> wrote:
> 
> Hi,
> 
> the IESG has recently made some changes to the document shepherd writeup template. The new template is at https://chairs.ietf.org/documents/qa-style-writeup-template (*) and will also be offered by the datatracker when a writeup is started there.
> 
> The main differences are that we're now using a single template for both WG and non-WG documents, which will make maintenance easier. We've also eliminated the option of the "essay-style" free-form writeup, because we found that those often did not cover all the points we'd like to see covered.
> 
> Please feel free to email the IESG with any questions or comments!
> 
> Thanks,
> Lars
> 
> (*) There are currently some formatting issues on the wiki, but the content of the template is accurate.

--
Mark Nottingham   https://www.mnot.net/

v2.23.0 | Report a Bug | By Email