Jump to content

Template:Boilerplate-UserGuide: Difference between revisions

From SOJI ELECTRONICS
[unchecked revision][checked revision]
← Older edit
Admin (talk | contribs)
Bureaucrats, Interface administrators, Administrators
1,203 edits
VisualWikitext
No edit summary
Update
 
(20 intermediate revisions by the same user not shown)
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 mandatory sections (== H2 ==):
# 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>== Safety Information ==
<div class="dim">
 
''This section documents all safety-related information per IEC/IEEE 82079-1 and ANSI Z535.6 standards.''


''Document version: 1.0 | Date: {{subst:#time:d/m/Y}}''
'''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


== Safety Information ==
'''Example callout:'''
{{Notice|title=Sample Notice|body=Read entire guide before installation. Qualified technicians only. Wear PPE.}}


''Add safety warnings here.''
</div>


== Product Overview ==
== Product Overview ==
<div class="dim">


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


=== Intended Use ===
'''What to fill in:'''
* Approved applications
* 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)


=== NOT Intended For ===
'''Example structure:'''
* Excluded applications
* Paragraph: "The [Product Name] is a [type] device designed for [primary application]..."
* Variants table with columns: Variant | Description | Use Case
 
</div>


== Package Contents ==
== Package Contents ==
<div class="dim">
''List everything included in the shipment box.''
'''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)
'''Important note to include:''' "Verify all items are present before installation. Contact support if any item is missing or damaged."


{| class="wikitable"
</div>
! No. !! Item !! Quantity
|-
| 1 || ... || 01
|}


== Specifications ==
== Specifications ==
<div class="dim">
''Technical specifications of the product per IEC/IEEE 82079-1.''
'''What to fill in:''' specification table with columns Parameter / Value / Unit, covering:
* Mechanical: Dimensions (L × W × H), Weight
* Environmental: Operating temperature, Storage temperature, Ingress protection (IP)
* Electrical: Power supply, Current consumption (avg/peak/sleep)
* Wireless (if applicable): Bluetooth/WiFi/LoRa protocol
* Service life (expected years)
'''Sub-sections to consider:'''
* '''Technical Specifications''' — main spec table
* '''Dimensions''' — mechanical drawing image (upload as "Product-dimensions.png")
* '''Pinout/Connector''' (if applicable)


{| class="wikitable"
</div>
! Parameter !! Value
|-
| Parameter 1 || Value
|}


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


=== Tools Required ===
''Step-by-step installation procedure.''
* Tool 1
* Tool 2


=== Step 1 ===
'''Pre-requisite:''' "Before installation: Read [[#Safety Information|Safety Information]] section."
Description...
 
'''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)
 
'''Optional:''' mounting diagram image (upload as "Product-mounting.png")
 
</div>


== Configuration ==
== Configuration ==
<div class="dim">
''Software setup after physical installation.''
'''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


Setup instructions...
</div>


== Operation ==
== Operation ==
<div class="dim">
''Day-to-day usage instructions for end users.''
'''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


Daily usage...
</div>


== Troubleshooting ==
== Troubleshooting ==
<div class="dim">


{| class="wikitable"
''Common problems and solutions for end users.''
! Symptom !! Cause !! Solution
 
|-
'''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
 
'''Closing note:''' "If problem persists, contact [[#Support / Contact|Support]]."
 
</div>


== Maintenance ==
== Maintenance ==
<div class="dim">
''Periodic maintenance and end-of-life procedures.''
'''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
'''Required safety callout:'''
{{Warning|title=Battery Replacement Safety|body=Replace only with authorized part. Disconnect before opening. Wear chemical-resistant gloves. Observe correct polarity.}}


Schedule and procedures...
</div>


== Certification / Compliance ==
== Certification / Compliance ==
<div class="dim">
''Regulatory certifications and standards compliance.''


Standards compliance information...
'''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
 
'''Cross-references:'''
* See [[Product Certification & Approvals]] for detailed certificates
* See [[Product Memberships]] for SIG memberships
 
</div>


== Support / Contact ==
== Support / Contact ==
<div class="dim">
''Customer support channels.''
'''What to fill in:''' contact table with rows:
* '''Website''' — sojielectronics.com
* '''Email''' — support@sojielectronics.com
* '''Phone''' — support number
* '''Address''' — full company address
* '''Service hours''' — vd: "Mon–Fri, 08:00–17:00 GMT+7"


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


== Revision History ==
== Revision History ==
<div class="revision-history-auto">
<span class="dim">Loading revision history...</span>
</div>


{| class="wikitable"
[[Category:{{subst:#replace:{{subst:PAGENAME}}| User Guide|}}]]
! Date !! Version !! Description
|-
| {{subst:#time:d/m/Y}} || 1.0 || Initial release
|}
</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"