SeichiAssist icon indicating copy to clipboard operation
SeichiAssist copied to clipboard

ドキュメントを整備する

Open ghost opened this issue 1 year ago • 7 comments

SeichiAssist は OSS としてプレイヤーや外部の人間にも開発を促したいが、コード自体や、コード内に存在しているコメントアウトだけでは仕様を完全に網羅するのは難しいので仕様書を別途で用意することで少しでも開発への参加のハードルを下げたり、開発体験を向上させる

仕様書というよりかはドキュメントに近い

ghost avatar Apr 21 '23 14:04 ghost

「 https://github.com/GiganticMinecraft/SeichiAssist-Assist これは?」

これに追記していく形でもいいのでは?(てかこれがまさにそれ?)

ghost avatar Apr 21 '23 14:04 ghost

そのリポジトリを更新して言ってもいい気はしますが、そのリポジトリはどちらかというとScalaを詳しく解説しようとしてる気がするのでこのリポジトリのWikiを更新していったほうが楽な気がします

aqyuki avatar May 22 '23 09:05 aqyuki

SeichiAssist が難しいのもそうだけど同時に Scala という言語は関数型とオブジェクト指向のマルチパラダイムプログラミング言語というのもあり基本的に難易度が高いので、Scala の基本的な説明も加えたいお気持ち (For-Comprehensions なんか、りとさんに教えてもらうまで理解できなかった概念)

m1sk9 avatar May 22 '23 10:05 m1sk9

このリポジトリのWikiを更新していったほうが楽な気がします

私としては、WikiはPull RequestやIssueとの親和性が高くないので使いたくないです。

KisaragiEffective avatar May 22 '23 11:05 KisaragiEffective

Member (GiganticMinecraft) 以外の編集ができないのもある

m1sk9 avatar May 22 '23 11:05 m1sk9

そのリポジトリを更新して言ってもいい気はしますが、そのリポジトリはどちらかというとScalaを詳しく解説しようとしてる気がする

これに関してですが、もともとは Scala の基本的な部分と SeichiAssist の設計指針までを包括するドキュメントにするつもりでした(全然更新に時間割けていませんが…)。

バージョン管理や issue 管理などの観点から、僕も開発者向けドキュメントは当リポジトリ内か SeichiAssist-Assist に集約するのが良いと考えています。

kory33 avatar May 22 '23 18:05 kory33

こっちを更新していくのが丸いんですかね

aqyuki avatar May 22 '23 20:05 aqyuki