Template:Product Version: Difference between revisions

From Open Source Ecology
Jump to navigation Jump to search
No edit summary
No edit summary
 
(45 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<div style="float:center;">
HOW TO USE THIS TEMPLATE:
{| class="wikitable" style="{{{float|float:right;}}} width:15em; margin-left:0; margin-right:0;"
|-
! [[Development Guide|Development Guide]]
|-
|
* [[Collaboration Resources]]
* [[Design Resources]]
* [[Suppliers]]
* [[Action Resources]]
* [[Documentation Resources]]


|}<noinclude>
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''.
{{clear}}
 
</div>
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.
 
<span style="color:red">This line and those above shall be deleted after you have implemented this template for a new development page.</span>
 
=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=
<span style="color:red">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.</span>
 
{{Product Ecology
|Product={{Power Cube}}
 
|From=
*[[Gasoline]]
*[[Biodiesel]]
*{{Steam Engine}}
*{{Steam Generator}}
*{{Gasifier Burner}}
*{{Pelletizer}}
 
|Uses=
*[[Biofuel]]
*[[Biomass]]
*[[Tractor]]
*[[QA Plate]]
 
|Creates=
*[[Power]]
*[[Hydraulic]]
 
|Enables=
*{{Tractor}}
*{{CEB Press}}
*{{Bulldozer}}
*{{MicroTrac}}
*{{Car}}
*{{Truck}}
*{{Hammermill}}
*{{Drill Press}}
*{{Lathe}}
*{{Welder}}
*{{Ironworker}}
*{{Sawmill}}
*{{Induction Furnace}}
*{{Torch Table}}
 
|Components=
*Frame
*Engine
*Coupler
*[[Metal]]
*Hydraulic Tank
*Gas Tank
*[[Hydraulic Pump]]
*[[Hydraulic Hoses]]
}}
 
=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.

Latest revision as of 13:53, 10 January 2020

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:

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.

Product Ecology
Power Cube Power Cube
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.

Retrieved from "https://wiki.opensourceecology.org/index.php?title=Template:Product_Version&oldid=208531"