aozorahack / kosakuin

オープンソースの文書入力・校正システムです。

aozorahack

aozorahack全般に関するissue/wiki用リポジトリです（いわゆるメタリポジトリ）。

「Code for 青空文庫」アイデアソン #1 (https://atnd.org/events/66230 ) の開催をきっかけとしてaozorahackというgithub organizationを作成しました。青空文庫とその周辺に関する技術的な情報や、コード・ドキュメント置き場として活用できればと思っています。

このリポジトリ、aozorahack/aozorahackは、aozorahackに関する情報や意見質問の集約用のリポジトリです。お気軽にご利用ください（ただ、意見や質問をいただいても返答がないこともあります。ご了承ください）。

Issues

• 一覧: https://github.com/aozorahack/aozorahack/issues
• 新規: https://github.com/aozorahack/aozorahack/issues/new

slack

https://aozorahack.slack.com/ を作成しました。メインのやりとりはgithubで実施しますが、ブレストや雑談はslackでもできればと思っています。参加希望者は https://aozoraslackin.herokuapp.com/ からJoinしてください。

Projects

新しくプロジェクトを作りたい人は、新規プロジェクト（リポジトリ）を作るにはをご覧ください。

現在活動中のプロジェクトは以下になります。

工作院 (kosakuin)

アイデアソンで提案された「オープンソースの文書入力・校正システムを作る件について」のプロジェクトです。

• aozoraflow - 作品をgitで管理する際の運用規約とサポートツール
• aozora-parser.js - 青空文庫テキストのパーサ
• hinagata - 作品パッケージの雛形
• aozora.json - 作品メタデータのフォーマット

青空文庫の仕様書 (specs)

青空文庫の技術的な「仕様」をまとめて文書化するためのレポジトリ。今後作るものの仕様ではなく、既存の青空文庫がどうなっているかが中心です。

アイデアソン (ideathon)

アイデアソンの資料置き場です。

Resources

• 青空文庫関連ツールのリスト

kosakuin's Issues

プロトタイプの仕様議論

#3 とも関連しますが、aozora.jsonやhinagataの仕様を煮詰めたり、kosakuinのあるべき姿を模索するためにプロトタイプづくりを進めたいと考えています。具体的には

• パッケージ受け付け、配布サーバ
• パッケージ投入スクリプト

をまずは考えています。仮に前者を pubserver (publishing server)、後者を aopm (AOzora package manager)と呼びます。これらのツールが満たすべき要件とそれを実現するための仕様をここで議論し、プロトタイプに実装していきたいと思います。

著作権が存続しているものと、していないものの業務フローの整理

著作権が存続しているものと、していないもので、作品の入力データ(テキスト)と、版面データ(イメージ)の共有が可能か整理する必要があると思います。

要求・要件の整理

aozorahack/aozorahack#1 の続き。

「要求・要件の整理」にとどまらない話も上ではありましたので、そちらは別イシュー切ってもらってもよいです。
要求、要件というカタイ言葉を使わずに言うと、「青空文庫の工作員の方々(より一般的な雑誌・書籍の編集・校正作業を含んでもいい)がこのシステムを使ってこんなことができるようになったらよさそうだな」というものと、「それを達成するためにこういうシステムを作ったらよさそうだな」ってとこですかね。

議論のアウトプットはこのリポジトリ内(か、どこか)にドキュメントの形でまとめたいなと思います。

完璧に洗い出すことにはこだわらない方針としたいですが、これを元に設計を進めることができるようになったり、ゴールイメージをある程度みんなが共有できるようになったらいいなと思います。

開発を迅速に進めるための骨格を整える

#1 要求・要件整理も含まれるのですが、その整理を待ってると遅くなるかもしれないので、鉄をアツい内に打つためにできることをやるというチケット。

• 開発を進めるためのプロトコルを決める
• 最低限のシステムの大枠を決める
  • 例) WebUI は RoR, バックエンドの SCM は Git, etc.

README.md アップデートする

今後も更新していくものですが、現時点の趣旨等をちゃんと書いておきたいという自分の意思を示しておきます。

kosakuin 類似技術・製品の調査

• Git ベース
  • GitHub
  • GitLab
  • GitBucket
• コードレビューシステム
  • Review Board

アリモノでプロトタイプとして使えるのであれば、それが手っ取り早いかなという気もしています。

今のところ上に挙げたものは GitHub を除いて OSS なので、kosakuin の一部として使うこともできるかもしれません。

他にこんなものあるよ、とかありましたらお知らせ下さい。