[rfc-i] Re: Normative information in RFC imagery

Michael Richardson <mcr+ietf@sandelman.ca> Wed, 14 May 2025 09:06 UTC

Return-Path: <mcr@sandelman.ca>
X-Original-To: rfc-interest@mail2.ietf.org
Delivered-To: rfc-interest@mail2.ietf.org
Received: from localhost (localhost [127.0.0.1]) by mail2.ietf.org (Postfix) with ESMTP id 67D972860616 for <rfc-interest@mail2.ietf.org>; Wed, 14 May 2025 02:06:06 -0700 (PDT)
X-Virus-Scanned: amavisd-new at ietf.org
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, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, RCVD_IN_VALIDITY_SAFE_BLOCKED=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001] autolearn=ham autolearn_force=no
Authentication-Results: mail2.ietf.org (amavisd-new); dkim=pass (2048-bit key) header.d=sandelman.ca
Received: from mail2.ietf.org ([166.84.6.31]) by localhost (mail2.ietf.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id GYmU2fT-NvB0 for <rfc-interest@mail2.ietf.org>; Wed, 14 May 2025 02:06:02 -0700 (PDT)
Received: from relay.sandelman.ca (relay.cooperix.net [176.58.120.209]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-256)) (No client certificate requested) by mail2.ietf.org (Postfix) with ESMTPS id B81C928605FF for <rfc-interest@rfc-editor.org>; Wed, 14 May 2025 02:06:02 -0700 (PDT)
Authentication-Results: relay.sandelman.ca; dkim=pass (2048-bit key; secure) header.d=sandelman.ca header.i=@sandelman.ca header.a=rsa-sha256 header.s=dyas header.b=FIS7rB/F; dkim-atps=neutral
Received: from dyas.sandelman.ca (unknown [IPv6:2001:67c:64:42:787e:97f1:9bf4:2057]) by relay.sandelman.ca (Postfix) with ESMTPS id C03661F4A3; Wed, 14 May 2025 09:06:01 +0000 (UTC)
Received: by dyas.sandelman.ca (Postfix, from userid 1000) id 3AF96AF659; Wed, 14 May 2025 10:06:00 +0100 (BST)
DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=sandelman.ca; s=dyas; t=1747213560; bh=wn280uIvJM8MGTPpPXUfDqQWn7wzSMgF6XDzM9aIB4w=; h=From:To:Subject:In-reply-to:References:Date:From; b=FIS7rB/FKqmrdTHdgjt2MdRrIJSr59DElltPGDsoqlF5QTFKDVKSU0VMLWXThik8t nptGZAb4ZleCFgHVK9XdKJjv80lkt0TPCP7km/V3Ky3UK9GRRq38kP0kSdI3XpZz+0 +q/k151AWzhl23UU2VHtZ/LqnPNgjCDQTNON5hFdtpzin9By0X+woqwm3IaiTZKtOq tp9M7nGlx4HuLBaKRT7xN6VU5Kc0/GK/830zRDjFHtBhYop25EDz5xgo9WkYTUop4C F4CYEvjfcQGnFDkxJhaOYFt6b+SQ8ehxbqtk1P1OfWPZVji4O68i0Cd5w6qzwafqlF BF7N8/VyveZHg==
From: Michael Richardson <mcr+ietf@sandelman.ca>
To: Nico Williams <nico@cryptonector.com>, rfc-interest@rfc-editor.org
In-reply-to: <aCPYogBubUuPGjfI@ubby>
References: <CALLfFGPtFPZh2onghyiiurH0QBOUmde7Xck66+0tv7-OF07QgA@mail.gmail.com> <aCPYogBubUuPGjfI@ubby>
Comments: In-reply-to Nico Williams <nico@cryptonector.com> message dated "Tue, 13 May 2025 18:41:22 -0500."
X-Mailer: MH-E 8.6+git; nmh 1.7.1; GNU Emacs 26.3
MIME-Version: 1.0
Content-Type: multipart/signed; boundary="=-=-="; micalg="pgp-sha512"; protocol="application/pgp-signature"
Date: Wed, 14 May 2025 10:06:00 +0100
Message-ID: <1926430.1747213560@dyas>
Message-ID-Hash: R4P6NK5BE3BWYF2CRARDWZRCDQBEBI5L
X-Message-ID-Hash: R4P6NK5BE3BWYF2CRARDWZRCDQBEBI5L
X-MailFrom: mcr@sandelman.ca
X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; header-match-rfc-interest.rfc-editor.org-0; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header
X-Mailman-Version: 3.3.9rc6
Precedence: list
Subject: [rfc-i] Re: Normative information in RFC imagery
List-Id: "A general discussion list about the RFC Series and its operational processes." <rfc-interest.rfc-editor.org>
Archived-At: <https://mailarchive.ietf.org/arch/msg/rfc-interest/GHX2T8ER-G9gVF0GflnCIExNX3E>
List-Archive: <https://mailarchive.ietf.org/arch/browse/rfc-interest>
List-Help: <mailto:rfc-interest-request@rfc-editor.org?subject=help>
List-Owner: <mailto:rfc-interest-owner@rfc-editor.org>
List-Post: <mailto:rfc-interest@rfc-editor.org>
List-Subscribe: <mailto:rfc-interest-join@rfc-editor.org>
List-Unsubscribe: <mailto:rfc-interest-leave@rfc-editor.org>

Nico Williams <nico@cryptonector.com> wrote:
    > On Tue, May 13, 2025 at 03:00:45PM -0700, Alexis Rossi wrote:
    >> So I think this leads me back to my goal for posting here. Is the community
    >> interested in supporting accessibility by trying to make sure future RFCs
    >> can be fully read and understood without relying on information in imagery?
    >> And thank you for reading this far!

    > I find it surprising that there are RFCs with normative information in
    > imagery.  And I do think that's a problem, that we really should not
    > have any RFCs with normative information in imagery.

I'm sure that this is not true.
I'm sure that there are many RFCs where the format of the
packet/header/extension can only be understood by looking at the image.
I certainly have never included the field sizes in descriptive text.

Note that I think this might apply to **tables**, particularly in txt format.

Calling myself out for a few RFCs I helped author:
My RFC9148 has tables that contain BCP14 language.
RFC9032 has figures for packets, text has no sizes.
And the descriptions are *not* in order, but in relevance, I think.
RFC9031 has time sequence diagrams whose ordering is probably not well
described in the text, but the packets are described by CDDL.
RFC9010 packet diagram where text is not in order, and do not show sizes.
RFC9008 has a network diagram (Figure 3), which shows connectivity, and the
next 24 sections critically depend upon understanding the adjacencies.
And each section has a table that must be illegible in txt.


    > Even plantuml sources will be more accessible than imagery.  We should
    > try to be more formal and precise in prose.

I haven't used this one, but it seems similiar to other things.

    > And we should use formal specifications languages more, or design ones
    > for our needs.  But this last idea is not popular at the IETF.  We're
    > not the ITU-T, which charges money for participation and for copies of
    > many of their specs, but which also has very high production values.

kramdown has many ways to "shell out" to get nice swim diagrams, and other
things.  We probably need a few more popular choices (I mean: best practices
that are well documented), and to socialize those choices.

--
Michael Richardson <mcr+IETF@sandelman.ca>, Sandelman Software Works
 -= IPv6 IoT consulting =-                      *I*LIKE*TRAINS*