Template:Product Version: Difference between revisions
No edit summary |
|||
Line 27: | Line 27: | ||
This document provides an introduction for this product version. | This document provides an introduction for this product version. | ||
For a summary and easy access | For a summary and easy access of the documentation for this product version, see [insert link to the documentation summary for this product version. It should be based on the template found [[Template:Devtemplate|here]]]. | ||
=Overview= | =Overview= |
Revision as of 08:09, 9 January 2020
HOW TO USE THIS TEMPLATE:
This a template for the Introduction wiki-page for a new version of an existing OSE product or the first version of an OSE product that does not yet exist.
Name your new product version/introduction page 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 Introduction page, enter its name (according to the format 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 Name vYY.MM" on this wiki!
3. Go back to this template and Press Edit.
4. Copy the contents.
5. Go back to your newly created page.
6. Paste the template contents into your newly created 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.
This document provides an introduction for this product version.
For a summary and easy access of the documentation for this product version, see [insert link to the documentation summary for this product version. It should be based on the template found here].
Overview
Replace this text with a short description of the product.
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.
Other versions
To find other versions of this product, go back to the main product page:
[insert link to the product page]
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
|
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 "See" followed by an internal link to the OSE wiki page for the BOM of this version.
CAD
Replace this text with "See" followed by an internal link to the OSE wiki page for the CAD for this product.
Communications
TBD.
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.
Q&A, info, comments
Q1: State question 1 here.
A1: State the answer to question 1 here.
Q2: State question 2 here.
A2: State the answer to question 2 here.
I1: Add piece of information 1 here.
I2: Add peice of information 2 here.
C1: Add comment 1 here.
See also
Insert relevant internal links to OSE wiki pages.
External links
Insert external links here.