Developers

Descriptions of the Piece

In the PieceJOSN description, make a description of the created Piece on what it is and how to use it. Use a template to format the Piece descriptions. (Templates are prepared on the Piece JSON Generator. Please use them.)
When the description does not follow the guideline, the Riiiver operation team may contact you asking for the correction of and addition to the description during the review at the Piece registration.

A sample description

{
  "title": {
    "en": "iiidea naem",
    "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/ )"
  },
・
・
・
}

Line breaks on the JSON file

Line breaks were made for the visibility in the above description.

Some points of concern referring to the above sample are as follows.

Making titles

Make titles to each content in the description when it is long and becomes difficult to find what the user wants to know.

Trademark

For the Piece created using external services, descriptions on the legal matters related to trademarks are prepared in the separate page. Please add the following fixed phrase and the link at the end of the description.