InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns
New content type - Scenario
還沒有人認領這個 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.
貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
研究方向
先查看 PR #765 和 #780 中連結的模式比較,然後檢查參考資料 pattern-categorization/innersource-program-mind-map.png。這項工作目前尚未限定在某個檔案或實作路徑;要完成這項工作,需要就情境內容類型、其有用範圍以及應發布的位置達成共識。
由索引模型根據 Issue 內容生成。
評估
- 領域
- content, documentation
- Issue 類型
- 功能
- 難度
- 5/5
- 預估耗時
- 一週以上
- 活躍度
- 停滯
- 描述清晰度
- 需要釐清
- 新手友好度
- 20/100