diff --git a/.github/workflows/gitbuilding.yml b/.github/workflows/gitbuilding.yml new file mode 100644 index 0000000..8ae3ec1 --- /dev/null +++ b/.github/workflows/gitbuilding.yml @@ -0,0 +1,26 @@ + +name: Deploy Gitbuilding Project to Github Pages + +on: [push] + +jobs: + build_and_deploy: + runs-on: ubuntu-20.04 + steps: + - uses: actions/checkout@v2 + - name: Install Python 3 + uses: actions/setup-python@v1 + with: + python-version: "3.7" + - name: Build + run: | + pip install gitbuilding + gitbuilding build-html + - name: Deploy + uses: JamesIves/github-pages-deploy-action@3.7.1 + with: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + BRANCH: gh-pages + FOLDER: _site/ + # Automatically remove deleted files from the deploy branch + CLEAN: true diff --git a/10_Ideation/README_minimal.md b/10_Ideation/README_minimal.md new file mode 100644 index 0000000..9047519 --- /dev/null +++ b/10_Ideation/README_minimal.md @@ -0,0 +1,32 @@ +# My research hardware project name + +- development stage: idea generation +- subject area/type of hardware +- prerequisite: who is this documentation made for + +## Vision and motivation + +This paragraph explains the ultimate goal of the project, its specificity and main objectives. + +Please also indicates the problem this project aims at solving + +## Community and Contributions +This section explains who is behind the project. + +### List of team members / contributors + +### Who could contribute + +### Communication channel, how to contribute + +## License and rights + +## Funding information + +- Sponsors and funding: + +- Future funding opportunities: + +> Note: This was created using the (minimal) template for research hardware project, it is meant to be used at the ideation stage of the project, and be later expanded by adding files and folders coming from additional template. +> A [checklist](checklist.md) might have been used to organise this expansion the repository which may be facilitated by the use of the Gitbuilding open source software. diff --git a/20_needs_analysis/01_community/01_guidelines.md b/20_needs_analysis/01_community/01_guidelines.md new file mode 100644 index 0000000..e69de29 diff --git a/20_needs_analysis/01_community/02_coc.md b/20_needs_analysis/01_community/02_coc.md new file mode 100644 index 0000000..e69de29 diff --git a/20_needs_analysis/02_product_dvt/01_hardwareoverview.md b/20_needs_analysis/02_product_dvt/01_hardwareoverview.md new file mode 100644 index 0000000..546ae49 --- /dev/null +++ b/20_needs_analysis/02_product_dvt/01_hardwareoverview.md @@ -0,0 +1,6 @@ +## requirements + +## constrains + +## capability + diff --git a/20_needs_analysis/02_product_dvt/02_user_analysis.md b/20_needs_analysis/02_product_dvt/02_user_analysis.md new file mode 100644 index 0000000..1923ec5 --- /dev/null +++ b/20_needs_analysis/02_product_dvt/02_user_analysis.md @@ -0,0 +1,6 @@ +## target groups (who will use the product) + + +## External interfaces (how will they use the product) + +## skills needed to use \ No newline at end of file diff --git a/20_needs_analysis/02_product_dvt/03_functional_model.md b/20_needs_analysis/02_product_dvt/03_functional_model.md new file mode 100644 index 0000000..e69de29 diff --git a/20_needs_analysis/02_product_dvt/04_behavioralmodel.md b/20_needs_analysis/02_product_dvt/04_behavioralmodel.md new file mode 100644 index 0000000..b8f4dca --- /dev/null +++ b/20_needs_analysis/02_product_dvt/04_behavioralmodel.md @@ -0,0 +1 @@ +## Modelling tool list \ No newline at end of file diff --git a/20_needs_analysis/03_project_history/01_changelog.md b/20_needs_analysis/03_project_history/01_changelog.md new file mode 100644 index 0000000..e69de29 diff --git a/20_needs_analysis/README_needs_add.md b/20_needs_analysis/README_needs_add.md new file mode 100644 index 0000000..a3b7328 --- /dev/null +++ b/20_needs_analysis/README_needs_add.md @@ -0,0 +1,43 @@ +# My research hardware project name + +- development stage: needs analysis + + +> To Add before "## Community and Contributions" + +## Problem description + +## Roadmap +This paragraph explains briefly the history of the project and the future milestones and time plan. + +### Project history summary + +### Future work + +> To Add inside "## Community and Contributions" + +## Community and Contributions + +### work culture + +Summary + +- [guidelines](01_community/guidelines.md) +- [Code of conduct](01_community/coc.md) + +> To Add at the end: + +## Administrative information + +- *ethics statement (human/animal use or Informed Consent Statement)* +- *competing interest* + +## Documentation structure + +This readme contains the first level of information. +in +- 01_community are saved our detailed documentation about the community practices +- 02_product_dvt you will find high level analysis of the hardware design like the list or requirements and user analysis +- 03_project_history you will find information about past decisions in the project + + diff --git a/30_concept_dvt/02_product_dvt/01_hardwareoverview_add.md b/30_concept_dvt/02_product_dvt/01_hardwareoverview_add.md new file mode 100644 index 0000000..d38eb61 --- /dev/null +++ b/30_concept_dvt/02_product_dvt/01_hardwareoverview_add.md @@ -0,0 +1,11 @@ +> add at the beginning + +## foreseen cost (money and time) + +> add at the end + +## use cases and application + +## reuse possibilities + +## architectural structure diff --git a/30_concept_dvt/02_product_dvt/03_functional_model.md b/30_concept_dvt/02_product_dvt/03_functional_model.md new file mode 100644 index 0000000..e69de29 diff --git a/30_concept_dvt/02_product_dvt/04_behavioralmodel.md b/30_concept_dvt/02_product_dvt/04_behavioralmodel.md new file mode 100644 index 0000000..b8f4dca --- /dev/null +++ b/30_concept_dvt/02_product_dvt/04_behavioralmodel.md @@ -0,0 +1 @@ +## Modelling tool list \ No newline at end of file diff --git a/30_concept_dvt/02_product_dvt/05_similarprojects.md b/30_concept_dvt/02_product_dvt/05_similarprojects.md new file mode 100644 index 0000000..e69de29 diff --git a/30_concept_dvt/03_project_history/02_release_note.md b/30_concept_dvt/03_project_history/02_release_note.md new file mode 100644 index 0000000..e69de29 diff --git a/30_concept_dvt/03_project_history/03_design_choices.md b/30_concept_dvt/03_project_history/03_design_choices.md new file mode 100644 index 0000000..e69de29 diff --git a/30_concept_dvt/README_concept_add.md b/30_concept_dvt/README_concept_add.md new file mode 100644 index 0000000..a7c1b37 --- /dev/null +++ b/30_concept_dvt/README_concept_add.md @@ -0,0 +1,18 @@ +# My research hardware project name + +- development stage: Concept development + + + +> To Add before "## Roadmap" or before "## Problem description" + +## dependencies +indicate and cite projects this project is built on +For the software part, indicate the main component, use a dependency.txt files in the software folder when needed. + +##software used for development + +> to add at the end + +## conclusions +summary of main results obtained and discussion that happened so far \ No newline at end of file diff --git a/Futuresteps/product-design/Product_design_main_info.md b/Futuresteps/product-design/Product_design_main_info.md new file mode 100644 index 0000000..5488641 --- /dev/null +++ b/Futuresteps/product-design/Product_design_main_info.md @@ -0,0 +1,19 @@ +## Bill of material + +## material characteristics + +## electrical design + +## firmware/Software: Documentation of different parts + +## Manufacturing instructions + +- skills +- tools +- link to instructions + +## Assembly instructions + +- skills +- tools +- link to instructions \ No newline at end of file diff --git a/README.md b/README.md index 7f44ab6..aee2790 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,67 @@ -# My research hardware project title +# Vision: a template for OSH projects -## Vision +In this repository, we are building templates for elements of an open source hardware project. +The aim is to facilitate the work of designers, helping them to easily create the documentation at the right time. -This paragraph explains the ultimate goal of the project, its specificity and main objectives. +# How to use this template -## Community and authors +This repository has one folder for each steps in the hardware projects, including elements that may or should be added to the documentation, and a checklist is provided to be able to follow the process. +The documenter may simply start by coping the 01_ideation folder, and change content where asked. +When finised, the documenter can go to the next step, copying files and adding elements to the readme, the checklist will help them find elements they want to add. +It is good practice to review the documentation in the team at each step. +One can use forks (when one is using a Git forge), if one want to go forward before the review of the team. -This section explains who is behind the project. +> *Example*: Max has a first prototype already. +> He starts its documentation with the idea description, add the analysis of needs, then the concept development files. +> Finally, he is adding the product documentation related to its prototype. +> By asking for feedback along the process, Max did realize the ideation documentation is extremely helpful to present the project, especially outside his first collaborators circle and more people showed interest in the project. +> By making some requirement more explicit, Max could derive specific needs and therefore specific hardware functionalities the first prototype is lacking, Max hopes to find better solutions in the next prototype iteration. +> One year later, Max is leaving the project, but the project still lives as new maintainers with the same vision are developing it further. -## Related projects +# Project history and rational -This section should try to summarise other projects related to the vision, why there is a need for a new project. It is recommended to invest some time in this research. You may end up joining or forking an existing project instead of creating a new one. +Open source hardware projects documentation can be divided in at least two activities: documenting the product (manufacturing, assembly, use, maintenance and so on.) and documenting the process (project vision, collaborators, how to collaborate, design process). +This distinction can also be linked with the five [OSHWA defined freedom for OSH](https://freedomdefined.org/OSHW): **study**, **modify** being mostly related to the process; **make**, **distribute,** and **sell** being mostly related to the product. -## Communication channel +On the other hand, an hardware project goes through several development steps, each of them deserving some specific documentation. +In the **ideation** phase, one should define the project vision and find collaborators. +In the **needs analysis** phase, the team is documenting their research on the definition of requirements and on the related existing projects. +In the **concept** phase, the team is describing some implementation possibilities. +In the **prototyping** phase, the team is iteratively designing a prototype, the product documentation is starting now, while the process documentation may be expanded as new collaborators comes in. +In the **replicator** phase, the prototype is moved to a market-ready product, and the documentation aimed at users and producers of hardware will become more important. -Describe how to connect with this project. It is recommended to use a different platform than the one where the data is to prevent vendor lock-in effects, and to find a tool already in use in your community. +## Growing documentation with project size -Please use the issue function in this repository to contact us. +Using analyses of at several examples of hardware and software project, we derived a large amount of elements that may be included in an hardware project. +We then categorizing them following their goal (process or product documentation) and indicated whether it should be created or updated at different stage of development. -## License and rights +From this we created a miminal template for the ideation stage, and provide a checklist of additional elements to add. +Templates for each additional elements are also provided. -Please indicate how people will be allowed to use the information found in this repository. You may want to add a license created for open source hardware. You may get some information in the [turing way open book chapter on hardware licensing](https://book.the-turing-way.org/reproducible-research/licensing/licensing-hardware). +# Roadmap and future work +We plan on providing template files and good guidelines in November 2024. +Then, we plan on testing them in specific projects (internal and external).\ +In the future, we hope to build some software to help with the additions instead of using a checklist. +## Community, Contributions funding +This was developed inside the LAUDS Factories and the Open.Make projects, based on results of the OpenNext project. -> Note: -> This was created using the (minimal) template for research hardware project, it is meant to be used at the ideation stage of the project, and be later expanded by adding files and folders coming from additional template. A [checklist](checklist.md) might have been used to organise this expansion the repository which may be facilitated by the use of the Gitbuilding open source software. +LAUDS Local Accessible Urban Digital Sustainable Factories is a Horizon Europe research and innovation action - Co-funded by the European Union, 2024-2026, GA 101135986 + +OpenNext has received funding from the European Union’s Horizon 2020 research and innovation programme under [grant agreement no. 869984](https://cordis.europa.eu/project/id/869984). + +OpenMake is funded by the Federal Ministry of Education and Research (BMBF) and the state of Berlin under the Excellence Strategy of the Federal Government and the Länder / www.berlin-university-alliance.de + +## Main contributors: + +Julien Colomb: julien.colomb [at] fu-berlin.de + +Sacha Hodencq + +Jean-François Boujut + +Robert Mies + +Moritz Maxeiner diff --git a/README_minimal.md b/README_minimal.md new file mode 100644 index 0000000..974dbac --- /dev/null +++ b/README_minimal.md @@ -0,0 +1,30 @@ +# My research hardware project name + +- development stage: idea generation +- subject area/type of hardware + +## Vision and motivation + +This paragraph explains the ultimate goal of the project, its specificity and main objectives. + +## Community and Contributions + +### List of team members / contributors + +### Who could contribute + +This section explains who is behind the project. + +### Communication channel, how to contribute + +## License and rights + +## Funding information + +- Sponsors and funding: + +- Future funding opportunities: + +> Note: This was created using the (minimal) template for research hardware project, it is meant to be used at the ideation stage of the project, and be later expanded by adding files and folders coming from additional template. +> A [checklist](checklist.md) might have been used to organise this expansion the repository which may be facilitated by the use of the Gitbuilding open source software. diff --git a/RHardware-minimaltemplate.Rproj b/RHardware-minimaltemplate.Rproj new file mode 100644 index 0000000..8e3c2eb --- /dev/null +++ b/RHardware-minimaltemplate.Rproj @@ -0,0 +1,13 @@ +Version: 1.0 + +RestoreWorkspace: Default +SaveWorkspace: Default +AlwaysSaveHistory: Default + +EnableCodeIndexing: Yes +UseSpacesForTab: Yes +NumSpacesForTab: 2 +Encoding: UTF-8 + +RnwWeave: Sweave +LaTeX: pdfLaTeX diff --git a/_build/AssemblyManualSource/Parts/M4x10PanSteel.md b/_build/AssemblyManualSource/Parts/M4x10PanSteel.md new file mode 100644 index 0000000..46de8b0 --- /dev/null +++ b/_build/AssemblyManualSource/Parts/M4x10PanSteel.md @@ -0,0 +1,23 @@ +# M4x10 Pan Head Steel + +This is lots of text about some screws? + + + + +## Specifications + +|Attribute |Value| +|---|---| +|Head|Pan| +|Length|10 mm| +|Material|Stainless Steel| +|Pitch|0.7| + + +## Suppliers + +|Supplier |Part Number| +|---|---| +|RS|[528-817](https://uk.rs-online.com/web/p/machine-screws/0528817/){:target="_blank"}| +|McMasterCarr|[90116A207](https://www.mcmaster.com/90116A207){:target="_blank"}| diff --git a/_build/AssemblyManualSource/Parts/Screwdriver_Philips_No2.md b/_build/AssemblyManualSource/Parts/Screwdriver_Philips_No2.md new file mode 100644 index 0000000..ad983ce --- /dev/null +++ b/_build/AssemblyManualSource/Parts/Screwdriver_Philips_No2.md @@ -0,0 +1,12 @@ +# No. 2 Phillips screwdriver + +No2 Phillips screwdriver. This is the correct size form an M4 pan head screw + + + + +## Specifications + +|Attribute |Value| +|---|---| +|Drive Size|No. 2| diff --git a/_build/AssemblyManualSource/index.md b/_build/AssemblyManualSource/index.md new file mode 100644 index 0000000..925de79 --- /dev/null +++ b/_build/AssemblyManualSource/index.md @@ -0,0 +1,14 @@ +# Test Project + +This is a great place to start making your documentation! + +You should link to a couple of pages: + +* [Test Page 1](testpage1.md "") +* [Test Page 2](testpage2.md "") + +And you should definitely let people know about the [bill of materials](index_BOM.md) [(csv)](index_BOM.csv) page. + +--- + +[Next page](index_BOM.md) \ No newline at end of file diff --git a/_build/AssemblyManualSource/index_BOM.csv b/_build/AssemblyManualSource/index_BOM.csv new file mode 100644 index 0000000..5e3b89f --- /dev/null +++ b/_build/AssemblyManualSource/index_BOM.csv @@ -0,0 +1,4 @@ +Name in documentation Qty Full Name Supplier 1 Part No Link Supplier 2 Part No Link +M4x10 screws 10 M4x10 Pan Head Steel RS 528-817 https://uk.rs-online.com/web/p/machine-screws/0528817/ McMasterCarr 90116A207 https://www.mcmaster.com/90116A207 +No. 2 Phillips screwdriver 1 No. 2 Phillips screwdriver +widget 2 Widget Widget Shop Widget1 https://dictionary.cambridge.org/dictionary/english/widget diff --git a/_build/AssemblyManualSource/index_BOM.md b/_build/AssemblyManualSource/index_BOM.md new file mode 100644 index 0000000..a6decc2 --- /dev/null +++ b/_build/AssemblyManualSource/index_BOM.md @@ -0,0 +1,25 @@ +# Bill of Materials + +Download this as a [CSV file](index_BOM.csv) + + + +### Parts + +* 10 [M4x10 screws]{: Class="bom"} +* 2 [widget]{: Class="bom"} + + +### Tools + +* 1 [No. 2 Phillips screwdriver]{: Class="bom"} +[No. 2 Phillips screwdriver]:Parts/Screwdriver_Philips_No2.md "" +[M4x10 screws]:Parts/M4x10PanSteel.md "" +[widget]:widget.md "" + + + + +--- + +[Previous page](index.md) | [Next page](testpage1.md) \ No newline at end of file diff --git a/_build/AssemblyManualSource/testpage1.md b/_build/AssemblyManualSource/testpage1.md new file mode 100644 index 0000000..9a67651 --- /dev/null +++ b/_build/AssemblyManualSource/testpage1.md @@ -0,0 +1,33 @@ +[M4x10 screws]:Parts/M4x10PanSteel.md "" +[No. 2 Phillips screwdriver]:Parts/Screwdriver_Philips_No2.md "" +# Test Page 1 + +
+ +### Parts + +* 5 [M4x10 screws]{: Class="bom"} +* 1 [widget]{: Class="bom"} + + +### Tools + +* 1 [No. 2 Phillips screwdriver]{: Class="bom"} + + +
+ +## Step 1: Put screws into the widget {:id="put-screws-into-the-widget" class="page-step"} + +* Get a [No. 2 Phillips screwdriver] ready +* Take three [M4x10 screws] and screw them into the [widget] + +## Step 2: Put more screws into the widget {:id="put-more-screws-into-the-widget" class="page-step"} + +* Find the [screwdriver][No. 2 Phillips screwdriver] again +* Take two more [M4x10 screws] and screw them into the same widget +[widget]:widget.md "" + +--- + +[Previous page](index_BOM.md) | [Next page](testpage2.md) \ No newline at end of file diff --git a/_build/AssemblyManualSource/testpage2.md b/_build/AssemblyManualSource/testpage2.md new file mode 100644 index 0000000..f54fc14 --- /dev/null +++ b/_build/AssemblyManualSource/testpage2.md @@ -0,0 +1,33 @@ +[M4x10 screws]:Parts/M4x10PanSteel.md "" +[No. 2 Phillips screwdriver]:Parts/Screwdriver_Philips_No2.md "" +# Test Page 2 + +
+ +### Parts + +* 5 [M4x10 screws]{: Class="bom"} +* 1 [widget]{: Class="bom"} + + +### Tools + +* 1 [No. 2 Phillips screwdriver]{: Class="bom"} + + +
+ +## Step 1: Put screws into the widget {:id="put-screws-into-the-widget" class="page-step"} + +* Get a [No. 2 Phillips screwdriver] ready +* Take three [M4x10 screws] and screw them into the [widget] + +## Step 2: Put more screws into the widget {:id="put-more-screws-into-the-widget" class="page-step"} + +* Find the [screwdriver][No. 2 Phillips screwdriver] again +* Take two more [M4x10 screws] and screw them into the same widget +[widget]:widget.md "" + +--- + +[Previous page](testpage1.md) \ No newline at end of file diff --git a/_build/AssemblyManualSource/widget.md b/_build/AssemblyManualSource/widget.md new file mode 100644 index 0000000..b18a77b --- /dev/null +++ b/_build/AssemblyManualSource/widget.md @@ -0,0 +1,22 @@ +# Widget + +This is an example page for a part that needs more information than can be provided +in a part library. You can also add links and images into this page. + +--- + + + +## Specifications + +|Attribute |Value| +|---|---| +|Type|Unknown| +|Quality|Fantastic| + + +## Suppliers + +|Supplier |Part Number| +|---|---| +|Widget Shop|[Widget1](https://dictionary.cambridge.org/dictionary/english/widget){:target="_blank"}| diff --git a/_build/checklist.md b/_build/checklist.md new file mode 100644 index 0000000..7cd61ca --- /dev/null +++ b/_build/checklist.md @@ -0,0 +1,6 @@ +# Checklist + +- [] Complete this readme file +- [] Connect with other people who could be interested in the project, for example on the [GOSH forum](https://forum.openhardware.science ""){:target="_blank"} +- [] Choose and add a license +- [] Decide on using Gitbuilding for assembly manual. Either install and use it, or erase the corresponding folder (AssemblyManualSource). \ No newline at end of file diff --git a/_build/missing.md b/_build/missing.md new file mode 100644 index 0000000..8ef4725 --- /dev/null +++ b/_build/missing.md @@ -0,0 +1 @@ +# GitBuilding Missing Part \ No newline at end of file diff --git a/_pdf/Documentation.pdf b/_pdf/Documentation.pdf new file mode 100644 index 0000000..fc5262f Binary files /dev/null and b/_pdf/Documentation.pdf differ diff --git a/checklist.md b/checklist.md index e16de98..0e4c9bb 100644 --- a/checklist.md +++ b/checklist.md @@ -1,6 +1,162 @@ # Checklist -- [] Complete this readme file -- [] Connect with other people who could be interested in the project, for example on the [GOSH forum](https://forum.openhardware.science) -- [] Choose and add a license -- [] Decide on using Gitbuilding for assembly manual. Either install and use it, or erase the corresponding folder (AssemblyManualSource). +Note: hardware development starts only in step four, the preparation phase is important if one does not want to end up reinventing the wheel of producing useless hardware. + +## Step 1: Idea generation + +This should all be included in the readme file: + +- [ ] General information + - [ ] name of the project + - [ ] development stage: idea generation + - [ ] *type of hardware, subject area* + - [ ] **License** + - [ ] FOR WHO IS MADE THIS DOCUMENT + - [ ] short problem description + +- [ ] vision and motivations + +- [ ] Contributions + - [ ] List of team members / contributors + - [ ] skills required, who could contribute (at this point) + + - [ ] contact point information / communication channel and tools used for communication (this can also be one email address) + +- [ ] Funding information + - [ ] List of Sponsors and funding + - [ ] List of putative funding opportunities + +## Step 2: needs analysis + +Note: using a canva to analyse the project may be useful at this point. +- [ ] Complete the readme file + - [ ] *ethics statement (human/animal use or Informed Consent Statement)* + - [ ] *competing interest* + - [ ] future work, roadmap + - [ ] development stage: needs analysis + - [ ] *Project history summary* + - [ ] longer problem description + - [ ] Documentation structure + + +- [ ] Contributions + - [ ] Contribution guidelines + - [ ] work culture that you want to promote + - [ ] Code of conduct + +- [ ] Product development + - [ ] requirements + - [ ] constrains + - [ ] capability + + +- [ ] User analysis (this can be a personas analysis) + - [ ] target groups (who will use the product) + - [ ] External interfaces (how will they use the product) + - [ ] skills needed to use + +- [ ] History + - [ ] *changes log* + +## Step 3: Concept development + +- [ ] Complete the readme file + - [ ] development stage: concept development + - [ ] dependencies + - [ ] *conclusions* + - [ ] software used for development + + +- [ ] History + - [ ] release note + - [ ] design_choices + - [ ] update change log + + +- [ ] Product development + - [ ] update hardwareoverview + - [ ] application, use cases + - [ ] *reuse potential* + - [ ] architectural structure + - [ ] *foreseen cost + time cost* + - [ ] functional model + - [ ] behavioral model: *Modelling tool list* + - [ ] Similar projects + + + + + +## Step 4: product development and prototyping + +Here the work on the design starts! Continous documentation of choice made, successes and fails are welcome, so this step has an iterative components: with every development can come specific documentation. + +### Step 4a: preparations +- [ ] Complete the readme file + - [ ] development stage: prototyping + - [ ] Standard compliance + - [ ] Product outputs (if relevant: data outputs) + - [ ] Citing information + + +- [ ] Product development + - [ ] Software/firmware architecture + - [ ] electrical design architecture + +### Step 4b: iteration of design + +- [ ] Product design + - [ ] Bill of material + - [ ] material characteristics + - [ ] electrical design + - [ ] Software: Documentation of different parts + +- [ ] Manufacturing instructions + - [ ] Manufacturing skills and tools + - [ ] Manufacturing sequences and instruction + +- [ ] Assembly instructions + - [ ] assembly skills and tools + - [ ] Safety information + - [ ] Assembly sequence and instruction + +- [ ] User guide + - [ ] Safety information + - [ ] overview of the hardware + - [ ] Operation instructions + - [ ] Testing instructions and troubleshooting + - [ ] basic maintenance + schedule + - [ ] basic disposal + +- [ ] History + - [ ] update changelog/release note + - [ ] update design choice history + + +## Step 5: replicator step + +Here the prototype is mature enough that it should be replicated in different places. While most of the work was already present at step 4, here we go into more quality and details. + +- [ ] Complete the readme file + - [ ] development stage: replication ready + - [ ] scientific publication + - [ ] education resources + - [ ] Institutional Review Board Statement + - [ ] discussions + - [ ] validation + - [ ] cost + +- [ ] Assembly instructions + - [ ] disassembly + +- [ ] Product design + - [ ] component lifespan + +- [ ] User guide + - [ ] Environmental management + - [ ] Identifying the defective components + - [ ] Repairing the defective components + - [ ] Replacing equipment components + + + diff --git a/software/RHdoc-steps.py b/software/RHdoc-steps.py new file mode 100644 index 0000000..3532483 --- /dev/null +++ b/software/RHdoc-steps.py @@ -0,0 +1,68 @@ +Step2: + create folders + + +move Futuresteps/community to 01_community +move Futuresteps/product to 02_product +move Futuresteps/project_history to 10_history + +readme: + change "### Who could contribute" into "- [guidelines](01_community/guidelines.md) +- [Code of conduct](01_community/coc.md) + +### Who could contribute" + + + change "## License and rights" with "## The hardware + +- [requirements, constrains and capabilities](02_product/hardwareoverview.md) + +## License and rights +" + +-------------------------------------- +Step3: + + +change "## The hardware" into "## The hardware + +### application, use cases + +### *reuse potential* + +### dependencies" + +change " +## Community and Contributions" into "### Project history summary + +## Community and Contributions"" + +change " +> Note:" into "## Documentation structure + +## conclusions +> Note:"" + +add +"-(foreseen) Cost" in readme. + + +move file: + Futuresteps/project_history/02_release_note.md into 10_history + +write at end of file "product/01_hardwareoverview" +"## architectural structure +" + +-------------------------------------------------- +Setp4 + +find a way to add "- Standard compliance +- cite this project: " at the start of readme + +change " +### dependencies" into "### hardware outputs + +### dependencies" + + + diff --git a/tests/README_conceptlevel.md b/tests/README_conceptlevel.md new file mode 100644 index 0000000..ee9b52f --- /dev/null +++ b/tests/README_conceptlevel.md @@ -0,0 +1,74 @@ +# My research hardware project name + +- development stage: needs analysis +- subject area/type of hardware +- prerequisite: who is this documentation made for + +## Vision and motivation + +This paragraph explains the ultimate goal of the project, its specificity and main objectives. + +Please also indicates the problem this project aims at solving + +## Problem description + +## dependencies +indicate and cite projects this project is built on +For the software part, indicate the main component, use a dependency.txt files in the software folder when needed. + +## dependencies +indicate and cite projects this project is built on +For the software part, indicate the main component, use a dependency.txt files in the software folder when needed. + +##software used for development + +## Roadmap +This paragraph explains briefly the history of the project and the future milestones and time plan. + +### Project history summary + +### Future work + +## Community and Contributions +This section explains who is behind the project. + +### List of team members / contributors + +### Who could contribute + +### Communication channel, how to contribute + +### work culture + +Summary + +- [guidelines](01_community/guidelines.md) +- [Code of conduct](01_community/coc.md) + +## License and rights + +## Funding information + +- Sponsors and funding: + +- Future funding opportunities: + +## Administrative information + +- *ethics statement (human/animal use or Informed Consent Statement)* +- *competing interest* + +## Documentation structure + +This readme contains the first level of information. +in +- 01_community are saved our detailed documentation about the community practices +- 02_product_dvt you will find high level analysis of the hardware design like the list or requirements and user analysis +- 03_project_history you will find information about past decisions in the project + +## conclusions +summary of main results obtained and discussion that happened so far + +> Note: This was created using the (minimal) template for research hardware project, it is meant to be used at the ideation stage of the project, and be later expanded by adding files and folders coming from additional template. +> A [checklist](checklist.md) might have been used to organise this expansion the repository which may be facilitated by the use of the Gitbuilding open source software. diff --git a/tests/README_maximal.md b/tests/README_maximal.md new file mode 100644 index 0000000..0a30afa --- /dev/null +++ b/tests/README_maximal.md @@ -0,0 +1,60 @@ +# My research hardware project name + +- development stage: idea generation +- subject area/type of hardware +- Standard compliance +- cite this project: + +## Vision and motivation + +This paragraph explains the ultimate goal of the project, its specificity and main objectives. + +## Roadmap + +### Project history summary + +## Community and Contributions + +### List of maintainers/ main contributors + +- [guidelines](01_community/guidelines.md) +- [Code of conduct](01_community/coc.md) + +### Who could contribute + +This section explains who is behind the project. + +### Communication channel + +## The hardware + +### application, use cases + +### *reuse potential* + +### hardware outputs + +### dependencies + +- [requirements, constrains and capabilities](02_product/hardwareoverview.md) + +## License and rights + +## Funding information + +- Sponsors and funding: + +- Future funding opportunities: + +## Administrative informatin + +- *ethics statement (human/animal use or Informed Consent Statement)* +- *competing interest* + +## Documentation structure + +## conclusions + +> Note: This was created using the (minimal) template for research hardware project, it is meant to be used at the ideation stage of the project, and be later expanded by adding files and folders coming from additional template. +> A [checklist](checklist.md) might have been used to organise this expansion the repository which may be facilitated by the use of the Gitbuilding open source software. diff --git a/tests/README_needslevel.md b/tests/README_needslevel.md new file mode 100644 index 0000000..1531416 --- /dev/null +++ b/tests/README_needslevel.md @@ -0,0 +1,62 @@ +# My research hardware project name + +- development stage: needs analysis +- subject area/type of hardware +- prerequisite: who is this documentation made for + +## Vision and motivation + +This paragraph explains the ultimate goal of the project, its specificity and main objectives. + +Please also indicates the problem this project aims at solving + +## Problem description + +## Roadmap +This paragraph explains briefly the history of the project and the future milestones and time plan. + +### Project history summary + +### Future work + +## Community and Contributions +This section explains who is behind the project. + +### List of team members / contributors + +### Who could contribute + +### Communication channel, how to contribute + +### work culture + +Summary + +- [guidelines](01_community/guidelines.md) +- [Code of conduct](01_community/coc.md) + +## License and rights + +## Funding information + +- Sponsors and funding: + +- Future funding opportunities: + +## Administrative information + +- *ethics statement (human/animal use or Informed Consent Statement)* +- *competing interest* + +## Documentation structure + +This readme contains the first level of information. +in +- 01_community are saved our detailed documentation about the community practices +- 02_product_dvt you will find high level analysis of the hardware design like the list or requirements and user analysis +- 03_project_history you will find information about past decisions in the project + + +> Note: This was created using the (minimal) template for research hardware project, it is meant to be used at the ideation stage of the project, and be later expanded by adding files and folders coming from additional template. +> A [checklist](checklist.md) might have been used to organise this expansion the repository which may be facilitated by the use of the Gitbuilding open source software.