【ドキュメント】1/8までに充足させたい内容について

[admidori]

ドキュメントについて

ドキュメントをひとまず担当することになりましたみどり(Discord: mid0ri3 / GitHub: @admidori)です。よろしくお願いします。 プロジェクトが抱える今現在の問題点として、「開発の障壁が高く、Xを確認して興味を持ってくれた人が参入しにくい」ことが挙げられます。 そこで、Discordのログを確認しなくてもすぐに開発に取り掛かれるようにドキュメントを充足させる必要があり、ドキュメント作成班としては、「1/7,8までに以下ToDoの「優先度　高」の項目を充足させる」ことを目標において開発していくのがbestなのでは無いかと思っています。

ドキュメントに関するToDo

• 優先度　高
• [x] READMEの作成およびプロジェクトのゴール・ビジョンの策定 #3
• [x] CONTRIBUTING.mdの作成および開発フローの詳細化 #1, #10
• [ ] 開発プロジェクト共通用語集の作成 #4
• [x] Code of ConductやIssue templateなどのGitHub standardで指定されているドキュメントの作成
• 優先度　中
• [ ] 要件定義資料の作成 #3
• 優先度　低
• [ ] 広報用資料の作成

何か不足や意見などがあれば教えてください。 （また、皆さんが欲しいドキュメントなどもあれば教えてください。優先度が低いものでも問題ありません。）

これから各々の項目に対してissueやbranchを切っていきたいと思っているので、ドキュメント作成にご協力いただける方は是非よろしくお願いします。

[admidori]

とりあえずREADMEとCONTRIBUTINGを以下のPRで提案しています。　#9 あくまでたたき台なので、ここからどんどん改善が始まっていければと思います。

[nakaji-kazu]

Projectの意義などを説明したスライド https://docs.google.com/presentation/d/1zW0qn1mT5Zzt44JQwHZdQsBOGr-t4H9h/edit?usp=sharing&ouid=116834426594069063024&rtpof=true&sd=true

Suguruさんのレビューしてもらって記載しているため、 ・PJのゴール ・スコープ ・やらないこと ・各フェーズのゴール(仮)

まではこれでPJ全体の認識合わせ出来ると思います。