I am constantly working to ensure that our documentation is up-to-date, accurately reflecting the latest advancements in the electronics used in our products. As part of this commitment, I recently revised the Meredith document to reflect the recent updates to our Internal Breakout board. What is it? This document presents the most basic Nu multichannel setup. You can use that guide as a use-case reference on how to install and integrate a Nu Multi Pickup, along with other pickups. Now, the document is divided into two parts:
- Meredith version 2: https://www.cycfi.com/assets/Meredith-2.pdf
- Internal Breakout version 2.6: https://www.cycfi.com/assets/Internal-Breakout-2.6.pdf
I invest a substantial amount of time in documentation. This task often involves the challenge of tailoring content for a diverse audience with varying levels of technical expertise. To simplify things, I operate on the assumption that our product’s target audience possesses a degree of technical proficiency that enables them to grasp the material presented. However, I recognize that my assumption may be wrong, and if you find the documentation to be overly technical or difficult to understand, please don’t hesitate to let me know. I am committed to continuously improving our documentation to ensure it is as user-friendly and accessible as possible.
For example, the wiring diagram above is likely straightforward for most people to grasp. However, given my engineering background, I, personally, find schematic diagrams easier to read. Consequently, in specific sections, particularly those covering advanced topics, I adjust the intended audience to individuals with a solid understanding of electronics, assuming they can comfortably navigate technical documentation.
Tell me what you think.