Devonfw guide should use a clear and consistent taxonomy
Opened this issue · 0 comments
As a reader of the devonfw guide, I want to understand what devonfw is and what parts it consists of so that I do not get confused.
Thoughout the devonfw guide several terms (i.e. words) are used to refer to devonfw and its constituents. It appears to me that amoung these terms there is a (somtimes confusing) multitude of synonyms (i.e. different terms for the same concept). Other terms appear to be used not consistently (one term used for more than one concept although there are other terms available to distinguish these concepts).
I found the following terms in the devonfw guide as of December 2019 (grouped into groups of synonyms):
- devonfw (many occurrences)
- devonfw platform (ca. 6 occurrences)
- devonfw ide (ca. 5 occurrences)
- devonfw-ide (ca. 80 occurrences)
- devon ide (ca. 4 occurrences)
- devon-ide (ca. 4 occurrences [code not counting])
- devonfw ide package (1 occurrence) [the ide package is presumably something else than the ide ==> not a synonym, right?]
- devon CLI (2 occurrences)
- devonfw IDE CLI (1 occurrence)
- devonfw-ide CLI (1 occurrence)
- devon-dist (2 occurrences)
- devonfw distribution (ca. 28 occurrences)
- devon distribution (ca. 7 occurrences)
- "Devon Dist" (1 occurrence)
- devonfw package (1 occurrence) [this may or may not (???) be a synonym to devonfw distribution]
- devonfw Platform Extension Pack (4 occurrences)
- devonfw environment (3 occurrences)
[all counts include only those occurrences where there could be a synonym, e.g. code samples, URIs, ... are not counted]
==> please verify that each group is indeed a group of synonyms where all terms within a group mean the same thing under all conditions (and if my grouping was wrong, please correct by splitting the group)
==> please join synonym groups where necessary (perhaps "devonfw ide" == "devonfw environment" ???)
==> please create a glossary where for each remaining synonym group, one term is defined (explained) what it is and the synonyms are mentioned.
==> it would be great if the guide could be simplified by eliminating unnecessary (and confusing) synonyms, especially the devonfw vs. devon writing and the package vs distribution naming.