Jump to content

Template:Boilerplate-UserGuide: Difference between revisions

From SOJI ELECTRONICS
[checked revision][checked revision]
← Older edit
Admin (talk | contribs)
Bureaucrats, Interface administrators, Administrators
1,203 edits
VisualWikitext
No edit summary
Update
 
(19 intermediate revisions by the same user not shown)
Line 2: Line 2:
This boilerplate creates a User Guide page structure following IEC/IEEE 82079-1.
This boilerplate creates a User Guide page structure following IEC/IEEE 82079-1.


11 sections:
11 mandatory sections (== H2 ==):
# Safety Information
# Safety Information
# Product Overview
# Product Overview
Line 16: Line 16:


[[Category:Boilerplates]]
[[Category:Boilerplates]]
</noinclude><includeonly>__TOC__
</noinclude><includeonly>== Safety Information ==
<div class="dim">


''Document version: 1.0 | Date: {{subst:#time:d/m/Y}} | Language: English''
''This section documents all safety-related information per IEC/IEEE 82079-1 and ANSI Z535.6 standards.''


== Safety Information ==
'''What to fill in:'''
* General safety requirements (PPE, qualified personnel, working conditions)
* Specific hazards using callouts:
** <code><nowiki>{{Danger|title=...|body=...}}</nowiki></code> — imminent hazard, death/serious injury
** <code><nowiki>{{Warning|title=...|body=...}}</nowiki></code> — potential hazard, possible injury
** <code><nowiki>{{Caution|title=...|body=...}}</nowiki></code> — potential equipment damage
** <code><nowiki>{{Notice|title=...|body=...}}</nowiki></code> — important info, no hazard
* Emergency procedures (fire, electric shock, chemical exposure, evacuation)
* Emergency contact numbers


''Read this section completely before installation or operation. Failure to observe these warnings may result in serious injury, death, or damage to equipment.''
'''Example callout:'''
{{Notice|title=Sample Notice|body=Read entire guide before installation. Qualified technicians only. Wear PPE.}}


=== General Safety ===
</div>
 
''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 ==
<div class="dim">


''Brief description: what the product is, what it does, key value.''
''Introduce the product: what it is, what it does, and key value proposition.''


=== Intended Use ===
'''What to fill in:'''
* 1–2 paragraph product description: name, category, primary function, key features
* '''Intended Use''' — bullet list of applications the product is designed for
* '''NOT Intended For''' — bullet list of excluded applications (safety/regulatory)
* '''Product Variants''' — table of variants if multiple SKUs exist (Variant / Description / Use Case)


The product is intended for:
'''Example structure:'''
* Application 1
* Paragraph: "The [Product Name] is a [type] device designed for [primary application]..."
* Application 2
* Variants table with columns: Variant | Description | Use Case
* Application 3


=== NOT Intended For ===
</div>


The product is '''not''' intended for:
== Package Contents ==
* Excluded application 1
<div class="dim">
* Excluded application 2
 
=== Product Variants ===
 
{| class="wikitable"
! Variant !! Description !! Use Case
|-
| Variant A || ... || ...
|-
| Variant B || ... || ...
|}


== Package Contents ==
''List everything included in the shipment box.''


Each shipment includes:
'''What to fill in:''' table with columns:
* '''No.''' — item number (1, 2, 3, ...)
* '''Item''' — item name (vd: "Main sensor unit", "Mounting bracket", "Connection cable 2m")
* '''Quantity''' — quantity per package (vd: 01, 02)


{| class="wikitable"
'''Important note to include:''' "Verify all items are present before installation. Contact support if any item is missing or damaged."
! No. !! Item !! Quantity
|-
| 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.
</div>


== Specifications ==
== Specifications ==
<div class="dim">


=== Technical Specifications ===
''Technical specifications of the product per IEC/IEEE 82079-1.''


{| class="wikitable" style="text-align:center;"
'''What to fill in:''' specification table with columns Parameter / Value / Unit, covering:
! Parameter !! Value !! Unit
* Mechanical: Dimensions (L × W × H), Weight
|-
* Environmental: Operating temperature, Storage temperature, Ingress protection (IP)
| style="text-align:left;" | Dimensions (L × W × H) || ... || mm
* Electrical: Power supply, Current consumption (avg/peak/sleep)
|-
* Wireless (if applicable): Bluetooth/WiFi/LoRa protocol
| style="text-align:left;" | Weight || ... || g
* Service life (expected years)
|-
| 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
|-
| style="text-align:left;" | Service life (expected) || ... || years
|}


=== Dimensions ===
'''Sub-sections to consider:'''
* '''Technical Specifications''' — main spec table
* '''Dimensions''' — mechanical drawing image (upload as "Product-dimensions.png")
* '''Pinout/Connector''' (if applicable)


[[File:Product-dimensions.png|thumb|center|500px|Overall dimensions (mm)]]
</div>


== Installation ==
== Installation ==
<div class="dim">


'''Before installation''': Read [[#Safety Information|Safety Information]] section.
''Step-by-step installation procedure.''
 
=== Tools Required ===
 
* Tool 1
* Tool 2
* Personal Protective Equipment (PPE): safety goggles, gloves
 
=== Step 1: Site Preparation ===
 
''Describe preparation steps before installation.''
 
=== Step 2: Mounting ===
 
''Describe mounting procedure.''
 
[[File:Product-mounting.png|thumb|center|500px|Mounting diagram]]


=== Step 3: Connection ===
'''Pre-requisite:''' "Before installation: Read [[#Safety Information|Safety Information]] section."


''Describe electrical / mechanical / wireless connection.''
'''What to fill in (sub-sections):'''
* '''Tools Required''' — bullet list of tools + PPE
* '''Step 1: Site Preparation''' — clean mounting surface, clearance, power off
* '''Step 2: Mounting''' — physical mounting procedure with torque values
* '''Step 3: Connection''' — electrical/wireless connection with wire color codes
* '''Step 4: Verification''' — how to verify installation (LED status, app discovery)


=== Step 4: Verification ===
'''Optional:''' mounting diagram image (upload as "Product-mounting.png")


''Describe how to verify successful installation before powering on.''
</div>


== Configuration ==
== Configuration ==
<div class="dim">


''How to configure the product after installation.''
''Software setup after physical 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 ====
'''What to fill in (sub-sections):'''
* '''Mobile Application''' — iOS/Android app download links + required permissions
* '''Connecting Sensor''' — numbered steps to discover and pair device
* '''Calibration''' — calibration procedure (Set Full, Set Empty, etc.)
* '''Configurable Parameters''' — table with columns: Parameter / Default / Range / Description
** Common params: Device name, Measurement interval, Output protocol, Password


# Action 1
</div>
# 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 ==
<div class="dim">


''Day-to-day usage instructions.''
''Day-to-day usage instructions for end users.''


=== Calibration Table ===
'''What to fill in (sub-sections):'''
* '''Reading Data''' — how data is delivered (gateway, app, cloud)
* '''Calibration Methods''' — table of available calibration methods with recommended option
* '''Long-Range Operation''' — range settings for challenging environments
* '''Protective Accessories''' — optional caps/housings if applicable
* '''Operating Modes''' — normal/diagnostic/sleep modes if applicable


The product supports calibration in two ways:
</div>


{| class="wikitable"
== Troubleshooting ==
! Method !! Description !! Recommended
<div class="dim">
|-
| 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.''
''Common problems and solutions for end users.''


== Troubleshooting ==
'''What to fill in:''' table with columns:
* '''Symptom''' — what user observes (vd: "Device does not power on", "No Bluetooth connection")
* '''Possible Cause''' — bullet list of potential causes
* '''Solution''' — bullet list of step-by-step solutions


{| class="wikitable"
'''Closing note:''' "If problem persists, contact [[#Support / Contact|Support]]."
! 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]].''
</div>


== Maintenance ==
== Maintenance ==
<div class="dim">


=== Periodic Inspection ===
''Periodic maintenance and end-of-life procedures.''
 
{| 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 ===
'''What to fill in (sub-sections):'''
* '''Periodic Inspection''' — table: Frequency (Monthly/Quarterly/Annually/5-year/8-10 year) / Action
* '''Cleaning''' — procedure with prohibited materials (solvents, abrasives)
* '''Battery Replacement''' (if applicable) — procedure + safety warnings
* '''Calibration Verification''' — re-calibration after maintenance
* '''Disposal / End-of-Life''' — recycling instructions per WEEE/RoHS


# Disconnect product from system
'''Required safety callout:'''
# Wipe external surface with dry cloth or non-conductive cleaner
{{Warning|title=Battery Replacement Safety|body=Replace only with authorized part. Disconnect before opening. Wear chemical-resistant gloves. Observe correct polarity.}}
# Do '''NOT''' use:
#* Solvents (acetone, benzene)
#* Abrasive materials
#* High-pressure water beyond IP rating


=== Battery Replacement ===
</div>
 
''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 ==
<div class="dim">


=== Wireless / Radio ===
''Regulatory certifications and standards compliance.''
 
{| 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 ===
'''What to fill in (sub-sections with tables):'''
* '''Wireless / Radio''' — Region / Standard / Status (CE RED, FCC Part 15, ISED RSS, UKCA)
* '''Environmental''' — Standard / Status (RoHS 3, REACH, WEEE, Battery WEEE)
* '''Mechanical''' — Standard / Rating (IEC 60529 IP rating)
* '''Bluetooth Qualification''' (if applicable) — QDID, SIG Member ID, EPDID
* '''Warranty''' — period, exclusions, void conditions


{| class="wikitable"
'''Cross-references:'''
! Standard !! Status
* See [[Product Certification & Approvals]] for detailed certificates
|-
* See [[Product Memberships]] for SIG memberships
| 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 ===
</div>
 
{| 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 ==
<div class="dim">


{| class="wikitable"
''Customer support channels.''
! 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]]
'''What to fill in:''' contact table with rows:
* [[Product Configuration]]
* '''Website''' — sojielectronics.com
* [[Product Certification & Approvals]]
* '''Email''' — support@sojielectronics.com
* [[Product Memberships]]
* '''Phone''' — support number
* [[Frequently Asked Questions - FAQ]]
* '''Address''' — full company address
* '''Service hours''' — vd: "Mon–Fri, 08:00–17:00 GMT+7"


=== Revision History ===
</div>
<div class="noprint">
== Related Documents ==
''Cross-references to other documents.''
{{RelatedDocuments}}
</div>


{| class="wikitable"
== Revision History ==
! Date !! Version !! Description
<div class="revision-history-auto">
|-
<span class="dim">Loading revision history...</span>
| {{subst:#time:d/m/Y}} || 1.0 || Initial release
</div>
|}


[[Category:User Guide]]
[[Category:{{subst:#replace:{{subst:PAGENAME}}| User Guide|}}]]
</includeonly>
</includeonly>

Latest revision as of 09:01, 25 May 2026

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

11 mandatory sections (== H2 ==):

  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=1229"