Developers

Pieceの説明文について

PieceJSONの説明文には、作成されたPieceがどんなもので、どのように使用するPieceなのか説明文を記載していただきます。Piece説明文の体裁を揃えるため、雛型をご利用ください。(PieceJSON Generatorではテンプレートが用意されています。ぜひご利用ください。)
説明文がガイドラインに則っていない場合、Piece登録の審査時に、Riiiver運営チームから修正や追記を依頼することがあります。

descriptionの記載例

{
  "title": {
    "en": "iiidea name",
    "ja": "iiideaの名前"
  },
  "description": {
    "en": "
    ~~What is this Piece?~~\n
    Summary regarding your Piece is here.\n
    \n
    ~~How do I use it?~~\n
    Describe how to use.\n
    ~~Notes~~\n
    Precautions for use. This part is optional.\n
    \n
    ~~Compatible with~~\n
    Clarify the compatible products if your Piece cannot be used among all Riiiver devices without causing trouble\n
    \n
    About Trademarks ( https://riiiver.com/en/trademark/ )",
    "ja": "
    【どんなPiece？】\n
    Pieceの概要を記載します。\n
    \n
    【どうやって使うの？】\n
    Preferenceの設定項目など、Pieceの使い方を説明します。\n
    \n
    【ご注意！】\n
    エラー時の処理など、ユーザーに知らせておきたい使用上の注意を記載します。特にない場合は記載不要です。\n
    \n
    【対象製品】\n
    使用できるデバイスが限られている場合、ここに記載してください。全てのRiiiverデバイスで利用可能な場合は記載不要です。\n
    \n
    商標について ( https://riiiver.com/trademark/ )"
  },
・
・
・
}

JSONファイルでの改行について

ここでは、見易さのために改行して記載しています。

上記の雛形について注意すべきポイントを解説します。

見出しを追加する

説明文が長くなるとどこに何が書いてあるのかが分かりにくくなるため、内容ごとに見出しをつけていただくようご協力をお願いいたします。

使用非推奨ワードとその置き換え

Riiiverを利用するユーザーは様々な方が利用しますので、使用非推奨の単語を制定し、その置き換えをご協力いただける範囲でお願いしております。

商標について

外部サービスを利用したPieceをつくる場合に、商標権に関する法務的な事項に対し、商標に関する説明をまとめたページを用意しております。説明文の末尾に下記の定型文・リンクを追加してくださいますようお願いいたします。