-
Notifications
You must be signed in to change notification settings - Fork 171
"Discussions" as a template type is an overloaded name. #39
Comments
It does seem like the intention is to provide a starting point or anchor for a point of discussion or dialog. |
For the record, the popular four-part documentation system by Divio originally contained four types:
but they later changed to
...presumably due to the same ambiguity. I too feel alternative terms ("overview", "context", "background", "explanation", or even the classic "manual") would be clearer than "discussion", even if the latter can be somehow justified. |
Thinking about this, I am happy with the term "explanation". |
If the intent of that section is to provide background information and to explain something (background info, etc.) then I agree with
|
Per the consensus of this thread (which I agree with), I think we should change all the naming within Templates that currently refers to the doc type "Discussions", to instead refer to "Explanations". +1 on this. |
+1 that "Explanations" is a better term for this concept than "Discussions." |
Changed references to "discussion" doc type to "explanation" doc type, primarily in the explanation directory (formerly the discussion directory). Also some minor incidental wordsmithing along the way. Search for references to "discussion" or "discussions" in the templates directory. There are now very few, and the ones that remain are still appropriate despite the renaming of this doc type.
OK, I made some changes to resolve this issue. If folks have further suggestions to improve the language, let's tackle them in a new issue. Closing this out. |
Changed references to "discussion" doc type to "explanation" doc type, primarily in the explanation directory (formerly the discussion directory). Also some minor incidental wordsmithing along the way. Search for references to "discussion" or "discussions" in the templates directory. There are now very few, and the ones that remain are still appropriate despite the renaming of this doc type.
Gloria Ma 12:41 14 Nov
SELECTED TEXT:
I somehow find this word to be confusing here - I think of a discussion like a "forum", as if this template is intended to facilitate a discussion. Whereas based on this description, I think it's really a "background" or "context" article - could those be more intuitive words?
The text was updated successfully, but these errors were encountered: