istqborg / istqb_product_base

Code of the LaTeX+Markdown template
0 stars 0 forks source link

CTAL-TA Traceability matrix table in LaTeX #61

Open danopolan opened 1 month ago

danopolan commented 1 month ago

Despite the provided code in #51 comment I am not able to pull the traceability matrix for CTAL TA and I am not able to find an issue with the code.

Initially I have only tried the first part with BOs, but the pipeline failed and cannot find out the problem.

Later I have added all LOs, which makes the full table, but of course, with the same result.

Can you please:

  1. Find the issue(s) I made
  2. Suggest how to debug pipeline failures for LaTeX tables.
  3. Suggest how to debug LaTeX tables creation. Is it possible to use some online tooling? Or syntax checker? Overleaf didn't worked for me :(
  4. Add these hints to the example document.
Witiko commented 1 month ago

Initially I have only tried the first part with BOs, but the pipeline failed and cannot find out the problem.

You have one extra alignment character (&) in the row with TA-BO6, please see https://github.com/istqborg/istqb-ctal-ta/commit/a7801f604d824a5a404e5a9185e5de0ecbd50d37#r142825658.

Later I have added all LOs, which makes the full table, but of course, with the same result.

Your full table from commit https://github.com/istqborg/istqb-ctal-ta/commit/18e3d5fd285231e73d9d29e0ec4f59a3342c6886 does not seem in line with the criteria from item 5 in https://github.com/istqborg/istqb_product_base/issues/51#issue-2322633147. Namely, my code from https://github.com/istqborg/istqb_product_base/issues/51#issuecomment-2145716482 assumes that the table will fit on a single page and will only contain a single matrix. Both these assumptions seem broken by the full table, although it's difficult for me to see how the full table should look just by looking at the code from commit https://github.com/istqborg/istqb-ctal-ta/commit/18e3d5fd285231e73d9d29e0ec4f59a3342c6886. If you need a table that would span several pages, you may need to break the table into several smaller tables, each of which should fit on a single page and be written in a separate ```{=tex} block.

If all "traceability matrix" tables follow a unified format, perhaps it would be easier for you to write them in YAML or Markdown instead of LaTeX. This would make them easier to read, write, and automatically validate. Alternatively, I can produce the LaTeX tables for you if you provide me with screenshots or other examples of the expected output. However, this may slow you down depending on my availability; removing the need for writing tables in LaTeX should be significantly more time-efficient.

Witiko commented 1 month ago

If all "traceability matrix" tables follow a unified format, perhaps it would be easier for you to write them in YAML or Markdown instead of LaTeX. This would make them easier to read, write, and automatically validate. Alternatively, I can produce the LaTeX tables for you if you provide me with screenshots or other examples of the expected output. However, this may slow you down depending on my availability; removing the need for writing tables in LaTeX should be significantly more time-efficient.

For example, I can encode the traceability matrix from https://github.com/istqborg/istqb_product_base/issues/51#issuecomment-2145716482 with the following simple YAML document:

matrix:
  1:  [Understand what testing is and why it is beneficial, 6]
  2:  [Understand fundamental concepts of software testing, 22]
  3:  [Identify the test approach and activities to be implemented depending on the context of testing, 6]
  4:  [Assess and improve the quality of documentation, 9]
  5:  [Increase the effectiveness and efficiency of testing, 20]
  6:  [Align the test process with the software development lifecycle, 6]
  7:  [Understand test management principles, 6]
  8:  [Write and communicate clear and understandable defect reports, 1]
  9:  [Understand the factors that influence the priorities and efforts related to testing, 7]
  10: [Works par of a cross-functional, 8]
  11: [Know risks and benefits related to test automation, 5]
  12: [Identify essential skills required for testing, 5]
  13: [Understand the impact of risk on testing, 4]
  14: [Effectively report on test progress and quality, 4]

Both "FL" and "Foundation Level" are already part of the metadata from the original document and don't need to be specified.

However, your full table from commit https://github.com/istqborg/istqb-ctal-ta/commit/18e3d5fd285231e73d9d29e0ec4f59a3342c6886 indicates that a traceability matrix can be more complex and would require a more general YAML format. If you could help me understand the anatomy of a traceability matrix, we should be able to find a better input format than LaTeX.

danopolan commented 1 month ago

If there is a way how to create such a table easier than using LaTeX, that would be a much preferred.

The table is always a combination of LOs and BOs, and the table width and length depend on the number of BOs and LOs in the syllabus.

Attached, you can find the table for CTAL TA syllabus. All products follow this structure; just the content and respective sizes are different.

ISTQB_CTAL-TA_Appendix B table.docx