smiths / caseStudies

Case studies of (manual) documentation for scientific computing software
3 stars 2 forks source link

Update First Sentence of General System Description #91

Closed smiths closed 6 years ago

smiths commented 6 years ago

Please update the first sentence for the General System Description to be more accurate:

"This section provides general information about the system, identifies the interfaces between the system and its environment, and describes the user characteristics and the system constraints."

Should be changed to:

"This section provides general information about the system including identifying the interfaces between the system and its environment (system context), describing the user characteristics and listing the system constraints."

@niazim3, can you look into making this change in the generated Drasil documentation as well? I know when Drasil is fully developed this kind of change should be easy. I'm curious to know if it is an easy change now. All examples share this text, so I hope so. If this is a good example, or even if it isn't, @szymczdm will likely be interested. @niazim3, you can create a separate issue for yourself on this point in the Drasil repo, if you find that easier for tracking purposes.

As far as making the changes in the manual versions, I will assign this to each of the case study owners below. Please check your name of when you have completed the change: