Re: [EXT] [testing-wg] Suggestions for the Zephyr Quality report
|
Hake Huang
I see. But I am only aware about rules that cite table with its title, but not from relative position(https://blog.apastyle.org/apastyle/tables-and-figures/ ). And it is the first time that I meet such strict rules that we must cite the table title. Anyway, I am OK with this rule.
Regards, Hake
From: Perkowski, Maciej <Maciej.Perkowski@...>
Sent: 2020年9月29日 18:28 To: Hake Huang <hake.huang@...>; testing-wg@... Subject: RE: [EXT] [testing-wg] Suggestions for the Zephyr Quality report
Caution: EXT Email This refers to the standard that whenever one puts a table or a figure in a document this table/figure has to be mentioned in the main text. In other words it is considered an “error” if there is a figure/table but there is no reference to it in the main text (the main text = the text in each paragraph etc). There always has to be a link between reference in the text and the label describing the figure/table. For example in the 1.3 paragraph I put in the text: “The limits are defined in the release process section of Zephyr documentation. Table 1 shows the number of existing issues with the above filters applied and the limits for each priority.” And below there is a table with the caption: “Table 1.: Number of currently open issues and limits for the release” Is this cleaner now? Regards
Maciej Perkowski
| Software Test Developer
From: Hake Huang <hake.huang@...>
Hi Maciej,
What do you mean the main text?
Regards, Hake From: Perkowski, Maciej <Maciej.Perkowski@...>
Caution: EXT Email Hi Hake, I think it is better to keep the numbering, even if the numbers will change later on. It allows for a correct referring of an entry in the main text to the labeled table/figure. Regards
Maciej Perkowski
| Software Test Developer
From: Hake Huang <hake.huang@...>
Hi Maksim,
Sorry no discuss with you, the reason I do this is because:
We’d better keep the TAB x.x as a pseude token, because we do not know whether we need to insert a new table, just to avoid change the table ID repeatly. And we can assigne them right x.x in final version.
Regards, Hake
From: Masalski, Maksim <maksim.masalski@...>
Caution: EXT Email Hake, what is the Table ID? I removed it, and assigned real number to it. Please, if you want to change design (not content) ask me first. Yesterday I updated Maciej’s section according to the standards.
Maksim
From:
testing-wg@... <testing-wg@...>
On Behalf Of Hake Huang
Hi Maciej,
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
Regards, Hake
From:
testing-wg@... <testing-wg@...>
On Behalf Of Perkowski, Maciej via lists.zephyrproject.org
Caution: EXT Email Dear Testers, 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.
Best regards
Maciej Perkowski
| Software Test Developer
|
|
|
