InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns

New content type - Scenario

Abierto
#811 4 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
HTML
Estrellas
853
Forks
206
Merge medio
1 d 23 h
PR fusionados (30 d)
2

Descripción

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.

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza revisando las comparaciones de patrones enlazadas desde los PRs #765 y #780 y, después, inspecciona la referencia pattern-categorization/innersource-program-mind-map.png. El trabajo aún no está delimitado a un archivo ni a una ruta de implementación; para darlo por terminado sería necesario llegar a un acuerdo sobre el tipo de contenido del escenario, su alcance útil y dónde debería publicarse.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Área
content, documentation
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
20/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.