documentation

Hi all

I am currently working as a trainee (so yes, that I'm a student) in a company that has no knowledge or experience with the software and the trainees.

In my study, mechatronics, I learned to work with labview in a fundamental way. It was State Machines and models of base master-slave.

The program I created now, however, has a completely different layout. The program consists of 7 sons and 50 + Subvi.

The program works very well and has a very logical layout (flow)-. Anyone with minimal knowledge of labview can almost immediately see how the program works.

Because I'm an intern, I need to make a report. For previous software projects as State Machines, we used 'State Transition diagram (STD)' to explain the programs to the person reading the report.

Now, however, an STD do not apply here. This is because the program will have no interface, no use cases, not 'real' asserts and is fully automatic: it initializes then goes through something and even more until the power will be cut.

The only documentation I have currently software is flowcharts on the functioning of the software. It is, however, not enough.

Does anyone have experience doing this kind of reports, where readers will be teachers or other students and must be able to understand overall the work/page layout program.

And if so, how have you done this or is there a standard for this?

PS. I found this thing called UML, but I don't know if it applies actually to labview because UML focuses strongly on Classes that are not used very often in labview, (from what I've heard, correct me if I'm wrong).

Kind regards

Jesse Bax

Essentially, you create a "software design document" - this is a document that describes the overall function of the software and details how he is/has been implemented.

As a general rule, a document such as this could have the following sections (take a look at some of my previous documents - this is not an exhaustive list):

-Introduction

-Preview system: give an overview of the different hardware/software components and the purpose of this software and how it is designed to be used

-Architecture: an overview of the overall architecture of the program - the main functional components and how they interact with each other (for example queues/events).

-Design/production: write an article on each of the modules, showing how they work - that the States are etc. It is also good to mention assumptions/objectives/problems you had when you were writing the code - this helps another developer to get inside your head and understand the why you did it that way.

It's also a good idea to mention the requirements (e.g. version of LabVIEW, the additional toolboxes you have used, drivers required etc.) -This allows the developer to next work on your software without load with loads of missing dependencies etc..

You can also create a user manual that shows how to install, configure, and use the software - once again, a lot of screenshots and descriptions of what makes each button to the end user. For us, it is a separate document, but you might want to combine if it is only a small project.

There should be many diagrams (charts and state transition diagrams are good for this) and screenshots of the code with explanations. Of course, in reality the software changes over time for this level of documentation can become very laborious... (but is sometimes necessary!).

Of course, your LabVIEW code should also be well documented - many block diagram of comments, VI icons and descriptions of the VI!

Tags: NI Software

Similar Questions

  • Where can I find documentation for message filter

    Where can I find documentation on how to create message filters for * all * things that can be tested? The only use of examples of body, or object. I need to be able to test the Content-Transfer-Encoding.

    Almost all emails that I receive that are coded in base64 stuff is spam. How can I filter on:

    Content-Transfer-Encoding: base64
    Content-Disposition: attachment; filename = "proposal.pdf"

    JVBERi0xLjMNJeLjz9MNCjkgMCBvYmoNPDwvTGluZWFyaXplZCAxL0wgNjk4Ni9PIDExL0UgMzA1
    Ni9OIDEvVCA2NjkyL0ggWyA0NDggMTQ2XT4 + DWVuZG9iag0gICAgICAgICAgICAgICAgICAgICAg
    ...

    I tried selecting "Content-Transfer-Encoding" with the value "base64" but it does not work.

    I just tried:
    Content-Transfer-Encoding contains city-printable
    This only 2 items returned, which is much less than the expected result.

    added
    Body contains city-print
    and modified to match one of the following
    This value returned as many, but not all.

    based on these findings:
    Content-Transfer-Encoding contains base64
    I think that would test the first copy of this header, rather than those in the various sections MIME.

    Body contains Content-Transfer-Encoding: base64 would capture more.

    However, I use Thunderbird to capture junk spam control settings, so are not really the issue that you want to filter. Have you set up and trained your filter auto junk removal of these emails to junk.
    http://KB.mozillazine.org/Junk_Mail_Controls

  • Y has apps for Car Accident Documentation?

    I did some research on the "documentation" apps car accident and was not able to find much. I had a friend who did not have all the information they needed after getting into a Bender fender with someone else and now I'm careful. I know that I can put it in the Notes app, but I have so many things here, I'll probably lose. I found this one - https://www.davidazizipersonalinjury.com/car-accident-lawyer/iphone-app/ doing some research on Google, but I was wondering if there is something different.

    Is all the car accident documentation apps made by law firms of the injuries? Someone at - it other suggestions of an application that will allow me to quickly take a few pictures, get information on insurance and contact information? It would be great if there were than something built in maps of Apple.

    Thanks in advance.

    Try your insurance company. I had one in Europe of my insurance and I can use it and it sends all the information directly to the insurance company. Very convenient

  • Need for documentation on Modem commands

    Hello!

    I have a program to connect to a modem of special data. The program requires an initialization as string: ATZ ^ MATS0 = 1 S = 64 15 ^ M.
    Toshiba modem does not work with to the commands that I use for several other modems (wavecom, elster, devolo,...).

    Now I need a documentation at the controls for the toshiba modem create my own initialization string.

    I thank very you much in advance!

    Ludger

    Hello

    I doubt that anyone here would be able to provide this information.
    First you didn t show all the details about your laptop and on the other hand I m not very good if this info has been published anywhere.
    What about manuel? Did you find anything in the manual?

  • Documentation booklet

    I'm trying to learn how the function keys on the booklet. All links to related documentation on the Toshiba Support Site, AskIris, have errors and a "Sorry" message

    Naturally, the keyboards are not documented in the User Guide.

    Hello

    It will be interesting to know what book you have.

  • Portege Z10T - documentation of command line for tinstallwb.exe (PVAT)

    Does anyone have any documentation on the command line for tinstallwb.exe, or know the switch to enter these?

    I have to do some recording during the installation.

    We are the Z10t assessment and want to install the package Toshiba value added via SCCM during our deployment task sequence. I did the same thing for the Z930 successfully.

    I use the latest version (1.6.0035.6406) of the PVAT.

    After having extracted the contents of tc30573300f.exe, the command I use is 'tinstallwb.exe s - sms. While this works in my wrapper for vbscript, it fails during the actual deployment. If I could start recording, I could see what goes wrong.

    I tried to install just \TVAP\TOSHIBA package.msi before value added, but even if that moved successfully, these sheets never appear when you press the Fn keys.

    Any ideas?

    Unfortunately, this isn t available documentation.
    I also found advice to install the PPV from the command line

    But the package contains other files such as setup.exe or install.exe exe
    Have you tested the installation, the use of these files?

  • I'm looking for documentation on the Firefox command line arguments.

    I'm looking for documentation on the Firefox command line arguments. I use Ubuntu.

    http://KB.mozillazine.org/Command_line_arguments

    This doesn't seem to be what you're looking for?

  • The official Server documentation / Guide - where?

    Server updated again and I can see a lot of new features - brilliant!  Classroom looks promising and there are a some new boxes appeared.

    My question is, where would I go to get some official "how-to" documentation on these new features?  Help server section seems fairly generic and does not show these new features.

    Have I missed something obvious here?

    Thank you

    Have you looked at the IT / MDM of the site for education?  There are some iBooks and guides listed here:

    http://www.Apple.com/education/it/

  • Ink cartridge error: refer to the Documentation of the printer

    I've scoured the forums for a solution to my problem and come up with nothing. I have a HP Photosmart C5250 all in one connected via USB to a Dell Inspiron under Windows 7 64-bit. I tried the reset suggested several times with no ink cartridges does not. I use HP brand ink cartridges. In its current form, I have no need to print anything but I need to scan something into my computer and the error message prevents me from doing anything. I've lived the documentation several times and he told me something that I already have his not know or is not already done.

    Hey SGibbons, lets try the following steps:

    1. without turning off the product, disconnect the USB cable (if connected like that) from the back of the product

    2. remove the cartridges from the product. Wait that a message to insert the cartridges. If you don't see a message in a few minutes, go to the next Ste.

    3. disconnect the power cord from the back of the product. Wait 60 seconds

    4 reconnect the power cord. If the product does not automatically turn on, press the power button

    5 reinsert the cartridges and close the doors on the product. If you are prompted to print a calibration page, do it.  If you disconnected the USB cable, plug it back in the back of the product

    6. try to reprint

    I would like to know if that helps at all. If it does not provide new details or error messages and we'll go from there.

    Thank you

    Sean

  • Pavilion 500-130ed documentation, specifically audio hardware

    Hi all

    I own a HP Pavilion 500-130ed (since Dec 2013), with Windows 8, 64-bit.

    So far, I am very satisfied with its performance, but the documentation (on the material of the HP Pavilion 500-130ed) is rather sparse. The specifications refer to 'High Definition Audio 7.1'.

    What I don't understand is how can I use 6 channels, since there are IN, a MIC IN and LINE OUTPUT (a blue, green and pink connector) on the back and a microphone and speakers to the front connector.

    Anyone can shed light on this issue? Is it possible to actually make the 7.1 configuration possible? (For people who are more technical than me; The PNP device ID is HDAUDIO\FUNC_01 & VEN_111D & DEV_76F3 & SUBSYS_103C2AF7 & REV_1002\4 & 2DCAAFFF & 0 & 0001)

    See you soon,.

    Sando

    Sando, welcome to the forum.

    According to the specifications, the built-in sound is 5.1.  Look at the section titled "Sound/Audio".  Here's a guide to help you with your problem.  It's for Win 7, but I do not think that the BONE has made a difference.  Read it carefully and it should help you.

    Please click on "BRAVO", if I helped you and click on "Accept as Solution" If your problem is resolved.

  • Technical documentation to disassemble a Portege R500?

    Hello

    where can I find technical documentation to disassemble a Portege R500?

    Thank you

    Post edited by: T4nG

    Hello

    Don t think you will be able to find this teaching
    As much as I know page Toshiba does not provide these documentations, and I think that these manuals are not created for public use.

    In my opinion only a certified partner have received access to such books and if you ve a few hardware issues with your laptop technician ASP is your contact.

    Welcome them

  • C5280: "REFER TO PRINTER DOCUMENTATION".

    My black print cartridge ran out of ink, I went to a local store and filled...
    But now that im putting in the cartridge, the warningsign of the printer is flashing and display saying "Refer to printer documentation"... I don't get it... it must have something to do with the cartridge since it's the only thing that changed... but it's ALWAYS the same cartridge? did not get a new or a wrong or no matter what... Please help... tried everything, put in, turing, out, reconnected machince etc... nothing works... printer is just locked...

    Replace the cartridge with a genuine HP cartridge to see if it solves your problem. If so, your refill cartridge has been damage and you need to get a refund.

  • J4580 print cartridge problem: [Tri-Color] refer to the device Documentation

    Well, I'm starting to feel like I knew better, buy another HP printer after dismal luck with two all-in-one before.

    My J4580 already gives me headaches after only 6 or more months of use.

    The unit refuses to print, declaring "print cartridge problem: [Tri-Color] refer to device Documentation to troubleshoot."  Nothing in the help documentation.  The Habs is always 90% full.  Sometimes pulling the Habs and placing back in crazy wil it restarting.  When it restarts, it prints perfectly.

    I tried the ubiquitous "clean the contacts" and other instructions help generic that I saw, but those who were without help.  The "Solution Center (Yes, good)" appears and all ithas is a link to buy more ink (!).

    Someone has an idea?  I'm about to throw it through the window of stores office, given that I can't throw it out the window of HP.

    Thank you!

    Yes * I know * and I'm sorry that I forgot to come back here.  I had a major system crash and I had to reinstall a lot of drivers for my multimedia player, GPS, and printer (!).  As this occurs, the device did not return this error - touch wood.

  • I need documentation of field replaceable unit for Satellite L100-108

    Hello, I need documentation of field replaceable for Toshiba Satellite L100-108 unit because I want to disassemble the screen.
    Can you help me?

    Thank you.

    Srca sorry but manuals Maintenance is not a public document. It is created for the service only.
    Sorry :(

  • Help please! Documentation and data returned 22 gb

    unexpectedly, I was warned that I have maxed out 64 GB of my phone. I didn't know that 22 GB of it was taken by 'the documentation and data' I have no idea what is it... and may seem to solve this problem.

    Delete what you don't need.

  • MacBook Pro 10.9.5... documented can one scanned be edited? If so, how?

    MacBook Pro 10.9.5... documented can one scanned be edited? If so, how?

    Images can be changed with an image editor, such as Acorn Flying meat or Adobe Photoshop or other tools.   Some scans documents can also be converted to a usable state, via the optical characters (OCR) module text reader software.  Here's a related question, with a few links to available OCR tools...

Maybe you are looking for