[Tools-arch] Recommendation 11: Tools ease of use and quality

Jay Daley <jay@ietf.org> Fri, 09 April 2021 01:14 UTC

Return-Path: <jay@ietf.org>
X-Original-To: tools-arch@ietfa.amsl.com
Delivered-To: tools-arch@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 496163A24E9 for <tools-arch@ietfa.amsl.com>; Thu, 8 Apr 2021 18:14:53 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.899
X-Spam-Level:
X-Spam-Status: No, score=-1.899 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, URIBL_BLOCKED=0.001] autolearn=ham autolearn_force=no
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 WhZv2YJLoR7T for <tools-arch@ietfa.amsl.com>; Thu, 8 Apr 2021 18:14:51 -0700 (PDT)
Received: from jays-mbp.localdomain (unknown [158.140.230.105]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPSA id 076C63A24DF for <tools-arch@ietf.org>; Thu, 8 Apr 2021 18:14:42 -0700 (PDT)
From: Jay Daley <jay@ietf.org>
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable
Mime-Version: 1.0 (Mac OS X Mail 13.4 \(3608.120.23.2.4\))
Message-Id: <C46EAC37-A576-43E3-9720-4AAB3AA9CB72@ietf.org>
Date: Fri, 09 Apr 2021 13:14:39 +1200
To: tools-arch@ietf.org
X-Mailer: Apple Mail (2.3608.120.23.2.4)
Archived-At: <https://mailarchive.ietf.org/arch/msg/tools-arch/tKW4VWK0ZXA3Q8pxlU_TOAnYcMk>
Subject: [Tools-arch] Recommendation 11: Tools ease of use and quality
X-BeenThere: tools-arch@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Tools Architecture and Strategy Team <tools-arch.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/tools-arch>, <mailto:tools-arch-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/tools-arch/>
List-Post: <mailto:tools-arch@ietf.org>
List-Help: <mailto:tools-arch-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/tools-arch>, <mailto:tools-arch-request@ietf.org?subject=subscribe>
X-List-Received-Date: Fri, 09 Apr 2021 01:14:53 -0000

=  Recommendation

Recommendation 11:  Initiate a project to raise the overall ease of use and quality of authoring tools, probably involving a UX professional to create a consistent interaction model for all IETF-supported tools.  This is closely linked to recommendation 8 as the end-to-end support of tools is a key element of their ease of use. 

=  Commentary

For info, recommendation 8 is intended for RSOC: “An end-to-end analysis is carried out to ensure that v3 XML can be used effectively and seamlessly at all stages of the authoring process.”.

An application interaction model is a description of the actions someone can perform in an application and the objects they can perform those on, all expressed in a set of simple concepts and terminology, such that once someone understands those concepts and terminology, understanding how to interact with unfamiliar actions or objects becomes intuitive. 

This is recommending using a UX professional to develop such a model and document it in a style guide that is used for all IETF-commissioned work and recommended to third parties who voluntarily develop tools.   

To give an example, an interaction model may define the concept of ‘validator’ as follows:

	• A ‘validator’ is passed a document/fragment which it makes no changes to.  It returns a list of annotations and an overall status for the document/fragment.  Each annotation consists of […].  The list of statuses and their meanings is [...]. 

An interaction model would generally be developed before or as part of any standardisation of APIs as discussed under recommendation 6.

The TAS Team may feel this is more of an implementation issue and so best left to the Tools Team.



-- 
Jay Daley
IETF Executive Director
jay@ietf.org