Slack Culture¶
Slack is Rubin Observatory’s real-time chat platform.
It is used by project staff and science collaboration members, who can view and join all public channels.
Partnering users and projects may also be allowed to join specific channels as guests.
(Ask a Slack admin or ask in #help-slack if you need a guest added to a channel or want to share a channel with another project/organization.)
Teams may evolve different cultures around the use of Slack. In addition, different types of channels may work in different ways. This page documents the common, accepted Data Management culture, with specific adjustments for four types of channels: announcement, support, discussion, and informal. But note that when it comes to communication, there are always exceptions, and culture can also change with time, deliberately or organically.
Summary¶
Use common emoji as reactions in place of messages. (Details)
Use text snippets or canvases instead of long code or text blocks. (Details)
Use threads for side conversations; suggest replies go to a thread with
→,-->, or:thread:(🧵). (Details)Use
@channel,@here, and @-mentions of people sparingly, and be aware of timezones when mentioning people. (Details)In announcement channels, any non-announcements should be in threads. (Details)
In announcement channels, use @-mentions even more rarely. (Details)
Follow documented procedures for providing community support to non-staff members. (Details)
In support channels, use threads to analyze and follow up on questions and problems. Consider moving detailed conversations to a team channel. (Details)
In support channels, use
@hereto announce urgent items and forestall questions for widespread issues. Use @-mentions to report solutions to the person who had a problem. (Details)Decisions in discussion channels must be formally recorded elsewhere. (Details)
In discussion channels, be aware of the limitations of Slack’s threads. (Details)
Follow Data Management’s Focus Friday rules. (Details)
Be professional and courteous in informal channels. (Details)
Always consult a channel’s description for channel-specific rules of engagement.
Naming Channels: Conventions for Different Channel Types¶
Channels are created for all sorts of purposes. For some types of channels, certain conventions apply.
When a channel belongs to one of the types listed below, following the naming guidelines to indicate this is highly recommended (and may be required in your particular team).
In general, avoid redundancy (including unnecessary organisational taxonomy) in naming channels, focusing more on a channel’s purpose.
For a (contrived) example, rubin-dm-science-pipelines-help can just be science-pipelines-help.
Announcement Channels¶
Announcement channels are ones in which notices are posted and little or no response is solicited.
To indicate this, append -announce to the channel’s name.
For more, see the (Announcement Channels) section.
Bot Channels¶
There are a number of bots (some third party, some home-built) on our workspace.
Sometimes a channel exists predominantly as an outlet or interaction platform for those bots.
If you want to indicate that a channel predominantly receives bot traffic (for example an echo of our community forum), append -bot to the channel name.
Informal Channels¶
While informal channels are not about work topics, you should still behave professionally and courteously within them, including exhibiting a welcoming attitude towards newcomers.
There are no naming conventions for informal channels - have fun.
Meeting Channels¶
Sometimes channels are created for the explicit purpose of bringing together attendees at a meeting.
No naming convention applies, but please archive those channels once a meeting is over to improve channel search experience.
Status Channels¶
Status channels are a special kind of bot channel used by devops teams to receive alerts from monitoring systems.
They are typically named after the cluster whose alerts they receive (eg status-data-lsst-cloud for alerts relevant to data.lsst.cloud).
Although sometimes operational staff will comment on alerts in those channels to annotate events, these channels should be considered read-only for all practical purposes.
Prepend status- to the channel’s name for channels of this nature.
Summit Channels¶
Channels oriented towards summit activities, including daywork and night observing, have their own set of protocols as they carry communication of a critical nature, involve personnel that are often off-line/off-shift and cannot be assumed to have read all traffic, and are used by staff that are aggressively multitasking and monitoring multiple communication channels.
If you are involved in summit work, make sure you clearly understand the rules of engagements of those channels, when and how to post, and (if relevant to your duties) how to respond to support requests.
Summit slack communication protocols are described in the Observatory Operations guide.
Note that not all summit-type channels are prepended by summit- although some are.
Support Channels¶
Support channels are intended as primary support venues for obtaining technical assistance that you require in order to do your work. Support channels may have different arrangements for how and when problems are reported to them and what to expect from a response. Consult the (Support Channels) section for more guidance.
Append -support to the channel name, and name the channel carefully to minimize misdirected questions (if you’re always telling people they are asking in the wrong channel, that’s a clue).
Note: there is an emerging practice to reserve the -support suffix for channels where there is some kind of formal undertaking to provide, well, support.
For more informal, unofficial and peer-to-peer Q&A channels, consider using -help instead.
Team Channels¶
If your team has a “find us here” channel, append -team to the channel name.
Again, avoid unnecessary taxonomy: it turns out square-team is a more useful name to people that dm-square.
None of the above¶
Everything else is just considered a discussion channel. As long as you don’t stop on the “reserved” words for the special channel types (announce, bot, status, summit, support and team), give them names that work for their audience.
General Practices for Slack¶
Emoji responses¶
You can save space, time, and distractions to others by using commonly understood emoji instead of messages when semantically equivalent to your response.
:heavy_plus_sign:(➕) = me too:white_check_mark:(✅) or:heavy_check_mark:(✔︎) = this is correct:+1:or:thumbsup:(👍) = OK:thank_you:(🙏) or:thankyou:
Code and quoting¶
Slack has several ways to include blocks of text or code in a message.
Inline code can be written using the backtick
`character before and after or using the “code” button in the formatting bar. This should typically be used for short (one or a few words) code elements embedded within normal text statements.Code blocks can be written using the triple-backtick
```before and after or using the “code block” button in the formatting bar. This should typically be used for short (one to 10 lines) code blocks.Block quotes can be written using a
>before each line or using the “blockquote” button in the formatting bar. This should typically be used for short (one to 10 lines) text quotations from other messages or documents.
Slack formatting bar.¶
Entire messages can be shared from one place to another using the “Forward message” item in the “More actions” menu that appears when you hover over or select a message.
Note that the formatting bar is obtained by selecting the “Aa” button in the message input area in mobile apps.
Text snippets and posts¶
There are two less-known but very powerful features for code and text blocks, including items like error messages. Within the “plus sign/+” attachment menu to the left of the message input area on desktop Slack, there are entries for “Create a text snippet” and “Create a canvas”. In mobile apps, you can only create a canvas, not a text snippet. To do that, from the Home tab, tap the search bar at the top of your screen. Then tap “Canvases” in the bar that appears below (between “Recents” and “Files”), and then tap “Create a canvas”.
Attachment “plus sign” icon within the message input area.¶
A text snippet is a file, but it appears as a message attachment. It can have a title (like a filename with extension). Content will be monospaced, like code blocks, but lines are numbered, and syntax highlighting for a wide variety of languages can be applied, either automatically based on the filename’s extension or manually chosen. Whether the code should wrap when displayed or scroll horizontally can also be chosen. Finally, and perhaps most importantly, long snippets are automatically displayed in “collapsed” form. Readers can expand the snippet inline, view it in detail in a sidebar, or download it. Instead of a large code block in a message that has to be scrolled around vertically, an expanded snippet can be collapsed again, taking up only a small amount of visible message space. Like messages themselves, text snippets can be edited even after being sent.
A canvas is also a file that appears as a (somewhat larger) message attachment. Its title is more of a heading than a filename. It can include normal text, which can be formatted in the same ways as messages, including triple-backtick code blocks. Two levels of header formatting are also available. There is one special thing about canvases: they can be made editable by other users (snippets are only editable by the original author). When a canvas gets longer than about 48 lines, it will automatically display in “collapsed” form.
Please use text snippets or canvases for long segments of code, text, or error messages (e.g. more than 10 lines or so).
Threading¶
Threads allow conversations to take place among a subset of the members of a channel.
They can branch off from any message at any time, and messages in a thread can also be shared with the main channel.
At times you may want to post several messages in sequence that don’t all belong in the main channel, or you may anticipate follow-up conversation that only involves a few of the channel members.
In these cases, you can signal that replies (yours or others) to a message should be in a thread with either a rightward arrow (→ or -->) or the :thread: (🧵) emoji.
There are more specifics on thread usage in certain types of channels below.
@-mentions¶
@channel sends a notification to every member of a channel, even if they are in a meeting, away, or on vacation (unless they pause notifications).
The uncontroversial use of @channel is “This group of people has opted into this channel for a fairly narrow purpose, and they all really need a notification interrupt related to that purpose”.
For example, it is appropriate to use @channel on a meeting-specific channel for a DM All-Hands meeting to say “Conference Photo has been moved to 4pm to try and beat the rain” because:
It is time-sensitive, and the consequences of missing the message are severe.
It is something everybody on the channel is reasonably expected to care about.
It is reasonable to assume this is the kind of content people joined the channel for.
At the other end, for a large channel whose membership is organizational rather than voluntary, such as “all members of DM”, it is rarely appropriate to use @channel.
Consider whether the information is time-critical or a normal message could be used instead.
Consider whether the information is relevant to all (or the vast majority of) channel members or could be redirected to a narrower channel.
In particular, we have a specific opt-in #talk-starting-soon channel for timely reminders of talks or seminars that may be of wide interest but that do not deserve to interrupt everyone in a large channel.
Consider whether everyone who might be interested already keeps up on the channel as part of their daily/hourly routine, so no notification is required at all.
@here is slightly narrower than @channel as it only notifies active channel members, not those who are away.
The same general considerations apply, however.
Slack has a concept of user groups that can be notified instead of an entire channel that has members outside that group.
If you can use such a group rather than @channel or @here, that is preferred.
If you need to have a group created because you have a routine need to @-mention them, contact a Slack admin (e.g. via #help-slack)
@-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 or the “Schedule for later” drop-down next to the send button in the message input area).
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.
There are more specifics on @-mention usage in certain types of channels below.
Announcement Channels¶
These channels include #general (for general discussions and postings to most of the people on Slack) and #announce-everyone (for essential announcements to everyone on Slack).
Threading¶
To reserve the main channel for announcements, almost any question or reply should be in a thread. If there is a clarification developed in a thread, that message can be shared back to the main channel using the “Also send to #channel” checkbox. (If you want to take back a sharing with the main channel, you can do that by selecting the message in the main channel and then choosing “Remove from channel” in the “More actions” menu.)
@-mentions¶
Since these channels typically have wide membership, pay special attention to timeliness and relevance before using @channel or @here in them.
Support Channels¶
Often the relevant manager will review all messages in a support channel to ensure that no incidents or questions have been left unhandled.
Non-Staff Support¶
The Providing Support to the Community page discusses how we are handling this type of support. It refers to the Interim Model for Community Support document.
Threading¶
Support channels have special characteristics:
Hard-to-follow information and distractions can impede developers trying to help users in an effective and timely manner.
High-volume and especially interleaved main-channel traffic on concurrent issues makes it hard for the ad-hoc incident response coordinator to assess status.
These channels are often monitored outside normal hours (sometimes as part of the job, sometimes on a best-effort volunteer basis). Ongoing conversations on issues that are no longer urgent can have a disruptive effect.
As a result, these channels frequently use threads to separate conversations, even having one per incident.
Of course it is totally reasonable for conversation to start in the main channel, typically during the “is it broken or is it me” phase. In this stage of a problem it is useful to have many eyes so people can go “me too” or offer peer-to-peer support for common problems, like “is your VPN on?”.
At some point, it becomes obvious that there is an actual problem and one or more developers and/or an incident coordinator need to work it. This is an excellent time to move the conversation to a thread for a number of reasons:
It clears the main channel for other problems or important updates
It creates a huddle among people actively involved in the problem (devs and users) and so it reduces the “peanut gallery” effect.
It keeps log dumps, sceenshots and other artifacts with a poor column-inches-to-general-interest ratio off the main channel.
It reduces the impact of developers who favour “stream of consciousness” troubleshooting on everyone else.
It vastly reduces potential misinformation during the troubleshooting phase (“ALL THE DATA IS GONE” followed by “never mind, I was logged onto the test server”).
In fact there can be a second level of “threading” where, once it because apparent what the issue is, developers can retreat to their team channel (which may still be public but with a narrower membership) to further discuss the issue and to avoid pummeling the user with speculation and technical details rather than specific questions and a solution.
Bottom line: please try and thread screendumps etc.; always follow the lead of the incident coordinator if they ask you to thread; and keep the main channel clear for important information and new problem threads.
Some channels are specifically for observing operations support. While these channels are public, if you have not been assigned or requested to participate, you should remain a quiet “lurker”.
@-mentions¶
Support channels are also special with regard to @-mentions.
As they generally include all users of a particular service, time-sensitive announcements to all of those users can deserve an @channel.
In particular, when a widely used service is down, the team is often pummeled with notifications on every medium from users reporting a problem.
In such a situation an aggressive notification serves a wider purpose: stemming the flow.
The inconvenience to the people who are notified and didn’t know or care is offset by the benefit to the responding team of reduced noise.
But @here may be sufficient since people who are away are not likely to be affected by the service outage.
The incident response coordinator (often the team leader) should judge the situation.
If a problem affects only one person, however, an @-mention of that person is sufficient to report a solution.
Discussion Channels¶
Decisions¶
In Data Management, discussions in Slack do not produce an authoritative record of decisions. All decisions emerging from such discussions need to be formalized elsewhere, often an RFC, a technical note, or, at minimum, a Confluence page or Jira issue.
Threading¶
Outside support channels, some of the disadvantages of Slack’s threading model are more prominent. For example, you can’t easily thread off a thread to generate a tertiary conversation. “Taking it to another channel” instead can lose linkage to the original discussion; reporting conversation results back to the originating channel or at least pasting message links becomes more important. If you’re reading a thread but not actively contributing to it, you need to explicitly “Follow thread” to get notifications. This can be especially difficult if someone starts a thread off an older message as there’s no easy way of knowing that it even exists.
Focus Friday¶
Data Management observes Focus Friday. See that page for information on use of Slack versus asynchronous communications mechanisms on Fridays. Do not use any @-mentions in a discussion channel on Focus Friday.