Review new feature description with tech writer

ni / niveristand-embedded-data-logger-custom-device

VeriStand embedded data logger custom device

MIT License

3 stars 10 forks source link

Review new feature description with tech writer #43

Closed oscarfonloz closed 3 years ago

oscarfonloz commented 3 years ago

[x] This contribution adheres to CONTRIBUTING.md.

TODO: Check the above box with an 'x' indicating you've read and followed CONTRIBUTING.md.

What does this Pull Request accomplish?

This PR edits the label, description and tip strip of the feature that appends TDMS waveform properties to channels

Why should this Pull Request be merged?

I reviewed the information we're providing to users with our technical writer to ensure it makes sense for customers

What testing has been done?

No functional changes

niveristand-diff-bot commented 3 years ago

Bleep bloop!

LabVIEW Diff Robot here with some diffs served up hot for your pull request.

Notice something funny? Help fix me on my GitHub repo.

Embedded Data Logger System Explorer.lvlib--File Page.vi.png

![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/NI/niveristand-embedded-data-logger-custom-device/PR-43/2021-02-25/14%3A12%3A32/Embedded%20Data%20Logger%20System%20Explorer.lvlib--File%20Page.vi.png)

oscarfonloz commented 3 years ago

We decided against "Append TDMS Waveform Properties" because the tech writer asked me: "and your customers know what those are, or what that is?", and I was like... "ehhh.... no". Hence, we prefer to document the effects of the checkbox, rather to the technicality behind it. However, I did leave the technical details in the Control's description to ensure we still expose those somewhere :)