Results 1 to 9 of 9

Thread: Documentation - What do you want?

  1. #1
    Fusion Brain Creator
    Join Date
    Mar 2005
    Posts
    2,221

    Documentation - What do you want?

    I am finishing up the following:

    Fusion Brain Reloaded
    Servo Control
    Solid State Relays
    Analog Out

    Nick is finishing up the following
    MDX main program and Configurator

    Once we finish, we will move to documentation.

    This is your chance to give input to make the best possible documentation.

    Are you looking for:
    Fusion-hosted Wikipedia entries
    A PDF file
    A MS Word file
    Forum posts

    tutorial style or feature style?

    etc etc...


    thanks!

  2. #2
    Mo' Programming Mo' Problems
    Auto Apps:loading...
    Sonicxtacy02's Avatar
    Join Date
    Sep 2004
    Location
    Woodbridge, VA
    Posts
    8,114
    Blog Entries
    49
    well i spent about an hour today trying to figure out how to hook up a SPST relay to the thing. A simple diagram for noobs would help with that. Also, the images in your hardware manual are out of date (at least with the brain i purchased) that led to quite a bit of confusion.
    mp3Car.com Senior Tech Blogger (Want a product reviewed? Contact me.)
    Find my plugins on the MP3Car App Store!
    Follow Me on Twitter or Facebook
    Live mp3Car Facebook Chat

  3. #3
    Fusion Brain Creator
    Join Date
    Mar 2005
    Posts
    2,221
    Okay, that's easy.

  4. #4
    Variable Bitrate
    Join Date
    Jan 2008
    Location
    Southern Calif
    Posts
    423
    How about documentation of what those options on MDF do?

  5. #5
    FLAC
    Join Date
    Oct 2006
    Location
    Las Vegas
    Posts
    1,286
    How about a pdf something like the following?

    Chapter1: Introduction
    show the hardware, define the pins with short explainations.
    Chapter2: Installing drivers and software.
    -pretty much what you have in tutorials
    -add a procedure to start the software, find the brain using the search function, and running a pre-made brain-test skin to test digital outputs, and show voltages for analog inputs. Just to make sure it works right.
    Chapter3: Makeing the physical connections.
    Inputs:
    -detailed pics and diagrams for connecting each of the supported sensors.
    Outputs:
    -simple relay connection (I know, how can it be any simpler, but people may need help there too).
    -specifications for outputs. (what if I want to drive a transistor? a led? a 100HP DC motor?jk)
    -specifications for digital inputs.
    Chapter4:Software introduction
    -Explain the big picture:
    -relationship between configurator and mdx software.
    Chapter5: Detailed MDX description:
    -Main page button/frame definitions and functions.
    -grahpic editor and subform,
    -button/frame definiton and functions
    -property form for each type of element:
    -field definitions and what they do.(or reference a xml language section further on)
    -specify what kind of images to use, maybe walk through 1 of each type.
    -root logic section:
    -button/frame/tab definition and functions
    -customframeform button/frame definitions
    -module definitions and uses (maybe put this in a later language reference section)
    Then statemement page.
    -button/frame/field definitions and method of use (maybe put this in a later language reference section)
    -how to create a custom module.
    Chapter6: Fusion XML skin language section
    just go through each part of the skin file, explain the fields and their properties, what each property is and what it's value can be. My suggestion is to build a skin that has an example of everything, maybe a couple of each with different property values selected.
    Chapter7:
    functional examples based on application

  6. #6
    Fusion Brain Creator
    Join Date
    Mar 2005
    Posts
    2,221
    Quote Originally Posted by rgarjr View Post
    How about documentation of what those options on MDF do?
    MDF?

    If you mean MDX, that's what we're doing.

    We just have no experience writing documentation, so we're looking for guidance in what the end-user prefers in terms of style.

  7. #7
    Fusion Brain Creator
    Join Date
    Mar 2005
    Posts
    2,221
    We will use the following as a template, and edit it as more users post.



    Chapter1: Introduction

    show the hardware, define the pins with short explanations.
    Chapter2: Installing drivers and software.
    -pretty much what you have in tutorials
    -add a procedure to start the software, find the brain using the search function, and running a pre-made brain-test skin to test digital outputs, and show voltages for analog inputs. Just to make sure it works right.
    Chapter3: Making the physical connections.
    Inputs:
    -detailed pics and diagrams for connecting each of the supported sensors.
    Outputs:
    -simple relay connection (I know, how can it be any simpler, but people may need help there too).
    Chapter4:Software introduction
    -Explain the big picture:
    -relationship between configurator and mdx software.
    Chapter5: Detailed MDX description:
    -Main page button/frame definitions and functions.
    -grahpic editor and subform,
    -button/frame definiton and functions
    -property form for each type of element:
    -field definitions and what they do.(or reference a xml language section further on)
    -specify what kind of images to use, maybe walk through 1 of each type.
    -root logic section:
    -button/frame/tab definition and functions
    -customframeform button/frame definitions
    -module definitions and uses (maybe put this in a later language reference section)
    Then statemement page.
    -button/frame/field definitions and method of use (maybe put this in a later language reference section)
    -how to create a custom module.
    Chapter6: Fusion XML skin language section
    just go through each part of the skin file, explain the fields and their properties, what each property is and what it's value can be. My suggestion is to build a skin that has an example of everything, maybe a couple of each with different property values selected.
    Chapter7:
    functional examples based on application

    Appendix A: Specifications
    -specifications for outputs. (what if I want to drive a transistor? a led? a 100HP DC motor?jk)
    -specifications for digital inputs.

  8. #8
    Constant Bitrate
    Join Date
    Jan 2008
    Location
    Texas
    Posts
    151
    I am not particular as to what format the documentation is in, or for that matter what you cover in what order, my only request is that you get all the documentation in one place, weather it be here on the forums, at your store website, or in wikipedia, or wherever, or even all of the above, just so it is all in at least one place and not spread out in multiple locations. Just makes searching for answers easier, and would probably cut down on questions you repeatedly answer. other than that I would think you would want to make it in a format that is easiest for you to update as changes are needed.

  9. #9
    Fusion Brain Creator
    Join Date
    Mar 2005
    Posts
    2,221
    true, sounds good.

Similar Threads

  1. Documentation - Installing And Configuring Drivers - Version 2:WindowsXP
    By greenman100 in forum FB Documentation and Tutorials
    Replies: 0
    Last Post: 02-29-2008, 12:31 PM
  2. Xenarc 700IDT - questions: Power? Documentation?
    By riptex in forum LCD/Display
    Replies: 1
    Last Post: 12-06-2007, 05:35 PM
  3. Ordered complete system from Mp3car and no documentation?
    By ABTsportsline in forum MP3Car Products - store.mp3car.com
    Replies: 8
    Last Post: 09-14-2007, 12:53 AM
  4. Documentation
    By SOS in forum CF FAQs
    Replies: 1
    Last Post: 08-02-2006, 04:25 PM
  5. SDK/Skin documentation?
    By Pishaa in forum FreeDrive
    Replies: 3
    Last Post: 02-23-2006, 09:18 AM

Bookmarks

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •