Skip to content

Docs Development Scratch Pad

Topics that should be covered

  • Sales Pitch
    • Device features / functionality
    • Device datasheet
    • Device use cases
    • Device comparison against Decoder V1
  • Getting Started Guides
    • Whats in the box
    • First set up (power, antennas etc)
    • Registration / assignment of device to you
      • Through our cloud system?
    • Hologram allocation for cellular usage
  • Basic Usage
    • Basic starting configuration
    • Firmware updates
    • LEDs and what they mean
    • HF and UHF separate
      • Setting up the device
      • Relevant configuration for each
    • Using our Commander Software
  • Advanced Usage
    • Emergency recovery
    • Passive POE / OTG Power modes
    • FTP
    • Advanced configuration guides
    • Web API
  • Troubleshooting
  • Commands & Configuration
    • Full technical breakdown of all commands / configuration etc publicly available
  • User Repair / Service
    • General note: potted, etc
    • Battery replacement
    • Parts Availability

ChatGPT rendered overview

  1. Overview

    • Purpose: Provide a high-level introduction to the product, its features, and applications.
    • Content:
      • Product Summary: A brief description of what the product does.
      • Key Features: Highlight the main technical features and specifications.
      • Applications: Industries and use cases where the product is applicable.
      • Product Variants: List any variations in the model if applicable.

  2. Getting Started

    • Purpose: Guide new users to set up and begin using the product.
    • Content:
      • Unboxing & Package Contents: List of included components.
      • Setup Instructions: Step-by-step guide on how to physically set up the product.
      • Power Requirements: Voltage/current ratings, connectors, and safety considerations.
      • First-Time Use: Basic guide to turn on the product and perform initial configuration.
      • Safety & Compliance: Instructions for safe use and regulatory information (e.g., CE marking, FCC certification).

  3. Firmware/Software Documentation

    • Purpose: Provide instructions for interacting with the product through software or firmware.
    • Content:
      • Firmware Features: An overview of the firmware's functionality.
      • Firmware Update Guide: How to update the firmware, including tools needed.
      • API/SDK Documentation: For advanced users, provide a detailed description of the available APIs or SDK for integration.
      • Command Set: For products that support command-based interaction, list the available commands with examples.
      • Drivers & Libraries: Any software drivers needed for operation with other hardware or operating systems.
      • Supported Platforms: Operating systems and hardware supported by the product (e.g., Linux, Windows, ARM).

  4. Communication Protocols

    • Purpose: Explain how the product communicates with other systems or networks.
    • Content:
      • Supported Protocols: Descriptions of serial, SPI, I2C, RF, or any other communication standards supported.
      • Data Formats: Definition of data packets, message framing, error-checking methods.
      • Configuration: How to configure baud rates, channels, and other protocol-related settings.
      • Protocol Diagrams: Flowcharts or timing diagrams to explain communication.

  5. Troubleshooting & FAQs

    • Purpose: Help users resolve common issues.
    • Content:
      • Troubleshooting Guide: A step-by-step guide to resolving hardware and software problems.
      • FAQs: Answers to common questions related to setup, usage, and maintenance.
      • Diagnostics: Description of onboard diagnostic tools or test points.
      • Error Codes: List of error codes or LED blink patterns and their meanings.

  6. Application Notes & Tutorials

    • Purpose: Provide detailed guides for specific applications or advanced usage.
    • Content:
      • Application Notes: Technical notes on specific use cases (e.g., telemetry system integration, sensor networks).
      • Project Tutorials: Guides for building projects with the product (e.g., connecting to sensors, building a data logger).
      • Design Considerations: Best practices for designing with the product in different environments (e.g., EMI, thermal management).

  7. Downloads

    • Purpose: Provide downloadable resources.
    • Content:
      • Datasheets: Full product datasheet in PDF form.
      • User Manuals: Comprehensive user guides.
      • Firmware: Latest firmware updates.
      • CAD Files: PCB layouts, 3D models, mechanical drawings.
      • Software Tools: Links to any configuration software or utilities.
      • API Reference: Complete API documentation.

  8. Compliance & Certifications

    • Purpose: Ensure users are aware of the certifications and standards the product complies with.
    • Content:
      • Regulatory Information: CE, FCC, RoHS, etc.
      • Environmental Certifications: Any eco-friendly certifications if applicable.
      • Test Reports: Electromagnetic compatibility (EMC) and other safety tests.

  9. Support

    • Purpose: Provide channels for users to seek help or get in touch.
    • Content:
      • Contact Us: Contact form or email addresses for support.
      • Forums: Links to online forums or communities for discussions.
      • Warranty Information: Details on warranty, repair, or return processes.
      • Live Support: If applicable, chat support or phone numbers.

  10. Additional Considerations

    • Search Bar: Include a search function for users to quickly find relevant information.
    • Version Control: For products that evolve over time, maintain separate pages for different firmware or hardware versions.
    • Glossary: Define technical terms and acronyms to aid understanding.