最初のコントリビューション

[yabuki]

Chibi-CHiLO に関する文書を整備する。最終的には、GitHub Pagesに公開する予定である。

本プロジェクトで必要なドキュメントを追加する。

白井さんのタスクとして、下記を想定している。できそうなものを選んでください。ほかにかけそうなものを提案して頂いてもよいです。

• 画面設計に関するラフスケッチ
• Program を読むためのガイド
• 本プロジェクトに参加する上で、知っておくべきオリエンテーション的な文書(Web 系界隈では、onboarding documentsといわれるやつです)

上記のドキュメントをつくってもらって、pull-req を受けたいとおもいます。レビュアは、少なくともわたしを含めたCCC TIESの方2名以上を指定してくださいませ。

ひとまずは、本リポジトリを clone していただき、用語定義 #247 などの、glossary など目を通してから、文書を作っていただけたらと思います。

GitHub Pages は、将来的に、Build optimized websites quickly, focus on your content | Docusaurus を使う予定ですが、すぐに対応できないと思うので、

repository topに、Documentation というディレクトリに Onboarding.md ReadingCodeGuide.md DesignProposal.md などのファイルに、GitHub Flavor Markdown(GFM) 記法で書いてください。

Pull-reqをうけて、レビューが通って、masterに反映された段階で、本issueはクローズします。タスクの残りがある場合は別途issueを作ります。

最初のコントリビューションを促す、ISSUEですから。

[yabuki]

基本的には、論文と書くのと同じように、問題規定文というか、アブストラクトと、目次を出して中身の相談をしてもらってから、具体的な内容を書いていただけたらと思います。

[szshirai]

@yabuki さん
私の方で準備する文書ですが、実際に本システムを利用されるエンドユーザ向けの資料と認識しておりました。仕様通りの動作になっているか、安定して動いているか等、確認をしながらドキュメントを整備するつもりでおりました。
先生方が実際に利用することを考えますと、PDFなど簡単に配布したり、印刷できる形態のものも用意しておいた方が良いように思いますが、そのあたりも相談させていただきたいです。

[yabuki]

@szshirai さん

なるほど。それはどちらかというと、テスト仕様書みたいなイメージかな。と思いました。

pdfに書き出すことができれば印刷は可能です。

ChibiCHiLOは暫時改良していきますから、そのたびにテスト仕様書は更新が大変かとおもいますので、そのあたりも相談させてくださいませ。

[szshirai]

@yabuki さん

いえ、テスト仕様書ではなく、4月以降、先生方に使っていただくことになるので、
本システムを使う先生向け（管理者・教員・TA）のドキュメントを整備するつもりでおりました。
4月からの授業での利用を考えますと、直近でわかりやすいマニュアルが必要となるので、これを整備できればと考えておりました。

[horimasumi]

@szshirai さん，

直近でわかりやすいマニュアルが必要となるので、これを整備できればと考えておりました。

おおお〜，是非そこを！　今，isuueの #2 がたっていて，私がとりあえず，たたき台のマニュアルらしきものを投げています．
これじゃあ，全然だめで，ちゃんとツールをつかって，Webマニュアル化していなければいけないと考えていました．
ちゃんとしたツールを使うと，WebマニュアルをそのままきれいなPDFにも書き出せるようです．
まず，そこから始めましょうか． @yabuki さん，まずは，環境の検討をお願いできますか？

[yabuki]

@szshirai さん @horimasumi さん

GitHub Pages (HTML) と、PDFへの出力 について、直近だと、現状 sphinx で書いている設計文書を移設する作業を予定していたので、来週あたりのすぐなら、そちらで作業してもらうことになります。Sphinx-Users.jp — Python製ドキュメンテーションビルダー、Sphinxの日本ユーザ会 バックエンドがlatexを使ってpdfをだしています。 SphinxでPDFファイル作成 — Python製ドキュメンテーションビルダー、Sphinxの日本ユーザ会

---

以下は、プログラマ向けの情報です。

swagger が出力する情報で、API reference をつくるのに、sphinxcontrib-openapi · PyPI または、sphinxcontrib-redoc — sphinxcontrib-redoc 1.5.1 documentation のへんで楽をしたいと考えています。

[kou029w]

API reference

デプロイ後 {API_BASE_PATH}/swagger/static/index.html を参照してください。
例: https://f-omega.vercel.app/api/v2/swagger/static/index.html
(OpenAPI v3に移行するのであればswaggerというパスは適切でないかもですが…)

[szshirai]

@yabuki さん @horimasumi さん

GitHub Pages (HTML) と、PDFへの出力 について、直近だと、現状 sphinx で書いている設計文書を移設する作業を予定していたので、来週あたりのすぐなら、そちらで作業してもらうことになります。Sphinx-Users.jp — Python製ドキュメンテーションビルダー、Sphinxの日本ユーザ会 バックエンドがlatexを使ってpdfをだしています。

ありがとうございます。承知しました。来週からすぐに作業を開始できればと思いますので、sphinx上でさせていただければと存じます。

おおお〜，是非そこを！　今，isuueの #2 がたっていて，私がとりあえず，たたき台のマニュアルらしきものを投げています．これじゃあ，全然だめで，ちゃんとツールをつかって，Webマニュアル化していなければいけないと考えていました．

@horimasumi さん、ありがとうございます。ぜひこちら叩き台にWebマニュアル化するとともに、情報を追加させていただきます。

[yabuki]

OnBoarding から、本issue をリンクしたので close とする。