InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns

New content type - Scenario

未关闭
#811 4 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
HTML
星标
853
派生
206
平均合并
1 天 23 小时
30 天内合并 PR
2

描述

In two recent conversations in PRs, we were unsure which content should go into which of our existing patterns. We ended up creating comparisons between the related patterns, partly supported by AI. These proved to be super helpful to figure out what the core focus of each of the existing patterns is, and how new patterns can add new insights to "fill the gaps" between the existing patterns.

Besides being useful for pattern maintainers in the context of a PR, I wonder if such overviews/comparisons could also be useful for regular readers of our patterns, to figure out how the patterns are related to each other.

Such a write-up does not feel like a pattern but rather like a new content type of our InnerSource patterns book. If I had to give such write-ups a name I might call it "scenario", "use case", or even just "article".

Example Scenarios

We could publish a scenario called "Enable project reuse". In that scenario we would incorporate this comparison table, and point to patterns immediately related to the scenario.

Recent conversations with pattern comparisons

  • comparison of patterns related to the Governance Levels pattern - see comment / #765
  • comparison of patterns related to the Discover your InnerSource - see comment / #780

Related

Two other things that this idea reminds me of:

  • @rrrutledge had pitched the idea of an InnerSource handbook some time ago. The handbook also wanted to use a format that was less strict than our pattern format, while still reusing or referencing a lot of the content that our patterns provide.
  • Our mindmap is already grouping the patterns into smaller groups. For each of these groups one might publish a scenario article. e.g. the "Discovery Challenges" group already contains some of the patterns that might be used in the "Enable project reuse" example above.

Out of scope (for now)

The new content type that we are exploring here could be integrated into one or multiple of our existing ISC assets. e.g. this could fit into the InnerSource Patterns book but also in the Learning Path, or even the Managing InnerSource Projects book.

I think that it would be best to first discuss which content would be helpful for the readers, and how hard it would be to generate such content (we have very few contributors, so I don't want to create an idea that cannot be implemented anyways because it requires too much effort).

Once that is clear, we could discuss again where that content should be published. It could even be integrated into multiple ISC assets.

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

先查看 PR #765 和 #780 中链接的模式比较,然后检查参考资料 pattern-categorization/innersource-program-mind-map.png。该工作尚未限定到某个文件或实现路径;要完成这项工作,需要就场景内容类型、其有用范围以及应发布的位置达成一致。

由索引模型根据 Issue 内容生成。

评估

领域
content, documentation
Issue 类型
功能
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
需要澄清
新手友好度
20/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。