Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings
uupaa edited this pageJun 12, 2015 ·6 revisions

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 の記述が面倒だな… 嫌だな… と感じたら、こちらのエントリを御覧ください。

Clone this wiki locally

[8]ページ先頭

©2009-2025 Movatter.jp