Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Differences in Table of Abbreviations and Acronyms in GlassBR SRS #825

Closed
6 tasks done
samm82 opened this issue Jul 11, 2018 · 2 comments · Fixed by #938
Closed
6 tasks done

Differences in Table of Abbreviations and Acronyms in GlassBR SRS #825

samm82 opened this issue Jul 11, 2018 · 2 comments · Fixed by #938
Assignees

Comments

@samm82
Copy link
Collaborator

samm82 commented Jul 11, 2018

The following differences exist between the tables of abbreviations and acronyms in the Drasil (left) and caseStudies PDFs:

  • Change "Symbol" column header to "Abbreviation" and "Description" to "Full Form" in Drasil
  • Remove the following from caseStudies: ARmax, LDF, LR, LSF, NFL
  • Add the following to caseStudies: A, DD, GS, IM, LC, PS, R, SD, SRS, T, UC
  • Remove TU from Drasil
  • Remove TNT from Drasil
  • Remove TNT from caseStudies

abbr and acro

@smiths
Copy link
Collaborator

smiths commented Jul 11, 2018

I will edit in my thoughts below.

  • The Drasil table is centered while the caseStudies one is left-justified [This is an arbitrary choice, although for this particular table, I think the left justified looks better. There is no need to change it in either example.]
  • Column headers are different: [The fields in Drasil seem to be borrowed from the table of symbols. I prefer the headings in the table of abbreviations and acronyms. Can we correct this in Drasil?]
    • "Symbol" in Drasil vs. "Abbreviation"
    • "Description" in Drasil vs. "Full Form"
    • Section headers are bold in caseStudies [It isn't a priority to make the two versions consistent on this formatting detail.]
  • "TNT Equivalent Factor" in Drasil vs. "TNT equivalent factor" [I think I know the reason for this difference. Acronyms are expanded with capitals in Drasil, to make the connection between the acronym letter and the word it stands for. Unfortunately in the case of TNT the symbol's meaning isn't exactly an expansion of each of the letters. Does TNT appear in the table of symbols for Drasil? We should consider removing TNT entirely from the table of abbreviations and acronyms. We aren't really treating it like an acronym. We discussed this in a previous issue. I think we should discuss only having TNT and other acronym inspired symbols only appearing in the table of symbols. Please create a separate issue to discuss this point.]
  • The following are missing from Drasil: ARmax, LDF, LR, LSF, NFL
    • These are instead defined in the Table of Symbols of Drasil - related to Differences in Table of Symbols in GlassBR SRS #824 [I was just thinking about that. I think these are better defined in the table of symbols. Please update the case study to match Drasil.]
  • The following are in Drasil but not caseStudies: A, DD, GS, IM, LC, PS, R, SD, SRS, T, TU, UC [Please add these to the case study.]

@smiths smiths assigned samm82 and unassigned smiths Jul 11, 2018
@samm82
Copy link
Collaborator Author

samm82 commented Jul 11, 2018

TNT is in Drasil's Table of Symbols, and I'll make an issue for discussing the table of symbols point. Should TNT then be removed from Table of AandAs? Or should I wait for the discussion on #842?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants