WriteSpec

npm publish が終わったら GitHub/Wiki に Markdown で Spec(ドキュメント)を記述します。

npm run wiki コマンドを実行すると、ブラウザで MyExample.js の wiki ページ(初めての場合は空白のページ)が開きます。このページが MyExample.js のドキュメントを記述する wiki のトップページです。

github.com/ユーザ名/MyExample/wiki/ (wiki top) に Spec を記述します

wiki top(wiki home) ページには、MyExample の Spec (仕様や設計)を記述します。MyExample.js で解決したかった事、どんな事に使えるか、何かをするか、そして何かをしないかを記述してください。
ページが長くなる場合は概要に留め、それぞれのトピックについて別のページに記載してください。

github.com/ユーザ名/MyExample/wiki/MyExample に API Spec を記述します

wiki/クラス名 ページには、MyExample の API Spec (API の仕様)を記述します。API の具体的な使い方を説明してください。

例

API Spec だけをシンプルに説明している UTF8.js の例や、 概念から詳細に説明している Thread.js の例 などを参考にしてください。

くじけそうになったら

Spec の記述が面倒だな… 嫌だな… と感じたら、こちらのエントリを御覧ください。