WriteSpec

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

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

Wiki Top に Spec を記述します

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

Wiki/クラス名 に API Spec を記述します

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

例

API Spec だけをシンプルに説明している UTF8.jsや、 Spec と API Spec を詳細に説明している Thread.js を参考にしてください。

くじけそうになったら

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