Development Guide
HOW TO USE THIS TEMPLATE:
Name your new product version correctly: Product designation followed by "_v" followed by the last two digits of the current year followed by .two digits indicating current month.
Name example: Steam engine_v21.05
where "21" indicates the year 2021 and "05" indicates the month of May.
1. To create your product version page, enter its name (according to the format described above) in the search bar in the top right corner and press enter or click the search icon.
2. On the results-page, click the link found within the sentence Create the page "Product Designation_vYY.MM" on this wiki!
3. Go back to this template and Press Edit.
4. Copy the contents.
5. Go back to your product version page.
6. Paste the template contents into your product version page.
Now you can start adding contents. If appropriate, headings provided in this template can be modified, deleted or replaced.
This line and those above shall be deleted after you have implemented this template for a new development page.
Overview
For other versions of this product, see the Product page: [Insert link to the product page here. This template can be used for product pages: Template:Product]
Replace this text with a brief description of the product version. Feel free to include a picture (see Wiki instructions to learn how to upload files).
Status
This project is in stage 1 of 5; Design.
1. Design
2. Planning
3. Prototype
4. Almost done
5. Full Release
Replications
No replications so far.
The following format can be used to reference a replication:
[Start date YYYY-MM-DD, Location, Product version, Link to a page showing some documentation of the replication process or results]
Documentation
Replace this text with a DevTemplate. A DevTemplate is a table linking to the necessary documentation for the product version. It can be created in two ways:
- embedded as a Google sheet, see Development_Spreadsheet_Template or
- insterted as a Wiki-based table, see Template:Devtemplate.
Product ecology
The product ecology shown below is from the Power Cube page and merely serves as an example. Each product has its own context in the product ecology. Delete this text and modify the internal links in the product ecology table below so that this product ecology section is appropriate for the product/version you are describing.
| From | Uses | Creates | Enables |
|---|---|---|---|
Components
|
|
Planning
No concrete plan so far (consider using Scrumy or a Critical path.)
Details
Replace this text with more detailed information about the product.
Working principle
Replace this text with a clear description of the product's working principle.
Safety considerations
Replace this text by listing safety considerations.
BOM
Replace this text with a BOM (Bill of Materials). To learn how to make a BOM, see How_to_Make_a_BOM.
CAD
Replace this text with a Part Library. Go to Part_Library_Template to see what a Part Library should look like.
Bugs
No bugs identified yet.
Communications
See the Discussion tab for general communication regarding this product version.
Meeting logs
Replace this text with internal links to OSE wiki pages for meeting logs related to this version of the product.
Active team members
See the meeting log for active team members.
See also
Insert relevant internal links to OSE wiki pages.
External links
Insert external links here.
Steps to Success - Hardware
On Development
It's either figuring out a new concept, setting dimensions/details for a new technology, or pondering how to make something.
Order your projects well- do you have the right tools? Get some first to avoid transition losses due to "darn, we need to order that". Do you have the right software? Set it up so that you avoid timesinking into learning it half-way through a project.
Before you start a project, intend to finish it. Prepare well so that each step is straightforward.
Working with others? Set up the communication channels, work out the finances, be clear and detailed to avoid misunderstandings.
Designs frequently use the same concepts over and over again. Record these concepts and make them easy to navigate, then attach info about design considerations and associated mathematics.
Getting and using great design software can be a hassle. If possible, try using software that is accessible to others for the collaborative access boost.
On Suppliers
Avoid spending too much time with broad search bars. There's a finite number of great suppliers applicable to your area- find them to focus your navigation scope.
Make a hyperlink list of reliable suppliers that stock well and ship fast. Be sure to categorize the list for easy navigation.
Get tool and material sourcing to a pow-pow-done straightforwardness.
From design to execution. So the workshop has a bunch of tools and a bunch of materials all organized in some way. Now, how to make the design? Safety first- accessible equipment and warnings! Then proper signs, effective organization, instructionals and especially first-hand experience.
Using any part of the workshop should eventually become pow-pow-done straightforward.
For documentation, keep things clear and concise. Avoid long strings of hyperlinks. Make navigation simple.
On Concept into Details into Execution
Grasping the concept of a cup is easy enough. But try adding dimensions and you'll need math equations about human hand ergonomics. Even past dimensions, how to get the right tools and materials and how to know the exact techniques for actually doing it... crippling.
Fortunately, a lot of tools should already be in the workshop and the material supplier list should easily handle the rest of the sourcing. Excellent design resources will handle the itty-bitty details. Finally, a well-developed, well-maintained workshop with accessible use information will handle the rest. Everything will become ridiculously simple- eventually.