[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH v2 3/3] docs: fusa: reqs: Added a requirements writing style guide
- To: Ayan Kumar Halder <ayan.kumar.halder@xxxxxxx>
- From: Bertrand Marquis <Bertrand.Marquis@xxxxxxx>
- Date: Fri, 2 Aug 2024 09:52:33 +0000
- Accept-language: en-GB, en-US
- Arc-authentication-results: i=2; mx.microsoft.com 1; spf=pass (sender ip is 63.35.35.123) smtp.rcpttodomain=lists.xenproject.org smtp.mailfrom=arm.com; dmarc=pass (p=none sp=none pct=100) action=none header.from=arm.com; dkim=pass (signature was verified) header.d=arm.com; arc=pass (0 oda=1 ltdi=1 spf=[1,1,smtp.mailfrom=arm.com] dkim=[1,1,header.d=arm.com] dmarc=[1,1,header.from=arm.com])
- Arc-authentication-results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=arm.com; dmarc=pass action=none header.from=arm.com; dkim=pass header.d=arm.com; arc=none
- Arc-message-signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector10001; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=4zny0u29PDwoKSUUaQ4Crr8XYTC3FaXx+RhNkv7KRZQ=; b=wjcySPO0NYTyisOuOt3/YkujZFjr5YeH133Jk36CQVwMwMknCkWLfl4TF3PG7HQXdk2edntuXkKkZA0P5z2WNJY9iUwz73K6dLPBt4f2wDJgE/nRDnq+G46VbnCSY7tutPUvr+UEypWRizzEaWNVptCgWkxBvaCWSugIFYUw83H39uU3JbZ9RB8FlFISC+UaGG4bAaepyod2QEW0Wxkg0y8VB+k6T7i1TykR5oCJsEPJ3a1q9B2khJieVKYkAgxWdILpGwkkf0jsdMKibCQs2HhvjJ8AO/05ShwBVHySk4yqGWLH8ykAkF5s9C077KzZOQAGrEi7LAoj+g8lok180g==
- Arc-message-signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector10001; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=4zny0u29PDwoKSUUaQ4Crr8XYTC3FaXx+RhNkv7KRZQ=; b=cJwWI7aZXczmwkyux0G0SI8+k8iTcijZMdoeKlDYxpjPCxuTRQJZEwZWbfqB9+yNrWGIrwbVNgdfQvJJAbiYwdTiTP+ZFTAVyeLqxhzkJhniAs6tr2Gw5a2I96GhRBE+mgMaFnA5AqxwAjlVYfECKywBISLLxCiOIxYtoFTv1dV/d3Kw66Xbrv5troMwpp7Fu+W94UffXnbYMuB4cKcPvQGNnTp0K/2RFU+bjdcWc22RM+t40a8+TsgxGu955rkGqpV+n+/tCiqxA8RGzyekiG0VnMfCbRAe4tkBMMWRpeo+2jdaRq8zR5lymYUEFqhagZS3WAXDlgrotNT/q6YX3A==
- Arc-seal: i=2; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=pass; b=tg3Sbl8YXsh1ZAhT3qe+hshjFndu5lMO5Y9AYrSk/o288bcqep/8Usbuz8lQGRoyRkGaT8YqWK9a9SQtrVjX58j2X6XM9zpAW1aD334FticfMHbr5J5kyxDXIF3Ihyrzd0+0kAHBFyLiwixTe8EU0yuqqZa7Hwc3OfNzPfKvEYK3y2ksHkJPe66X/lu/z11AldaXFm8v5YPrgqU/j3W3YAliPrENLGi1v7K8JZ1LEbOjdgDuLtmwCPBEQICVjoczxV29LE2v9/xyQ8uvd52/Ko0eieAz880Qfy7EWW6xzWe3rRf9Gpypua/f/drH4C5O0s2mfSlMsJSSN4JAYrL5Cw==
- Arc-seal: i=1; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=none; b=gU6tXNAjWjVQQ99UgTTReR4eb9J2vOktrteMVexQylsAU2LQHRetgGzZEISxZtHBZ4+rKWrnCiRP6EIVu6tju0Ter4vo5qYwBRYhUG3NgmEPgVK1hX8zxutHLom4b1zacjZYTYr2w7/PfqTcnQj4+DjB8FRv3TLUYzG5ESBLEy/FjR799Df7iwTlGQXVifyECMCOskY+1XsuZBaeYplaIReT24lubb15gT45bCGr59yYLsGSNaC7oFCZVqo2vZRsztxCznFH3OR2b2jQREpSvwTSxjz3NZFV5O2E4sz7MZpr4Ud6I5Cehc6JQyB+MdUjMNqUvnHN8c/yYnDbkQ2+3Q==
- Authentication-results-original: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=arm.com;
- Cc: Stefano Stabellini <sstabellini@xxxxxxxxxx>, Michal Orzel <michal.orzel@xxxxxxx>, "artem_mygaiev@xxxxxxxx" <artem_mygaiev@xxxxxxxx>, Julien Grall <julien@xxxxxxx>, Xen-devel <xen-devel@xxxxxxxxxxxxxxxxxxxx>
- Delivery-date: Fri, 02 Aug 2024 09:52:56 +0000
- List-id: Xen developer discussion <xen-devel.lists.xenproject.org>
- Nodisclaimer: true
- Original-authentication-results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=arm.com;
- Thread-index: AQHa5MDknNNq96uHEUOMvzKrR1J1AbITudaA
- Thread-topic: [PATCH v2 3/3] docs: fusa: reqs: Added a requirements writing style guide
Hi Ayan,
> On 2 Aug 2024, at 11:46, Ayan Kumar Halder <ayan.kumar.halder@xxxxxxx> wrote:
>
> Added a guide to help write and review requirements. The requirements
> are written to enable safety certification of Xen hypervisor.
>
Just a reminder if someone commits this serie:
PATCH 2 MUST NO BE COMMITED !!
Would have been a good idea to have it at the end of the serie and this one
before.
In any case:
> Signed-off-by: Ayan Kumar Halder <ayan.kumar.halder@xxxxxxx>
Acked-by: Bertrand Marquis <bertrand.marquis@xxxxxxx>
Cheers
Bertrand
> ---
> Changes from :-
>
> v1 - 1. No change.
>
> docs/fusa/reqs/REQUIREMENTS-STYLE | 34 +++++++++++++++++++++++++++++++
> 1 file changed, 34 insertions(+)
> create mode 100644 docs/fusa/reqs/REQUIREMENTS-STYLE
>
> diff --git a/docs/fusa/reqs/REQUIREMENTS-STYLE
> b/docs/fusa/reqs/REQUIREMENTS-STYLE
> new file mode 100644
> index 0000000000..cd2408b9f2
> --- /dev/null
> +++ b/docs/fusa/reqs/REQUIREMENTS-STYLE
> @@ -0,0 +1,34 @@
> +Requirements writing style for the Xen Hypervisor
> +=================================================
> +
> +The requirements writing style described below is the style used for writing
> the
> +requirements of the Xen hypervisor to enable functional safety certification.
> +
> +The requirements writing style is inspired from the ANSI/IEEE guide to
> Software
> +Requirements Standard. Specifically, the requirements should satisfy the
> +following validation checklist.
> +(Source -
> https://www.nasa.gov/reference/appendix-c-how-to-write-a-good-requirement)
> +
> +Clarity -
> +The requirements should be clear, unambiguous, consise and simple. Each
> +requirement should express a single thought. Each requirement stated should
> have
> +a single interpretation.
> +
> +Consistency -
> +Any requirement shouldn't contradict with any other requirement. The
> requirements
> +should be categorized correctly (the categories have been explained in the
> +README). The tone of each requirement should be definitive (ie "Xen shall
> ..."
> +should be present in each requirement).
> +
> +Traceability -
> +Any market requirement should be linked to the product requirement/s and
> +vice versa. Any product requirement should be linked to the design
> requirement/s
> +and vice versa. Full bi-directional traceability should be maintained between
> +market, product and design requirements.
> +
> +Correctness -
> +The requirements should be feasible and technically correct (at the time of
> +writing). However, it is not expected that the requirements will be kept upto
> +date with the code.
> +
> +The requirements follow the same license and line length as the code.
> --
> 2.25.1
>
|
