Re: [EXT] [testing-wg] Suggestions for the Zephyr Quality report
I update the information explaining on every section, please check.
Also I unified the table title to `Heading 3` format and add [Table ID] as template
From: testing-wg@... <testing-wg@...> On Behalf Of Perkowski, Maciej via lists.zephyrproject.org
Sent: 2020年9月28日 23:26
Subject: [EXT] [testing-wg] Suggestions for the Zephyr Quality report
Caution: EXT Email
The discussion about the Zephyr Quality report (https://docs.google.com/document/d/1y7mtAhmvl5z1ohazNgXFEXdFg6RO-J38QsFA7twPPW8) is ongoing and we are systematically filling the report. I would like to ask everyone who is taking part in the process to add/expand the description for each section/paragraph they are working on. It is important to add information explaining what the reader is looking at and also why this information is provided (what is the purpose).
I would suggest focusing on writing the descriptions before we continue discussing each item in the report. I think we spend too much time during the meetings on asking/replying "what are we looking at?”. I believe having the purpose written down can also help in shaping the entry and validating if the entry fulfills the described goals.
I would also suggest that we start using a coherent standard for the document format. I opt for a standard that is used in scientific papers. In particular the following rules:
-each table and figure has to be referred to in the main text (no tables/figures without being mentioned in the main text)
-each table and figure needs a proper description. The description (caption) for a figure is put directly under the figure and starts with "Fig. x.x: " and the description for a table is located directly above the table and starts with "Tab. x.x: "
I believe keeping the above standards could ease the report creation/validation process.
| Software Test Developer