From 70538e78f7c28a3b0e19cf7cfbf662cf151313dc Mon Sep 17 00:00:00 2001 From: Julie LeBrun <38360781+TumbaoJu@users.noreply.github.com> Date: Thu, 11 Jul 2024 09:45:28 -0400 Subject: [PATCH 1/3] Update USAGE.md Proposition from functional working group --- template/module/readme/USAGE.md | 26 ++++++++++++++++++-------- 1 file changed, 18 insertions(+), 8 deletions(-) diff --git a/template/module/readme/USAGE.md b/template/module/readme/USAGE.md index 35260d67..f34e5c34 100644 --- a/template/module/readme/USAGE.md +++ b/template/module/readme/USAGE.md @@ -1,11 +1,21 @@ -[ This file must be present and contains the usage instructions - for end-users. As all other rst files included in the README, - it MUST NOT contain reStructuredText sections - only body text (paragraphs, lists, tables, etc). Should you need - a more elaborate structure to explain the addon, please create a - Sphinx documentation (which may include this file as a "quick start" - section). ] +[ This file is required and contains the instructions on **“how”** to use the module for end-users. + +If the module does not have a visible impact on the user interface, just add the following sentence: + +> This module does not impact the user interface. + +If that’s not the case, please make sure that every usage step is covered and remember that images speak more than words!] To use this module, you need to: -1. Go to ... +- Go to *App* > Menu > Menu item + + *insert screenshot!* + +- In “Contact” form, add a value to field `xyz` > save + + *insert screenshot!* + +- The value of `xyz` is now displayed in the list view. + + *insert screenshot!* From 72194db54f2007a045cd843cf6c664c09484f0dd Mon Sep 17 00:00:00 2001 From: Julie LeBrun <38360781+TumbaoJu@users.noreply.github.com> Date: Mon, 29 Jul 2024 10:19:31 -0400 Subject: [PATCH 2/3] Update template/module/readme/USAGE.md Co-authored-by: Jairo Llopis <973709+yajo@users.noreply.github.com> --- template/module/readme/USAGE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/template/module/readme/USAGE.md b/template/module/readme/USAGE.md index f34e5c34..5371dc03 100644 --- a/template/module/readme/USAGE.md +++ b/template/module/readme/USAGE.md @@ -12,7 +12,7 @@ To use this module, you need to: *insert screenshot!* -- In “Contact” form, add a value to field `xyz` > save +- In “Contact” form, add a value to field *xyz* > save *insert screenshot!* From 9cb11b6ca6f69c8e62c43cbc851621f5de807cf8 Mon Sep 17 00:00:00 2001 From: Julie LeBrun <38360781+TumbaoJu@users.noreply.github.com> Date: Mon, 29 Jul 2024 10:19:56 -0400 Subject: [PATCH 3/3] Update template/module/readme/USAGE.md Co-authored-by: Jairo Llopis <973709+yajo@users.noreply.github.com> --- template/module/readme/USAGE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/template/module/readme/USAGE.md b/template/module/readme/USAGE.md index 5371dc03..2cf12758 100644 --- a/template/module/readme/USAGE.md +++ b/template/module/readme/USAGE.md @@ -16,6 +16,6 @@ To use this module, you need to: *insert screenshot!* -- The value of `xyz` is now displayed in the list view. +- The value of *xyz* is now displayed in the list view. *insert screenshot!*