Skip to content

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

@beam2d

Description

@beam2d

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

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

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

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

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions