From 6467b41954cb8100d6acb70112ecdd7bb5000a17 Mon Sep 17 00:00:00 2001 From: Arun Kannawadi Date: Mon, 26 Apr 2021 21:40:30 -0500 Subject: [PATCH 1/4] Add a note on direct messages --- communications/slack-culture.rst | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/communications/slack-culture.rst b/communications/slack-culture.rst index 2600ed9f..d70b6e4d 100644 --- a/communications/slack-culture.rst +++ b/communications/slack-culture.rst @@ -83,6 +83,19 @@ You can save space, time, and distractions to others by using commonly understoo - ``:thank_you:`` (🙏) or ``:thankyou:`` +.. _slack-direct-messages: + +Direct messages +--------------- + +Please keep direct messaging to a user or a set of users to minimum. +Direct messages should be avoided for any technical discussions or asking for support, even if you are sure that you have involved all those who are interested or who can contribute. +Instead, such discussions should be in a thread in an appropriate :ref:`discussion channel`. +Direct messages shoul be reserved for conversations on topics such as code review requests, logistics, or on other topics not directly related to work. +See this `community post`_ for why direct messages are considered harmful. + +.. _community post: https://community.lsst.org/t/dms-in-slack-considered-harmful/4036 + .. _slack-snippets: Text snippets and posts @@ -192,7 +205,7 @@ If you need to have a group created because you have a routine need to @-mention @-mentioning a particular user notifies that user and adds the message to their "Mentions & reactions" list. Be aware of the person's timezone before @-mentioning them. If you need to @-mention them outside normal hours, you may want to schedule the message to be posted later (using the ``/send`` or more sophisticated ``/schedule`` shortcuts from `Timy`_). -Sometimes @-mentioning a user can be helpful to disambiguate replies in a multi-person conversation, but if you find yourself prefixing every message you send with an @-mention, consider whether it is implied by context or whether the whole conversation might be better in a thread or in direct messages to that user. +Sometimes @-mentioning a user can be helpful to disambiguate replies in a multi-person conversation, but if you find yourself prefixing every message you send with an @-mention, consider whether it is implied by context or whether the whole conversation might be better in a thread. .. _Timy: https://timy.website/#commands From f56a2b8a61da354f6777e6f73f5565bfdd77e566 Mon Sep 17 00:00:00 2001 From: Arun Kannawadi Date: Mon, 26 Apr 2021 21:41:39 -0500 Subject: [PATCH 2/4] Add a note on editing messages --- communications/slack-culture.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/communications/slack-culture.rst b/communications/slack-culture.rst index d70b6e4d..d24cb052 100644 --- a/communications/slack-culture.rst +++ b/communications/slack-culture.rst @@ -96,6 +96,18 @@ See this `community post`_ for why direct messages are considered harmful. .. _community post: https://community.lsst.org/t/dms-in-slack-considered-harmful/4036 +.. _slack-editing: + +Editing messages +---------------- + +Slack has a feature that allows a user to edit a message sent by that user. +This feature must be used for typographical or grammatical errors that the user wishes to correct, or if the message is accidentally sent before it is fully typed out. +While Slack is less formal than email, messages should be coherent and in multiple sentences if required, instead of multiple single-line messages in short bursts. This is so that it is easy to link to them elsewhere in the future. +In place of amending a message, it is preferable to use strikethrough to retract an idea or statement that If you post something you recognize as wrong. +A corrected statement can be added next to it. +A message should be deleted only if posted in a wrong channel, or if it is not appropriate in a social forum. + .. _slack-snippets: Text snippets and posts From f64a51baf6acc0aa259e9f0eaedc13943e6507f0 Mon Sep 17 00:00:00 2001 From: Arun Kannawadi Date: Tue, 27 Apr 2021 17:02:05 -0500 Subject: [PATCH 3/4] Response to KT's review --- communications/slack-culture.rst | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/communications/slack-culture.rst b/communications/slack-culture.rst index d24cb052..103812f6 100644 --- a/communications/slack-culture.rst +++ b/communications/slack-culture.rst @@ -88,25 +88,25 @@ You can save space, time, and distractions to others by using commonly understoo Direct messages --------------- -Please keep direct messaging to a user or a set of users to minimum. +Please keep direct messaging to a user or a set of users to a minimum. Direct messages should be avoided for any technical discussions or asking for support, even if you are sure that you have involved all those who are interested or who can contribute. -Instead, such discussions should be in a thread in an appropriate :ref:`discussion channel`. -Direct messages shoul be reserved for conversations on topics such as code review requests, logistics, or on other topics not directly related to work. +Instead, such discussions should be in a thread in an appropriate :ref:`discussion channel` and support questions must be asked in an appropriate :ref:`support channel`. +Direct messages should be reserved for conversations on topics such as code review requests, logistics, or on other topics not directly related to work. See this `community post`_ for why direct messages are considered harmful. .. _community post: https://community.lsst.org/t/dms-in-slack-considered-harmful/4036 .. _slack-editing: -Editing messages ----------------- +Editing and deleting messages +----------------------------- Slack has a feature that allows a user to edit a message sent by that user. -This feature must be used for typographical or grammatical errors that the user wishes to correct, or if the message is accidentally sent before it is fully typed out. -While Slack is less formal than email, messages should be coherent and in multiple sentences if required, instead of multiple single-line messages in short bursts. This is so that it is easy to link to them elsewhere in the future. -In place of amending a message, it is preferable to use strikethrough to retract an idea or statement that If you post something you recognize as wrong. -A corrected statement can be added next to it. -A message should be deleted only if posted in a wrong channel, or if it is not appropriate in a social forum. + +- This edit feature is ideal to correct typographical or grammatical errors, or if the message is accidentally sent before it is fully typed out. +- In order to easily link them elsewhere, messages should be coherent and in multiple sentences if required, instead of multiple single-line messages in short bursts. +- In place of amending a message, it is preferable to use strikethrough ``~text~`` to retract an idea or statement that if you post something you recognize as wrong. A corrected statement can be added next to it. This prevents surprises of seeing a notification and not finding that message on Slack. Moreover, this indicates the thought process undergone and avoids somebody else posting the same point again. +- A message should be deleted only if posted in a wrong channel, or if it is not appropriate in a social forum. .. _slack-snippets: @@ -217,7 +217,8 @@ If you need to have a group created because you have a routine need to @-mention @-mentioning a particular user notifies that user and adds the message to their "Mentions & reactions" list. Be aware of the person's timezone before @-mentioning them. If you need to @-mention them outside normal hours, you may want to schedule the message to be posted later (using the ``/send`` or more sophisticated ``/schedule`` shortcuts from `Timy`_). -Sometimes @-mentioning a user can be helpful to disambiguate replies in a multi-person conversation, but if you find yourself prefixing every message you send with an @-mention, consider whether it is implied by context or whether the whole conversation might be better in a thread. +Sometimes @-mentioning a user can be helpful to disambiguate replies in a multi-person conversation, but if you find yourself prefixing every message you send with an @-mention, consider whether it is implied by context or whether the whole conversation might be better in a thread or in direct messages to that user if the issue at hand is unique to the user. +An example where it is acceptable to move to direct messaging would be to help out unexpected login issues faced by the user. .. _Timy: https://timy.website/#commands From 85744735a97cf24853c5f25e95e0de59a89ac1b1 Mon Sep 17 00:00:00 2001 From: Arun Kannawadi Date: Tue, 27 Apr 2021 17:28:59 -0500 Subject: [PATCH 4/4] some more fixups --- communications/slack-culture.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/communications/slack-culture.rst b/communications/slack-culture.rst index 103812f6..e053862a 100644 --- a/communications/slack-culture.rst +++ b/communications/slack-culture.rst @@ -90,8 +90,8 @@ Direct messages Please keep direct messaging to a user or a set of users to a minimum. Direct messages should be avoided for any technical discussions or asking for support, even if you are sure that you have involved all those who are interested or who can contribute. -Instead, such discussions should be in a thread in an appropriate :ref:`discussion channel` and support questions must be asked in an appropriate :ref:`support channel`. -Direct messages should be reserved for conversations on topics such as code review requests, logistics, or on other topics not directly related to work. +Instead, such discussions should be in a thread in an appropriate :ref:`discussion channel` and support questions must be asked in appropriate :ref:`support channels`. +Direct messages should be reserved for conversations regarding code review requests, logistics, etc. or on topics not directly related to work. See this `community post`_ for why direct messages are considered harmful. .. _community post: https://community.lsst.org/t/dms-in-slack-considered-harmful/4036 @@ -105,7 +105,7 @@ Slack has a feature that allows a user to edit a message sent by that user. - This edit feature is ideal to correct typographical or grammatical errors, or if the message is accidentally sent before it is fully typed out. - In order to easily link them elsewhere, messages should be coherent and in multiple sentences if required, instead of multiple single-line messages in short bursts. -- In place of amending a message, it is preferable to use strikethrough ``~text~`` to retract an idea or statement that if you post something you recognize as wrong. A corrected statement can be added next to it. This prevents surprises of seeing a notification and not finding that message on Slack. Moreover, this indicates the thought process undergone and avoids somebody else posting the same point again. +- In place of amending a message, it is preferable to use strikethrough ``~text~`` to retract an idea or statement that you recognize is wrong after posting. A corrected statement may be added next to it. This prevents surprises of seeing a notification and not finding that message on Slack. Moreover, this indicates the thought process undergone and avoids somebody else posting the same point again. - A message should be deleted only if posted in a wrong channel, or if it is not appropriate in a social forum. .. _slack-snippets: