Template:Boilerplate-UserGuide: Difference between revisions
| [checked revision] | [checked revision] |
Update |
Update template |
||
| Line 19: | Line 19: | ||
== Safety Information == | == Safety Information == | ||
<div class="dim"> | |||
=== General Safety === | === General Safety === | ||
| Line 39: | Line 39: | ||
{{Placeholder|e.g., Describe what to do in case of fire, electric shock, chemical exposure, or other product-specific emergencies. Include emergency contact numbers.}} | {{Placeholder|e.g., Describe what to do in case of fire, electric shock, chemical exposure, or other product-specific emergencies. Include emergency contact numbers.}} | ||
</div> | |||
== Product Overview == | == Product Overview == | ||
<div class="dim"> | |||
{{Placeholder|e.g., The [Product Name] is a [type] device designed for [primary application]. It features [key technology] and is built for [target environment]. Brief 1–2 paragraph overview of what the product is, what it does, and its key value.}} | {{Placeholder|e.g., The [Product Name] is a [type] device designed for [primary application]. It features [key technology] and is built for [target environment]. Brief 1–2 paragraph overview of what the product is, what it does, and its key value.}} | ||
| Line 66: | Line 70: | ||
| {{Placeholder|e.g., Extended}} || {{Placeholder|e.g., Cabled version with 5m cable}} || {{Placeholder|e.g., Industrial tanks}} | | {{Placeholder|e.g., Extended}} || {{Placeholder|e.g., Cabled version with 5m cable}} || {{Placeholder|e.g., Industrial tanks}} | ||
|} | |} | ||
</div> | |||
== Package Contents == | == Package Contents == | ||
<div class="dim"> | |||
Each shipment includes: | Each shipment includes: | ||
| Line 84: | Line 91: | ||
'''Verify all items are present before installation.''' Contact support if any item is missing or damaged. | '''Verify all items are present before installation.''' Contact support if any item is missing or damaged. | ||
</div> | |||
== Specifications == | == Specifications == | ||
<div class="dim"> | |||
=== Technical Specifications === | |||
{| class="wikitable" style="text-align:center;" | {| class="wikitable" style="text-align:center;" | ||
| Line 116: | Line 125: | ||
{{Placeholder|e.g., Upload your product dimension drawing as "Product-dimensions.png" via Special:Upload, or replace the File: link above with your actual filename.}} | {{Placeholder|e.g., Upload your product dimension drawing as "Product-dimensions.png" via Special:Upload, or replace the File: link above with your actual filename.}} | ||
</div> | |||
== Installation == | == Installation == | ||
<div class="dim"> | |||
'''Before installation''': Read [[#Safety Information|Safety Information]] section. | '''Before installation''': Read [[#Safety Information|Safety Information]] section. | ||
| Line 144: | Line 156: | ||
{{Placeholder|e.g., Apply power. LED should turn green within 5 seconds. Use mobile app to confirm device is discoverable via Bluetooth. Test measurement output.}} | {{Placeholder|e.g., Apply power. LED should turn green within 5 seconds. Use mobile app to confirm device is discoverable via Bluetooth. Test measurement output.}} | ||
<div> | |||
== Configuration == | == Configuration == | ||
<div class="dim"> | |||
{{Placeholder|e.g., This section describes how to configure the product after physical installation. Configuration is done via mobile app (iOS/Android) or USB tool.}} | {{Placeholder|e.g., This section describes how to configure the product after physical installation. Configuration is done via mobile app (iOS/Android) or USB tool.}} | ||
| Line 193: | Line 207: | ||
| Password || (default) || {{Placeholder|e.g., 6–20 chars}} || '''Must change before deployment''' | | Password || (default) || {{Placeholder|e.g., 6–20 chars}} || '''Must change before deployment''' | ||
|} | |} | ||
</div> | |||
== Operation == | == Operation == | ||
<div class="dim"> | |||
{{Placeholder|e.g., Day-to-day usage instructions. How operators interact with the product during normal operation.}} | {{Placeholder|e.g., Day-to-day usage instructions. How operators interact with the product during normal operation.}} | ||
| Line 233: | Line 249: | ||
{{Placeholder|e.g., If using the optional protective cap/housing (P/N XXX), install per the accessory manual. The cap provides additional protection against UV exposure and physical impact.}} | {{Placeholder|e.g., If using the optional protective cap/housing (P/N XXX), install per the accessory manual. The cap provides additional protection against UV exposure and physical impact.}} | ||
</div> | |||
== Troubleshooting == | == Troubleshooting == | ||
<div class="dim"> | |||
{| class="wikitable" | {| class="wikitable" | ||
! Symptom !! Possible Cause !! Solution | ! Symptom !! Possible Cause !! Solution | ||
| Line 263: | Line 280: | ||
''If problem persists, contact [[#Support / Contact|Support]].'' | ''If problem persists, contact [[#Support / Contact|Support]].'' | ||
</div> | |||
== Maintenance == | == Maintenance == | ||
<div class="dim"> | |||
=== Periodic Inspection === | === Periodic Inspection === | ||
| Line 313: | Line 331: | ||
* Do '''NOT''' dispose in regular trash | * Do '''NOT''' dispose in regular trash | ||
* In EU: Take-back via local WEEE registration scheme | * In EU: Take-back via local WEEE registration scheme | ||
</div? | |||
== Certification / Compliance == | == Certification / Compliance == | ||
<div class="dim"> | |||
=== Wireless / Radio === | === Wireless / Radio === | ||
| Line 372: | Line 390: | ||
** Damage from improper installation | ** Damage from improper installation | ||
** Damage from chemical exposure outside rated fluids | ** Damage from chemical exposure outside rated fluids | ||
</div> | |||
== Support / Contact == | == Support / Contact == | ||
<div class="dim"> | |||
{| class="wikitable" | {| class="wikitable" | ||
! Channel !! Contact | ! Channel !! Contact | ||
| Line 386: | Line 405: | ||
| Address || {{Placeholder|e.g., SOJI Electronics JSC, [insert full address]}} | | Address || {{Placeholder|e.g., SOJI Electronics JSC, [insert full address]}} | ||
|} | |} | ||
</div> | |||
== Related Pages == | == Related Pages == | ||
<div class="dim"> | |||
* [[Product Datasheet]] | * [[Product Datasheet]] | ||
* [[Product Certification & Approvals]] | * [[Product Certification & Approvals]] | ||
* [[Frequently Asked Questions - FAQ]] | * [[Frequently Asked Questions - FAQ]] | ||
</div> | |||
== Revision History == | == Revision History == | ||
Revision as of 04:49, 19 May 2026
This boilerplate creates a User Guide page structure following IEC/IEEE 82079-1.
11 sections:
- Safety Information
- Product Overview
- Package Contents
- Specifications
- Installation
- Configuration
- Operation
- Troubleshooting
- Maintenance
- Certification / Compliance
- Support / Contact