InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns
New content type - Scenario
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- HTML
- Star
- 853
- Fork
- 206
- Merge trung bình
- 1 ngày 23 giờ
- Pull request đã merge (30 ngày)
- 2
Mô tả
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.
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Bắt đầu bằng việc xem xét các so sánh pattern được liên kết từ các PR #765 và #780, sau đó kiểm tra tài liệu tham chiếu pattern-categorization/innersource-program-mind-map.png. Công việc hiện chưa được xác định phạm vi cho một tệp hoặc đường dẫn triển khai cụ thể; để hoàn thành sẽ cần thống nhất về loại nội dung của kịch bản, phạm vi hữu ích của nó và nơi nên công bố nội dung đó.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Lĩnh vực
- content, documentation
- Loại issue
- Tính năng
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Cần làm rõ
- Mức phù hợp với người mới
- 20/100