LabVIEW Embedded Development Module Target Distribution Guide Manual

LabVIEW Embedded Development Module Target Distribution Guide Manual
Pages 35
Views 299
Downloads : 3 times
PDF Size : 290.7 KiB

Summary of Contents

LabVIEW Embedded Development Module Target Distribution Guide Manual

  • Chapter 5Adding Target-Specific Documentation 1,Target Distribution 1,Guide5-8ni.comDocumenting Concepts and TasksConceptual content gives end users background information they might need to use your target. Task-based information gives end users step-by-step instructions about how to use your target in LabVIEW. Most LabVIEW products contain the majority of non-reference content in help. LabVIEW users are accustomed to looking in help for information, and combining VI reference with conceptual and task-based information in a compiled help file allows end users to simultaneously search reference and non-reference content.While you cannot create non-reference content directly in LabVIEW, many HTML editors and help compilers exist so you can create non-reference content. If you plan on selling integrated target support for LabVIEW, you might consider outsourcing the documentation if you do not have access to technical writers.TipIf your target is an evaluation board, consider including documentation that explains how to create a custom design from the same microcontroller. For example, you might explain how to edit a linker definition file.Putting Your CHM Help File in the LabVIEW Help MenuIf you create a compiled help file (.chm) for your target, you can include it in the LabVIEW Help menu by installing the .chm file in the labview\help directory. If you install the .chm file in the labview\help directory, end users can launch your help file by selecting Help»<.chm name> in LabVIEW.Printed and PDF ManualsInclude a PDF version of any printed manuals you create. You also can create documents that are available only in PDF format.Readme FilesYou can use readme files for last-minute information and known issues. If you are not reselling LabVIEW and your target, a readme file might be sufficient documentation. LabVIEW uses HTML format for readme files. You also can use text format.