Product Manual Management

Introduction

A product manual contains a user manual, specifications, and an installation guide and is available on the device page of the OEM app to help users learn how to use the product.

Product manual management

Manual management entrys

Tuya IoT Development Platform provides two entrys to product manual management.
Entry 1: Operation > Product Manual

Entry 2: Product Configuration of the product development process

Product search

To quickly find a product for which you want to manage its product manuals, enter the product ID or name in the search box and click Search.

From the product list, you can see the number of published manuals of a specific product (counted based on languages).

Manual management

To manage the manuals of a product, click Manage Manuals.

Manual list

Manuals of a product are organized by language in the manual list.

• Preview: The Preview button is visible only for manuals in the Published state.
• Draft Box Status - No Update: This indicates that no updates are made and remain unpublished on Tuya IoT Development Platform. The manual content on Tuya IoT Development Platform is consistent with that in the app.
• Draft Box Status - New Updates: This indicates that new updates are made on Tuya IoT Development Platform but not published. The manual content on Tuya IoT Development Platform is not consistent with that in the app. What users see is the content published last time instead of the updated version on Tuya IoT Development Platform.

Manual search

You can search for a product manual by manual ID, title, publish status, draft box status, language, creation time, or update time.

Create manuals

To create a manual, click Create Manual. A manual creation page appears.

After you write the manual in a specific language, click Save before you switch to another language. Alternatively, you can publish the current language version of the manual and then click Edit to write the manual in another language.

• Save: After you write the manual content, click Save. The manual will not appear in the app at this time.
• Publish: After you click Publish, the manual appears in the app and is visible to users.

Edit manuals

To edit the title or content of a manual, click Edit in the Draft Box Status column. You can click the drop-down arrow in the Manual Language field to switch to another language.

• Save: Clicking Save will not update the manual in the app. The manual visible to users in the app is the last published version.
• Publish: Clicking Publish will publish your changes to the app.

Ranking

Manuals are ranked in ascending order by sequence number on clients. The sequence of manuals on Tuya IoT Development Platform remains unchanged.

Unpublish manuals

Unpublish a manual

To unpublish a manual, place the cursor over … in the Operation column. The Unpublish button appears if the manual is a published manual. Click Unpublish. The manual will be removed from the app. However, the manual still exists on Tuya IoT Development Platform. You can click Publish on the manual editing page to publish the manual again.

Unpublish multiple manuals simultaneously

To unpublish multiple manuals at a time, select the manuals that you want to remove and click Unpublish.

Delete manuals

Delete a manual

Place the cursor over … in the Operation column. The Delete button appears if a manual is only saved on Tuya IoT Development Platform or unpublished. Click Delete. The manual is deleted and invisible in the app and on Tuya IoT Development Platform.
Note: You cannot directly delete a published manual.

Delete multiple manuals simultaneously

Before you delete multiple selected manuals, the platform checks whether all the selected manuals are only saved on Tuya IoT Development Platform or unpublished. If they are, all the selected manuals will be deleted from the app and Tuya IoT Development Platform. If they are not, you cannot perform this batch deletion operation.

Manual availability in the app

Logic

• OEM apps using templates of 3.35.5 and later versions support the manual feature.
• If a product has no manual, no manual is available in the app.
• If manuals in multiple languages are available, the manual shown in the app follows the system language of the mobile phone. If no manual of a product matches with the system language of the mobile phone, the manual in the default language is shown in the app. The default manual language is Simplified Chinese under an account for China and English under an account for countries and regions outside China. If no default language is set and no manual matches with the system language of the mobile phone, Product Manual will not be displayed in the app.

Entry to product manuals

On the device control panel, tap the Edit icon in the upper-right corner. On the screen that appears, tap Product Manual.

To view a manual, tap the manual title.