Skip to content
This repository has been archived by the owner on Sep 24, 2022. It is now read-only.

"Discussions" as a template type is an overloaded name. #39

Closed
jaredmorgs opened this issue Nov 29, 2019 · 7 comments
Closed

"Discussions" as a template type is an overloaded name. #39

jaredmorgs opened this issue Nov 29, 2019 · 7 comments
Labels
decision For issues that require TGD committee consensus on prior to implementing question Further information is requested template-about-guidance For issues relating to the "about" help files in each template repository. template-discussion For all issue relating to the Discussion Templates wtdau2019 Any issues created from the Google Doc feedback collected at WTD AU 2019

Comments

@jaredmorgs
Copy link
Contributor

Gloria Ma 12:41 14 Nov
SELECTED TEXT:

Discussions

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?

@jaredmorgs jaredmorgs added question Further information is requested template-about-guidance For issues relating to the "about" help files in each template repository. wtdau2019 Any issues created from the Google Doc feedback collected at WTD AU 2019 template-discussion For all issue relating to the Discussion Templates decision For issues that require TGD committee consensus on prior to implementing labels Nov 29, 2019
@bwklein
Copy link
Member

bwklein commented Sep 30, 2020

It does seem like the intention is to provide a starting point or anchor for a point of discussion or dialog.
https://github.com/thegooddocsproject/templates/blob/master/discussion/about-discussion.md#structuring-discussion-articles

@waldyrious
Copy link
Contributor

For the record, the popular four-part documentation system by Divio originally contained four types:

Tutorials, How-to guides, Discussions and Reference

but they later changed to

Tutorials, How-to guides, Explanation and Reference

...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.

@flicstar
Copy link
Contributor

flicstar commented Oct 1, 2020

Thinking about this, I am happy with the term "explanation".
In my past experience, we would internally call this a concept topic but then in the docs we'd title it "About blah". I also like "overview" but I think "explanation" is plainer English.

@bwklein
Copy link
Member

bwklein commented Oct 1, 2020

If the intent of that section is to provide background information and to explain something (background info, etc.) then I agree with Explanation as a choice. It seems to be the point of that article type from the first sentence.

"Discussions, or explanations, explain background information and provide context-specific knowledge on a particular topic."

@adohertyTS
Copy link

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.

@acpkendo
Copy link
Contributor

acpkendo commented Oct 7, 2020

+1 that "Explanations" is a better term for this concept than "Discussions."

aidanatwork added a commit that referenced this issue Oct 7, 2020
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.
@aidanatwork
Copy link
Contributor

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.

camerons pushed a commit to camerons/templates that referenced this issue Feb 27, 2021
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.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
decision For issues that require TGD committee consensus on prior to implementing question Further information is requested template-about-guidance For issues relating to the "about" help files in each template repository. template-discussion For all issue relating to the Discussion Templates wtdau2019 Any issues created from the Google Doc feedback collected at WTD AU 2019
Projects
None yet
Development

No branches or pull requests

7 participants