CNC Circuit Mill/Manufacturing Instructions: Difference between revisions

From Open Source Ecology
Jump to navigation Jump to search
No edit summary
(Redirected page to CNC Machine)
 
(76 intermediate revisions by 3 users not shown)
Line 1: Line 1:
=Open-Source Documentation Organization=
#redirect [[CNC Machine]]
 
The following is an exploration.
 
The objective is to design an intuitive, modular, versatile documentation system for organizing open-source records.
 
First, what are the organizational tools available to us: hyperlink-able web pages, text, embedded media.
 
Second, we start.
 
Let us assume that we are in a general webpage such as the OSE wiki main page. At this point we can have text accompanied by a hyperlink to a particular GVCS machine, hereupon to be called '''Machine X'''.
 
Upon clicking the hyperlink we are redirected to to the '''Machine X''' webpage.
 
Should the manufacturing preparation (ex. bill of materials) be on a separate webpage than the manufacturing process (ex. instructionals)? Why do we put content on different webpages instead of everything on one page? One major reason is ease of navigation during usage and editing. A minor reason is memory size of webpage (while opening a large size webpage, significant processing can be wasted for information that is not relevant to the webpage inquiry).
 
Is combining the manufacturing preparation and process clearly better or worse for navigation than separation? What are the factors that affect ease of navigation? Complementary items are better suited to be together akin to how similar items can be grouped under a single category. As the manufacturing preparation and manufacturing process are both focused on clarifying the manufacturing of '''Machine X''', there seems to be a clear complementary characteristic. Nothing unique about this situation warrants deviation from this conclusion, hence I would assert that they both be put in one webpage; i find one webpage easier to edit as well.
 
On the other hand, the user's manual consists of usage and maintenance, which are also complementary to each other but clearly different from the manufacturing preparation and process.
 
Hence, the '''Machine X''' webpage should start with at least two hyperlinks, one going to the manufacturing preparation and process webpage ('''Manufacturing Instructions''') and the other going to the usage and maintenance webpage ('''User's Manual''').
 
Continuing the exploration to the manufacturing instructions, the "manufacturing preparation" can be titled under '''Tools and Materials''' whereas the "manufacturing process" can be titled under '''Steps'''.
 
The purpose of the "tools and materials" category is to provide a handy grouped megalist with which to source and ready all the tools and materials required for constructing '''Machine X''', along with the necessary summing of the total cost and column/row formatting. Because such formatting and summing are necessary functions, we would do well to go with a spreadsheet like Google spreadsheet. The organizational grouping method for this megalist is explained right above the actual spreadsheet below.
 
The purpose of the "steps" category is to provide a handy ordered set of steps for actually manufacturing '''Machine X''' once all the preparation has been established. Right now we ponder the 2 obvious choices, between using another spreadsheet or using the normal webpage format. For steps, embedded media is effective; because spreadsheets cannot easily handle embedded media, the intuitive path seems to be working within the normal webpage format. '''Steps''' is much more intricate than '''Tools and Materials''', hence additional hyperlinks to part fabrication and assembly webpages should be required for streamlining '''Steps'''.
 
=Tools and Materials=
 
'''1 - Spreadsheet'''
 
For a long list of items, grouped organization facilitates referencing and understanding.
 
The following list organizational system uses numeric grouping. Numeric grouping is more versatile than multiple dots or stars similar to how power 10 numbers relate to tally marks.
 
In numeric grouping, each item is assigned a number that represents the item's group priority.
 
Ex.
 
3 - Washers
 
Any number has a grouping effect that "underclasses" all higher numbers that are below the reference number.
 
Ex.
 
3 - Washers
 
4 - 1/2" ID
 
4 - 3/4" ID
 
...any item of number 4 or greater are hereupon underclassed by "3 - Washers"
 
Items of equal or lower number "undercut" the grouping effect of all higher numbers above the item of lower number.
 
Ex.
 
3 - Washers
 
4 - 1/2" ID, 1" OD
 
4 - 3/4" ID
 
3 - Red Wire
 
2 - 18 AWG
 
Examine the following.
 
Ex.
 
1 - Tools
 
2 - Soldering set
 
3 - Soldering Iron
 
3 - Solder, silver bearing
 
4 - 2mm diameter
 
4 - 4mm diameter
 
3 - Sponge
 
3 - Flux
 
2 - Hex Key Set
 
3 - 10mm
 
1 - Materials
 
2 - Alligator Clips
 
2 - Shrink Tubing
 
3 - 10-12AWG
 
3 - 16-22AWG
 
<html><iframe width='800' height='300' frameborder='0' src='
 
https://docs.google.com/spreadsheet/pub?hl=en_US&hl=en_US&key=0AlpsBarfpPkzdFk5aDY3dHM0eEhfZHNkWVppdV9EelE&output=html
 
'></iframe>
</html><br/>
 
'''1 - Edit'''
 
https://docs.google.com/spreadsheet/ccc?key=0AlpsBarfpPkzdFk5aDY3dHM0eEhfZHNkWVppdV9EelE
 
=Steps=

Latest revision as of 04:17, 26 June 2014

Redirect to:

Retrieved from "https://wiki.opensourceecology.org/index.php?title=CNC_Circuit_Mill/Manufacturing_Instructions&oldid=120890"