diff --git a/spec/design.md b/spec/design.md index 27f076c..5259bd6 100644 --- a/spec/design.md +++ b/spec/design.md @@ -157,10 +157,10 @@ A[A:I am writing, Help Terminology!];B{B:Terms understood?} A --> |1: Identify concepts| B ``` -#### why writing your objectives and ideas down [#why-objectives] +#### why writing your objectives and ideas down {#why-objectives} You want to be understood and seek support for your plans or ideas. To guide this process, it's good to have a reference. -#### what is "identifying a concept"? [#what-identifying] +#### what is "identifying a concept"? {#what-identifying} An identifier points to something, in this case to a concept. Identification is the process of clearly describing what the concept is and defining the term that points to it. ### 2. Write the concept in a specific way: formulate criteria when you expect confusion to arise @@ -171,7 +171,7 @@ B{B:Terms understood?}; D{D:Text with criteria understood?}; B --> |2: No, I'll write criteria| D ``` -#### why criteria? [#why-criteria] +#### why criteria? {#why-criteria} Another person should be able to apply wording to a certain concept and then be able to independently decide whether something falls in or out of the criterium. Example: if a stool is defined with the criterium "all furniture to comfortably sit on with exactly 3 legs from seat to each non-fixed contact point of the leg on the floor", then anyone could (dis)qualify various instances of something to sit on that looks like a stool to many. Although you might not fully agree that a 4-legged stool is no stool according to this definition with this criterium, the fact is that it's the generally applicable criterium that we were looking for. @@ -191,11 +191,11 @@ Example: moving stools If a group of people had to move every stool, but only stools, from a furniture warehouse into a large lorry without clear criteria what a stool is and isn't, you will end up leaving stools behind and for sure bringing back half a lorry of furniture upon unloading. -#### how to formulate criteria [#how-criteria] +#### how to formulate criteria {#how-criteria} In text. And you could add examples to a criterium of edge cases / corner cases: what falls just in the criterium and what is just outside? -#### what are good criteria? [#what-good-criteria] +#### what are good criteria? {#what-good-criteria} Criteria that are determistic and clearly distinguish something. @@ -207,12 +207,12 @@ D{D:Text with criteria understood?} D --> |3: No, I'll adjust criteria| D ``` -#### why replace terms by criteria? [#why-replace] +#### why replace terms by criteria? {#why-replace} Criteria can be independently applied, terms have a aledged meaning and interpretation might of terms might point to distinctive concepts. Example: *move the stools into the van* might be interpreted as "break out the fixed stools in the cantina and bring the remnants to the van". -#### how to replace terms by criteria? [#how-replace] +#### how to replace terms by criteria? {#how-replace} Simply replace the term by the sentences criteria might consist of. @@ -228,11 +228,11 @@ E[E:Term definition incl. criteria]; F[/F:Text with terms/] E --> |4: Replace criteria by term | F ``` -#### why put back terms [#why-back-terms] +#### why put back terms {#why-back-terms} Once you've succesfully identified a concept for all stakeholders, it makes no sense to maintain repetitions of lengthy criteria descriptions in a text. Maitenance of the criteria is also easier with a single point of defnition. -#### how to put back terms [#how-back-terms] +#### how to put back terms {#how-back-terms} Be sure to create a Terminology definition with the criteria and identify this concept with the term intended.