InnerSourcePatterns icon indicating copy to clipboard operation
InnerSourcePatterns copied to clipboard

RFC Pattern improvements

Open spier opened this issue 4 years ago • 3 comments

Further improvement ideas for the pattern: https://patterns.innersourcecommons.org/p/transparent-cross-team-decision-making-using-rfcs

Previous PR with some further info about these topics: https://github.com/InnerSourceCommons/InnerSourcePatterns/pull/245

Topics:

  • Title / URL - a shorter title
    • Why? A shorter title would make it easier to reference the pattern (e.g. from other patterns), and shorter titles also look better in the table of contents in the book :) It would also lead to a shorter URL (the URL is actually depends on the filename, rather than on the Title of the pattern)
    • Ideas: Current title is "Transparent Cross-Team Decision Making using RFCs". Some ideas for shorter titles "Decision Making using RFCs", "Internal RFCs"
    • Last Feedback from Pattern author: Looks like this was discussed in the Patterns group and you're happy with it as is?
  • Sketch - Any type of visual that can be added to the pattern
    • Why? Any visual makes the pattern look prettier in the book. Of course it is nice if the visual also helps to understand the pattern.
    • Ideas: Could even be a screenshot of the RFC template? Or a screenshot of one of the RFCs from RUST or elsewhere?
    • Last Feedback from Pattern author: I was thinking about an image of the template, but I think text is better as it can be copy + pasted. Perhaps a process flow diagram would be good?

spier avatar Jan 12 '21 20:01 spier

@tsadler1988 I allowed myself to aggregate the previous discussions about Title and Sketch into this new issue.

Wrt Title:

  • once we publish the patterns in the book, it should be our goal to keep the URLs as stable as possible, so that we can reference the patterns in other places, without running the risk that the URLs break. So if want to still change the URL, we should do this relatively quickly
  • I agree with @lenucksi's comment that the title "Transparent Cross-Team Decision Making using RFCs" is very descriptive. Unfortunately it is also fairly long. :) One trade-off could be this: How about we keep the title as is, but shorten the filename which will automatically shorten the URL? Any idea for a shorter filename?

Wrt Sketch:

  • this is much less time critical than the Title/URL topic
  • as we can change images/sketches in the pattern at any point, I would opt for just taking a screenshot of the your RFC.
  • But if you have time to flow diagram, by all means, go for it :)

spier avatar Jan 12 '21 20:01 spier

I am just adding a sketch image to this pattern via https://github.com/InnerSourceCommons/InnerSourcePatterns/pull/407

spier avatar Apr 25 '22 13:04 spier

@tsadler1988 it doesn't look like we will continue working on the RFC pattern at the moment. Shall we close this issue here?

spier avatar Feb 27 '24 22:02 spier