Jump to content

Template:Boilerplate-UserGuide: Difference between revisions

From SOJI ELECTRONICS
[unchecked revision][checked revision]
← Older editNewer edit →
Admin (talk | contribs)
Bureaucrats, Interface administrators, Administrators
1,203 edits
VisualWikitext
No edit summary
No edit summary
Line 1: Line 1:
<noinclude>
<noinclude>
This boilerplate creates a User Guide page structure following IEC 82079-1.
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
 
[[Category:Boilerplates]]
[[Category:Boilerplates]]
</noinclude><includeonly>__TOC__
</noinclude><includeonly>__TOC__


''Document version: 1.0 | Date: {{subst:#time:d/m/Y}}''
''Document version: 1.0 | Date: {{subst:#time:d/m/Y}} | Language: English''


== Safety Information ==
== Safety Information ==


''Add safety warnings here.''
''Read this section completely before installation or operation. Failure to observe these warnings may result in serious injury, death, or damage to equipment.''
 
=== General Safety ===
 
''Describe PPE, qualified personnel, working conditions.''
 
=== Specific Hazards ===
 
{{Notice
| title = General Operating Conditions
| body  = * Read the entire User Guide before installation
* Installation by qualified technicians only
* Wear appropriate Personal Protective Equipment (PPE)
}}
 
''Add hazard callouts here using {{Danger}}, {{Warning}}, {{Caution}}, {{Notice}} templates.''
 
=== Emergency Procedures ===
 
''Describe emergency procedures applicable to this product.''


== Product Overview ==
== Product Overview ==


''Brief description of the product.''
''Brief description: what the product is, what it does, key value.''


=== Intended Use ===
=== Intended Use ===
* Approved applications
 
The product is intended for:
* Application 1
* Application 2
* Application 3


=== NOT Intended For ===
=== NOT Intended For ===
* Excluded applications
 
The product is '''not''' intended for:
* Excluded application 1
* Excluded application 2
 
=== Product Variants ===
 
{| class="wikitable"
! Variant !! Description !! Use Case
|-
| Variant A || ... || ...
|-
| Variant B || ... || ...
|}


== Package Contents ==
== Package Contents ==
Each shipment includes:


{| class="wikitable"
{| class="wikitable"
! No. !! Item !! Quantity
! No. !! Item !! Quantity
|-
|-
| 1 || ... || 01
| 1 || Main product || 01
|-
| 2 || Accessory 1 || 01
|-
| 3 || Accessory 2 || 01
|-
| 4 || Quick installation guide || 01
|}
|}
'''Verify all items are present before installation.''' Contact support if any item is missing or damaged.


== Specifications ==
== Specifications ==


{| class="wikitable"
=== Technical Specifications ===
! Parameter !! Value
 
{| class="wikitable" style="text-align:center;"
! Parameter !! Value !! Unit
|-
| style="text-align:left;" | Dimensions (L × W × H) || ... || mm
|-
| style="text-align:left;" | Weight || ... || g
|-
| style="text-align:left;" | Operating temperature || ... || °C
|-
| style="text-align:left;" | Storage temperature || ... || °C
|-
| style="text-align:left;" | Power supply || ... || V / mAh
|-
| style="text-align:left;" | Current consumption || ... || µA / mA
|-
| style="text-align:left;" | Wireless protocol || ... || —
|-
| style="text-align:left;" | Ingress protection || ... || IP rating
|-
|-
| Parameter 1 || Value
| style="text-align:left;" | Service life (expected) || ... || years
|}
|}
=== Dimensions ===
[[File:Product-dimensions.png|thumb|center|500px|Overall dimensions (mm)]]


== Installation ==
== Installation ==
'''Before installation''': Read [[#Safety Information|Safety Information]] section.


=== Tools Required ===
=== Tools Required ===
* Tool 1
* Tool 1
* Tool 2
* Tool 2
* Personal Protective Equipment (PPE): safety goggles, gloves


=== Step 1 ===
=== Step 1: Site Preparation ===
Description...
 
''Describe preparation steps before installation.''
 
=== Step 2: Mounting ===
 
''Describe mounting procedure.''
 
[[File:Product-mounting.png|thumb|center|500px|Mounting diagram]]
 
=== Step 3: Connection ===
 
''Describe electrical / mechanical / wireless connection.''
 
=== Step 4: Verification ===
 
''Describe how to verify successful installation before powering on.''


== Configuration ==
== Configuration ==


Setup instructions...
''How to configure the product after installation.''
 
=== Mobile Application ===
 
Download mobile app:
* '''iOS''': App Store — ''[link]''
* '''Android''': Google Play — ''[link]''
 
'''Note''': Grant all permissions requested by the app (Camera, Location, Nearby devices, Bluetooth).
 
=== Connecting Sensor ===
 
# Open the application
# Select product from list
# Wait for device to appear in discovered list
# Press '''Connect'''
 
=== Calibration ===
 
''Step-by-step calibration procedure.''
 
==== Step 1: Set Full ====
 
# Action 1
# Action 2
 
==== Step 2: Set Empty ====
 
# Action 1
# Action 2
 
=== Configurable Parameters ===
 
{| class="wikitable"
! Parameter !! Default !! Range / Options !! Description
|-
| Device name || ... || ... || ...
|-
| Measurement interval || ... || ... || ...
|-
| Output protocol || ... || ... || ...
|-
| Password || (default) || ... || '''Must change before deployment'''
|}


== Operation ==
== Operation ==


Daily usage...
''Day-to-day usage instructions.''
 
=== Calibration Table ===
 
The product supports calibration in two ways:
 
{| class="wikitable"
! Method !! Description !! Recommended
|-
| Method 1 (Platform) || ... || ✓
|-
| Method 2 (On Device) || ... ||
|}
 
=== Reading Data ===
 
Data can be received by:
* Telematics device / Gateway
* Smartphone with mobile app
 
''Detailed protocol integration: see [[Product Configuration]].''
 
=== Long-Range Operation ===
 
For challenging environments (long distance, metal obstacles):
 
{| class="wikitable"
! Combination !! Range
|-
| Standard setup || Standard
|-
| With accessory adapter || 2× Standard
|}
 
=== Protective Cover ===
 
''Describe optional protective cap / housing installation.''


== Troubleshooting ==
== Troubleshooting ==


{| class="wikitable"
{| class="wikitable"
! Symptom !! Cause !! Solution
! Symptom !! Possible Cause !! Solution
|-
| Issue 1 (describe)
|
* Cause 1
* Cause 2
|
* Solution 1
* Solution 2
|-
|-
| ... || ... || ...
| Issue 2 (describe)
|
* Cause
|
* Solution
|-
| Issue 3 (describe)
|
* Cause
|
* Solution
|}
|}
''If problem persists, contact [[#Support / Contact|Support]].''


== Maintenance ==
== Maintenance ==


Schedule and procedures...
=== Periodic Inspection ===
 
{| class="wikitable"
! Frequency !! Action
|-
| Monthly        || ''Describe monthly checks''
|-
| Quarterly      || ''Describe quarterly checks''
|-
| Annually      || ''Describe annual maintenance''
|-
| Every 5 years  || ''Describe 5-year inspection''
|-
| Every 8-10 years || ''Battery / major replacement''
|}
 
=== Cleaning ===
 
# Disconnect product from system
# Wipe external surface with dry cloth or non-conductive cleaner
# Do '''NOT''' use:
#* Solvents (acetone, benzene)
#* Abrasive materials
#* High-pressure water beyond IP rating
 
=== Battery Replacement ===
 
''If applicable: battery replacement procedure with safety warnings.''
 
{{Warning
| title = Battery Replacement Safety
| body  = * Replace only with authorized battery part
* Disconnect from system before opening
* Wear chemical-resistant gloves
* Observe correct polarity
}}
 
=== Calibration Verification ===
 
After maintenance, re-perform calibration (see [[#Configuration|Configuration]]).
 
=== Disposal / End-of-Life ===
 
* Remove battery and dispose separately at certified battery recycling facility
* Send product body to electronic waste recycling
* Do '''NOT''' dispose in regular trash
* In EU: Take-back via local WEEE registration scheme


== Certification / Compliance ==
== Certification / Compliance ==


Standards compliance information...
=== Wireless / Radio ===
 
{| class="wikitable"
! Region !! Standard !! Status
|-
| EU      || RED 2014/53/EU, EMC 2014/30/EU || Compliant
|-
| US      || FCC Part 15 || Compliant
|-
| Canada  || ISED RSS || Compliant
|-
| UK      || UKCA, UK RED || Compliant
|}
 
=== Environmental ===
 
{| class="wikitable"
! Standard !! Status
|-
| RoHS 3 (2011/65/EU + 2015/863) || Compliant
|-
| REACH (EC 1907/2006)          || Compliant
|-
| WEEE (2012/19/EU)              || Registered
|-
| Battery WEEE (2006/66/EC)      || ''(if applicable)''
|}
 
=== Mechanical ===
 
{| class="wikitable"
! Standard !! Rating
|-
| IEC 60529 (Ingress Protection) || ...
|}
 
=== Bluetooth Qualification ===
 
''(If product uses Bluetooth)''
 
* Bluetooth Core Specification: ...
* Bluetooth SIG Member ID: ''(see [[Product Memberships]])''
* End Product Declaration ID: ''(see [[Product Memberships]])''
 
''Detailed certification information: see [[Product Certification & Approvals]]''
''Memberships information: see [[Product Memberships]]''
 
=== Warranty ===
 
* '''Warranty period''': ... years from date of shipment
* '''NOT covered''': battery, physical damage, unauthorized modification
* '''Warranty void if''':
** Operating conditions exceed specifications
** Unauthorized modification or repair
** Damage from improper installation
** Damage from chemical exposure outside rated fluids


== Support / Contact ==
== Support / Contact ==


Contact information...
{| class="wikitable"
! Channel !! Contact
|-
| Website || [https://sojielectronics.com sojielectronics.com]
|-
| Email  || support@sojielectronics.com
|-
| Phone  || ''(insert support number)''
|-
| Address || ''(insert SOJI Electronics JSC address)''
|}
 
=== Documentation ===
 
{| class="wikitable"
! Document !! Version !! Last Updated
|-
| This User Guide || 1.0 || {{subst:#time:d/m/Y}}
|-
| Datasheet || ... || ...
|-
| Configuration Guide || ... || ...
|-
| Protocol Integration || ... || ...
|}
 
=== Related Pages ===
 
* [[Product Overview]]
* [[Product Configuration]]
* [[Product Certification & Approvals]]
* [[Product Memberships]]
* [[Frequently Asked Questions - FAQ]]


== Revision History ==
=== Revision History ===


{| class="wikitable"
{| class="wikitable"
Line 80: Line 413:
| {{subst:#time:d/m/Y}} || 1.0 || Initial release
| {{subst:#time:d/m/Y}} || 1.0 || Initial release
|}
|}
[[Category:User Guide]]
</includeonly>
</includeonly>

Revision as of 01:23, 14 May 2026

This boilerplate creates a User Guide page structure following IEC/IEEE 82079-1.

11 sections:

  1. Safety Information
  2. Product Overview
  3. Package Contents
  4. Specifications
  5. Installation
  6. Configuration
  7. Operation
  8. Troubleshooting
  9. Maintenance
  10. Certification / Compliance
  11. Support / Contact
SOJI Electronics
Retrieved from "https://wiki.sojielectronics.com/index.php?title=Template:Boilerplate-UserGuide&oldid=442"