Drasil icon indicating copy to clipboard operation
Drasil copied to clipboard

SWHS Body, Hardcoded Names

Open danscime opened this issue 5 years ago • 2 comments

Better names should be used for some things in SWHS Body

Screen Shot 2019-08-21 at 2 28 09 PM Screen Shot 2019-08-21 at 2 28 17 PM

danscime avatar Aug 21 '19 18:08 danscime

Here is a summary of what we discussed today (June 17th, 2022).

The problem is variable names, phySyst1, phySys2, did not capture enough knowledge, and they will decrease the readability.

The reason is that we don't have a clear structured knowledge of some SRS.

For example, if phySyst1 and phySys2 are sentences in a paragraph, they have a different meanings. The first sentence usually is a topic sentence. Then, there will be the background, argument, summary, and so on. In structured writing, there is a lot of meta knowledge. That's the missing part.

cd155 avatar Jun 17 '22 19:06 cd155

Thank you for the comments @cd155. Well said. We also discussed adding a link to this issue to the contributor's guidelines, so that future contributors watch for this kind of error.

smiths avatar Jun 19 '22 01:06 smiths