You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Changing order of sections according to pattern template
* [formatting] Change Patlet to 1 sentence per line
* Changing the Patlet to a more clear Problem/Solution split.
* More clearly call out the different types of communication channels.
* Add links to related patterns
* Extend section on channeling comms back to the main 3 channels
* Adding a link to passive documentation
* Adding 'Q&A systems' as a possible public communication channel
* Adding visual + credits + acknowledgement
* Split up Context into bullets
Copy file name to clipboardExpand all lines: patterns/2-structured/project-setup/communication-tooling.md
+30-24Lines changed: 30 additions & 24 deletions
Original file line number
Diff line number
Diff line change
@@ -4,16 +4,8 @@ Communication Tooling
4
4
5
5
## Patlet
6
6
7
-
An InnerSource project is being used outside the original development team but
8
-
users are having trouble getting help and getting in touch with the project
9
-
team. The idea is to set up and document standard communication tooling that
10
-
allows for discussions to become visible, archived and searchable.
11
-
12
-
## Context
13
-
14
-
A team depends on another team's component. It would like to make contributions
15
-
to that component. Even when it happens in writing, communication happens in a
16
-
1-on-1 fashion.
7
+
The users of an InnerSource project have trouble getting help and getting in touch with the host team.
8
+
By consistently using asynchronous communication tooling, the project makes discussions visible, archived and searchable, leading to an improved level of support for users.
17
9
18
10
## Problem
19
11
@@ -23,6 +15,12 @@ leading to incoherent information being shared, delays in answers received,
23
15
contributors pinging multiple host team members before receiving a definitive
24
16
answer.
25
17
18
+
## Context
19
+
20
+
- A team depends on another team's component.
21
+
- It would like to make contributions to that component.
22
+
- Even when it happens in writing, communication happens in a 1-on-1 fashion.
23
+
26
24
## Forces
27
25
28
26
- The host team is interested in receiving contributions and willing to mentor contributors.
@@ -31,30 +29,30 @@ answer.
31
29
32
30
## Solution
33
31
34
-
The host team needs to be clear on the benefit of providing company-public,
35
-
archived, searchable, linkable communication channels that are free to subscribe
36
-
to by anyone in the company.
32
+
The host team should provide company-public, archived, searchable, linkable communication channels that anyone in the company can subscribe to, as there are measurable benefits to supporting open, written communications channels.
37
33
38
34
The goal when streamlining communication channels for InnerSource projects
39
35
should be to align communication around topics, not around certain sets of
40
-
people:
36
+
people.
37
+
38
+
A project should set up the following communication tooling:
41
39
42
-
- The project should have its own issue tracker where structured communication, decision-making and progress tracking can happen transparently for all host team members but also for downstream users and contributors to follow.
43
-
- The project should have one or more discussion channels that come with less rigid a structure. Typically, this will be mailing lists, online forumsor even archived chat channels. Usually it is enough to start with just one channel for the project, if traffic increases too much it's helpful to split discussions about project usage from discussions about project development.
44
-
- In addition, the project should have one private channel where sensitive communication can happen between [Trusted Committers](../trusted-committer.md) - e.g. adding further Trusted Committers to the host team. This channel should be used with great care such that communication defaults to open and is kept private only under very rare circumstances.
40
+
1.**a dedicated issue tracker** where structured communication, decision-making and progress tracking can happen transparently for all host team members but also for downstream users and contributors to follow. For further applications of the issue tracker see [Issue Tracker Use Cases](./issue-tracker.md).
41
+
2.**public discussion channel(s)** that come with less rigid a structure. Typically, this will be mailing lists, online forums, Q&A systems or even archived chat channels. Usually it is enough to start with just one channel for the project. If traffic increases too much it is helpful to split discussions about project usage from discussions about project development.
42
+
3.**a private channel** where communication about sensitive topics can happen between [Trusted Committers](../trusted-committer.md) - e.g. adding further Trusted Committers to the host team. This channel should be used with great care such that communication defaults to open and is kept private only under very rare circumstances.
45
43
46
-
While communication can happen outside of written channels, as much information
47
-
as possible should be brought back to the asynchronous channels.
44
+
While communication can happen outside of those written channels, as much information as possible should be brought back to the asynchronous channels.
48
45
49
-
All communication channels should be documented in the project `README.md`. The
50
-
host team members need to make an effort to direct questions that they receive
51
-
personally back to official communication channels.
46
+
All communication channels should be documented in the project `README.md`. For more details on the use of this file see [Standard Base Documentation](./base-documentation.md).
47
+
48
+
The host team members need to make an effort to direct questions that they receive personally (e.g. via email or private chat messages) back to official communication channels.
49
+
50
+

52
51
53
52
## Resulting Context
54
53
55
54
Setting up and consistently using official asynchronous communication channels
56
-
helps create a base level of passive documentation that can be referenced again
57
-
when similar questions come up again.
55
+
helps create a base level of [passive documentation](https://www.oreilly.com/library/view/understanding-the-innersource/9781491986899/ch04.html) that can be referenced again when similar questions come up again.
58
56
59
57
With communication happening in the open others can easily follow project
60
58
progress and get active contributing. Others lurking and reading lowers the
@@ -84,7 +82,15 @@ to a lower need to repeat explanations.
84
82
85
83
Isabel Drost-Fromm
86
84
85
+
## Acknowledgement
86
+
87
+
Sebastian Spier (for the visual)
88
+
87
89
## Status
88
90
89
91
* Structured
90
92
* Drafted in December 2019.
93
+
94
+
## Credits
95
+
96
+
[People](https://storyset.com/people) illustrations by Storyset
0 commit comments