Skip to content

Commit c39d9fa

Browse files
committed
hyperrefs
1 parent 306a04f commit c39d9fa

2 files changed

Lines changed: 87 additions & 41 deletions

File tree

10.5 KB
Binary file not shown.

docs/ReflectAndTrace/ReflectAndTrace.tex

Lines changed: 87 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -416,6 +416,7 @@ \subsubsection{Module Guide (MG)}\label{ssubsec:mg-trace}
416416

417417
\end{longtable}
418418

419+
419420
\subsubsection{Module Interface Specification (MIS)}
420421
\label{ssubsec:mis-trace}
421422

@@ -450,7 +451,8 @@ \subsubsection{Module Interface Specification (MIS)}
450451
This aligned the type names with the notation table and removed
451452
inconsistent wording.
452453
&
453-
Issue \#265; Section~4.3, Table~2
454+
\href{https://github.com/thaafei/DomainX/issues/265}{Issue \#265};
455+
Section~4.3, Table~2
454456
\\
455457

456458
TA Review \#200,
@@ -462,7 +464,8 @@ \subsubsection{Module Interface Specification (MIS)}
462464
and to improve consistency between the MIS and implementation-facing
463465
documentation.
464466
&
465-
Issue \#264; Sections~4.4 and~6
467+
\href{https://github.com/thaafei/DomainX/issues/264}{Issue \#264};
468+
Sections~4.4 and~6
466469
\\
467470

468471
TA Review \#200,
@@ -474,7 +477,8 @@ \subsubsection{Module Interface Specification (MIS)}
474477
Added local functions where appropriate and revised module descriptions
475478
to better justify the structure of the affected modules.
476479
&
477-
Issue \#263; Section~6
480+
\href{https://github.com/thaafei/DomainX/issues/263}{Issue \#263};
481+
Section~6
478482
\\
479483

480484
TA Review \#200,
@@ -487,7 +491,8 @@ \subsubsection{Module Interface Specification (MIS)}
487491
runtime container for the client application and clarified its role in
488492
the system.
489493
&
490-
Issue \#262; Section~6.1
494+
\href{https://github.com/thaafei/DomainX/issues/262}{Issue \#262};
495+
Section~6.1
491496
\\
492497

493498
TA Review \#200,
@@ -498,10 +503,12 @@ \subsubsection{Module Interface Specification (MIS)}
498503
Revised the introductory text for module decomposition so that it
499504
explicitly refers to Table~3.
500505
&
501-
Issue \#261; Section~5, Table~3
506+
\href{https://github.com/thaafei/DomainX/issues/261}{Issue \#261};
507+
Section~5, Table~3
502508
\\
503509

504-
Peer Review \#239
510+
Peer Review
511+
\href{https://github.com/thaafei/DomainX/issues/239}{\#239}
505512
&
506513
The MIS is missing abbreviations and acronyms needed for readability.
507514
&
@@ -511,8 +518,9 @@ \subsubsection{Module Interface Specification (MIS)}
511518
Section~2, Table~1
512519
\\
513520

514-
Peer Reviews \#217
515-
and \#218
521+
Peer Reviews
522+
\href{https://github.com/thaafei/DomainX/issues/217}{\#217}
523+
and \href{https://github.com/thaafei/DomainX/issues/218}{\#218}
516524
&
517525
Module subsections, module types, and input/output types are unclear.
518526
&
@@ -523,8 +531,9 @@ \subsubsection{Module Interface Specification (MIS)}
523531
Section~4.3, Table~2; Section~6
524532
\\
525533

526-
Peer Reviews \#212
527-
and \#223
534+
Peer Reviews
535+
\href{https://github.com/thaafei/DomainX/issues/212}{\#212}
536+
and \href{https://github.com/thaafei/DomainX/issues/223}{\#223}
528537
&
529538
The level of abstraction and module hierarchy need to be more precise.
530539
&
@@ -536,8 +545,10 @@ \subsubsection{Module Interface Specification (MIS)}
536545
\\
537546

538547
Final Documentation
539-
Issue \#501
540-
(sub-issues \#481 to \#485)
548+
\href{https://github.com/thaafei/DomainX/issues/501}{Issue \#501}
549+
(sub-issues
550+
\href{https://github.com/thaafei/DomainX/issues/481}{\#481} to
551+
\href{https://github.com/thaafei/DomainX/issues/485}{\#485})
541552
&
542553
Remove unnecessary text, clarify parameters and outputs, fix
543554
formatting, and hyperlink module references.
@@ -552,23 +563,18 @@ \subsubsection{Module Interface Specification (MIS)}
552563
\end{longtable}
553564

554565

566+
555567
\subsection{VnV Plan and Report}
556568
This section summarizes the feedback received on the Verification
557-
and Validation (V\&V) Plan and report. It is divided into their respective subsection.
558-
559-
\subsubsection{VnV Plan}
560-
\label{ssubsec:vnv-plan-trace}
561-
562-
This subsection summarizes the feedback received on the Verification
563-
and Validation (V\&V) Plan and the revisions made in response. The
564-
updates focused on improving traceability, clarifying verification
565-
approaches, strengthening test descriptions, and refining the
566-
structure and readability of the document.
569+
and Validation (V\&V) Plan and V\&V Report. The updates focused on
570+
improving traceability, clarifying verification approaches,
571+
strengthening test descriptions, and refining the structure and
572+
readability of the documents.
567573

568574
\begin{longtable}{p{0.18\textwidth} p{0.26\textwidth}
569575
p{0.34\textwidth} p{0.16\textwidth}}
570-
\caption{V\&V Plan feedback and response traceability}
571-
\label{tab:vnv-plan-trace}\\
576+
\caption{V\&V Plan and Report feedback and response traceability}
577+
\label{tab:vnv-plan-report-trace}\\
572578
\toprule
573579
Source & Feedback & Change Made & Where Addressed \\
574580
\midrule
@@ -582,7 +588,7 @@ \subsubsection{VnV Plan}
582588
\bottomrule
583589
\endfoot
584590

585-
TA Review \#130,
591+
TA Review \href{https://github.com/thaafei/DomainX/issues/130}{\#130},
586592
annotated VnVPlan.pdf
587593
&
588594
Traceability table contains unnecessary columns.
@@ -594,7 +600,7 @@ \subsubsection{VnV Plan}
594600
Section~4.3, Table~9
595601
\\
596602

597-
TA Review \#130,
603+
TA Review \href{https://github.com/thaafei/DomainX/issues/130}{\#130},
598604
annotated VnVPlan.pdf
599605
&
600606
Traceability between test cases and requirements is unclear.
@@ -606,7 +612,7 @@ \subsubsection{VnV Plan}
606612
Section~4.3
607613
\\
608614

609-
TA Review \#130,
615+
TA Review \href{https://github.com/thaafei/DomainX/issues/130}{\#130},
610616
annotated VnVPlan.pdf
611617
&
612618
Verification approach is ambiguous and difficult to follow.
@@ -618,7 +624,7 @@ \subsubsection{VnV Plan}
618624
Section~4.1; Section~4.2
619625
\\
620626

621-
TA Review \#130,
627+
TA Review \href{https://github.com/thaafei/DomainX/issues/130}{\#130},
622628
annotated VnVPlan.pdf
623629
&
624630
Test case descriptions are incomplete and include unnecessary columns.
@@ -630,7 +636,7 @@ \subsubsection{VnV Plan}
630636
Section~4.1.1--4.1.3
631637
\\
632638

633-
TA Review \#130,
639+
TA Review \href{https://github.com/thaafei/DomainX/issues/130}{\#130},
634640
annotated VnVPlan.pdf
635641
&
636642
Unclear whether tests are manual or automated.
@@ -641,7 +647,7 @@ \subsubsection{VnV Plan}
641647
Section~3.5; Section~3.6; Section~4
642648
\\
643649

644-
TA Review \#130,
650+
TA Review \href{https://github.com/thaafei/DomainX/issues/130}{\#130},
645651
annotated VnVPlan.pdf
646652
&
647653
Descriptions of testing tools are vague.
@@ -652,7 +658,7 @@ \subsubsection{VnV Plan}
652658
Section~3.6, Table~5
653659
\\
654660

655-
TA Review \#130,
661+
TA Review \href{https://github.com/thaafei/DomainX/issues/130}{\#130},
656662
annotated VnVPlan.pdf
657663
&
658664
Unclear ownership of verification activities.
@@ -663,7 +669,7 @@ \subsubsection{VnV Plan}
663669
Section~3.1, Table~4
664670
\\
665671

666-
TA Review \#130,
672+
TA Review \href{https://github.com/thaafei/DomainX/issues/130}{\#130},
667673
annotated VnVPlan.pdf
668674
&
669675
Usability evaluation is not fully specified.
@@ -675,18 +681,19 @@ \subsubsection{VnV Plan}
675681
Section~4.2.3; Appendix~7.2
676682
\\
677683

678-
TA Review \#130,
684+
TA Review \href{https://github.com/thaafei/DomainX/issues/130}{\#130},
679685
annotated VnVPlan.pdf
680686
&
681687
Ambiguity between SRS walkthroughs and code walkthroughs.
682688
&
683-
Clarified distinction between SRS verification walkthroughs and code
684-
walkthroughs, and placed them in appropriate sections of the plan.
689+
Clarified the distinction between SRS verification walkthroughs and
690+
code walkthroughs, and placed them in appropriate sections of the
691+
plan.
685692
&
686693
Section~3.2; Section~3.5
687694
\\
688695

689-
TA Review \#130,
696+
TA Review \href{https://github.com/thaafei/DomainX/issues/130}{\#130},
690697
annotated VnVPlan.pdf
691698
&
692699
Missing list of tables and figures based on rubric.
@@ -697,19 +704,58 @@ \subsubsection{VnV Plan}
697704
Contents page
698705
\\
699706

700-
Peer Review \#461
707+
Peer Review \href{https://github.com/thaafei/DomainX/issues/461}{\#461}
701708
&
702709
Traceability between VnV Plan and VnV Report is insufficient.
703710
&
704-
Ensured consistent identifiers are used across both documents so that
705-
test results in the VnV Report map directly to planned verification
706-
activities in the VnV Plan.
711+
Aligned identifiers and requirement mappings across both documents so
712+
that planned tests correspond directly to reported results, improving
713+
end-to-end traceability.
707714
&
708-
Section~4.3
715+
VnV Plan Section~4.3; VnV Report Sections~3--4
716+
\\
717+
718+
Issue \href{https://github.com/thaafei/DomainX/issues/528}{\#528}
719+
&
720+
Update tests for implemented features that were previously marked as
721+
in progress in earlier versions of the report.
722+
&
723+
Revised the functional requirements evaluation to reflect completed
724+
implementations rather than listing them under features in progress.
725+
Functional test cases were updated to align with the current system
726+
state.
727+
&
728+
VnV Report, Section~3
729+
\\
730+
731+
TA Review (annotated VnV Report PDF)
732+
&
733+
Some nonfunctional results are marked as \textit{Partial}.
734+
&
735+
Expanded the corresponding nonfunctional sections to clarify the
736+
meaning of partial results and to document limitations and next steps
737+
for incomplete verification.
738+
&
739+
VnV Report, Section~4
740+
\\
741+
742+
TA Review (annotated VnV Report PDF)
743+
&
744+
Computational accuracy test case summary appears incomplete.
745+
&
746+
Completed the computational accuracy subsection by adding a full test
747+
case summary, including method, results, and analysis of AHP outputs.
748+
&
749+
VnV Report, Section~4.4
709750
\\
710751

711752
\end{longtable}
712753

754+
755+
756+
757+
758+
713759
\section{Extras}
714760

715761
Our extra is a research paper on the \href{https://github.com/thaafei/DomainX/blob/main/docs/ResearchReport/StateOfPractice_NLP.pdf}{State of the Practice for Open-Source Neural Network Software}. In this research paper, we identified a shortlist of 28 open-source Neural Network (NN) software packages and measured them across 9 qualities to have a pair-wise comparison using the Analytical Hierarchy Process (AHP).

0 commit comments

Comments
 (0)