List of machinery and inventory from MiR:

Form submission: 

Link form: https://airtable.com/app8XtvEq4CSA0g35/shrwH1gxqOT5aA4mN

Link source: https://airtable.com/app8XtvEq4CSA0g35/shrz9MMr3mo9cAg2G 

Hardware documentation workshop outline:

Online Workshop Proposal: Project Documentation with WikiFactory

Title: A WikiFactory Workshop for Open Hardware Projects.

Objective:

This 2-hour online workshop aims to guide participants through effective project documentation using WikiFactory, aligned with best practices from:

• IOPA “Open-Know-How”
• “Fab Academy”
• “Open Hardware Makers”

Participants will learn essential documentation practices to enhance collaboration, share knowledge, and contribute to the world-wide open hardware community.

Key Topics:

1. Introduction to Open Hardware Documentation Standards:
   • Overview of Open-Know-How, Fab Academy, Open Hardware Makers, and Open Source Hardware development recommendations.
   • The importance of comprehensive project documentation in the open hardware ecosystem.
2. Navigating WikiFactory:
   • A walkthrough of WikiFactory's interface and features.
   • Understanding the structure of a well-documented project on WikiFactory.
3. Essential Elements of Project Documentation:
   • Documentation components recommended by Open-Know-How and Fab Academy.
   • Incorporating key information: bill of materials, schematics, CAD files, firmware, and more.
4. Creating Effective Project Pages:
   • Step-by-step guide to creating a project page on WikiFactory.
   • Best practices for organizing content and making it accessible.
5. Collaborative Editing:
   • Utilizing WikiFactory's collaborative editing features.
   • Understanding version control for iterative development.
6. Incorporating Multimedia and Descriptive Content:
   • Enhancing documentation with images, videos, and detailed descriptions.
   • Telling a compelling story through project documentation.
7. Interactive Q&A and Troubleshooting:
   • Addressing participant questions and challenges.
   • Troubleshooting common issues encountered during documentation.

Workshop Format:

The workshop will be conducted through an online platform, featuring live demonstrations, interactive discussions, and Q&A sessions. Participants will be encouraged to create and edit a simple project page during the workshop, providing a hands-on learning experience.

Target Audience:

Makers, hardware enthusiasts, technical writers from the Makers in residency cohort. No prior experience with WikiFactory is required.

Benefits for Participants:

• Gain proficiency in using WikiFactory for open hardware documentation.
• Understand the principles of effective documentation following recognized standards.
• Contribute meaningfully to collaborative projects within the open hardware community.
• Build a foundation for sharing knowledge and fostering innovation.

Workshop Duration: 2 hours

Requirements: 

Participants will need a computer with internet access. A WikiFactory account is recommended but not mandatory for attending the workshop.

Conclusion:

By the end of this workshop, participants will be equipped with the skills and knowledge to document their open hardware projects effectively on WikiFactory. Embracing the principles of Open-Know-How and related standards, they will play a vital role in advancing the culture of open collaboration within the global hardware community.

Note: For practicality we chose wikifactory, although a platform agnostic approach could be used, like documentation on git or using gitbuilding.