Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v0.3に向けたドキュメント整備 #105

Open
beam2d opened this issue Jan 23, 2015 · 0 comments
Open

v0.3に向けたドキュメント整備 #105

beam2d opened this issue Jan 23, 2015 · 0 comments

Comments

@beam2d
Copy link
Member

beam2d commented Jan 23, 2015

v0.2からもうすぐ半年なので、そろそろv0.3を考えたいと思っていて、そのためにドキュメントを整備したい。現状のドキュメントは

  • 読者に waf の知識を必要としている
  • 1 ページがだらだらと長くて読みづらい
  • 各読者のニーズに対応してない(さくっと使いたい人、実際の研究に使いたい人、拡張したい人)

という問題がある。新しい機能に追従しつつ、これらを解決したい。読者のニーズも様々だと思うので、

  • クイックスタート(とりあえずなんでもいいからさくっと試したい人向けのインストラクション)
  • チュートリアル(例を使いながらひと通り機能に触る)
  • maf を使う人向けの waf の解説(軽いやつ)
  • 実装・設計に関するドキュメント(がっつり触る人向け)

あたりがあると良いと思う。前者 2 つは maf で閉じた内容、後者 2 つは中の実装(waf とどうつながってるかなど)を含めた内容として書く。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant