greenman100

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!

Sonicxtacy02

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.

__________________
03 Acura RSX Coupe
a K.I.S.S Flash, VB, and Autoit Programmer
HARDWARE PROGRESS: 90%[/////////-]
SKIN PROGRESS: 90%[/////////-]
Current Project: RRFusion, MovieTimes, RRMail and More!!! :)

greenman100

Okay, that's easy.

rgarjr

How about documentation of what those options on MDF do?

__________________
My carpc worklog

h3rk

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

greenman100

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.

greenman100

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.

jimp

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.

greenman100

true, sounds good.