« krmovie を本体に統合 | メイン | 吉里吉里Z 64bit対応β1公開 »
2016年04月03日
吉里吉里Z 開発:: 吉里吉里Z に欠けているドキュメントを GitHub に
Tweet @jin1016をフォロー吉里吉里Zのページには API リファレンスなどが置かれているが、ドキュメントは圧倒的に不足している状態。
そこで GitHub にリポジトリを作って、Markdown で書いて、みんなに PullRequest してもらってドキュメントのカバー率を上げようと思い、吉里吉里Z 情報 を作った。
今のところ体系立てて整備するのではなく、あった方が良さそうなドキュメントをどんどん追加してもらってカバー率を上げ、後でインデックスの整備や編集を行って見やすさを改善する方針。
まずは検索でヒットすれば何とかなるだろうと。
もちろん体系立てて書かれたドキュメントを一気に PullRequest してもらっても良い。
私の場合ブログに開発しつつその仕様など上げているが、Fix した仕様かどうかなど曖昧な部分もあるため、ブログの中から固まっているものなど順次追加していく予定。
また、各機能のテスト用に書いたスクリプトは、ほぼそのままその機能の使い方サンプルともなるので、そのようなものも追加していく。
吉里吉里Zのページ自体も GitHub Pages なので PullRequest なども出来るんだけど、まずは独立して追加しやすいものがあるといいだろうと言うことで。
投稿者 Takenori : 2016年04月03日 23:14
comments powered by Disqus