Improving the "Common Requirements" pattern

オープン
#389 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
35/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
markdown
領域
documentation

調査の方向性

まず patterns/2-structured/common-requirements.md と、issue でリンクされている contributor handbook のセクションを読み、その後 assets/img/CommonReqtsv2.jpg を確認します。作業を、記載されている pattern、visual、validation の改善に分けます。完了とは、選択した変更が文書化され、pattern に必要な証拠が含まれている状態を指します。Validated ステータスを目指す場合は、追加の Known Instances を 2 つ含めます。

索引モデルが issue の本文から書いたものです。

説明

:book: Type - Content Work 2-structured

Some ideas for improving the Common Requirements pattern:

  • Improve the Patlet - escpecially describe how the Solution is improving upon the Problem
  • Break up Forces into bullets - so that readers can check more easily if these forces apply in their orgs as well
  • Decide what to do with the Resulting Context: It currently focuses mostly on other related challenges that may need to be solved after this pattern is in place. However it lacks explanation of how this pattern has helped to address the problem i.e. how can people confirm "did it work"?
  • improving the visual e.g. by creating a new version digitally (so no scan), and explaining in the pattern what that visual illustrates

To even level the pattern up to Validated, we would have to find 2 more Known Instances of orgs using this pattern. As this might be hard to do, it could be achieved in multiple steps (and PRs) over time.

主要言語
HTML
スター
853
フォーク
206
平均マージ
1日 23時間
マージ済み PR（30日）
2

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

InnerSourceCommons/InnerSourcePatterns のほかの issue

InnerSourceCommons/InnerSourcePatterns の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。