Skip to content
Anool Mahidharia edited this page May 25, 2026 · 3 revisions

๐Ÿ“˜ IS Project Documentation Template

Welcome! This template will help you document your project clearly and effectively for review, collaboration, and open sharing.

Please follow the structure below step-by-step and update each section with your project details. All your documentation should be updated in this GitHub repo itself


READ THIS FIRST

๐Ÿ“˜ Welcome to the IS Project Documentation Template!

Hey there! ๐Ÿ‘‹

This repository is your home for documenting your Innovation School Project and starting your maker portfolio.
Youโ€™ll be using the GitHub Wiki to update all your project details in a structured format.


๐Ÿง  What to Do First

Start by writing a brief introduction to your project in the Project Details Wiki Page

๐Ÿ”น Title of your Project
๐Ÿ”น What problem are you solving?
๐Ÿ”น Whatโ€™s your proposed solution?
๐Ÿ”น Any additional details you may wish to add.
๐Ÿ”น TLDR; - A short description of you project in 140 characters.

These details help others quickly understand what your project is about.

Click on Project Details in the Side Bar, and then the EDIT button at the top right (next to the green NEW PAGE button). You can make the edits directly from within your browser.


๐Ÿ›  Where to Document Everything Else

Weโ€™ve already created a standard set of Wiki pages for your project in this repository โ€” you just need to update them with your project information.

Each section is ready with headings like:

  • Home
  • Project Details
  • Bill of Materials
  • Circuit & CAD Files
  • SDG Goals Associated
  • Media Gallery
  • License

Please do not delete or change the headings โ€” just replace the content under each.


๐Ÿ“š How to Edit the GitHub Wiki Pages

Follow these official GitHub help guides to learn how to edit your Wiki pages:

๐Ÿ”— How to Add or Edit Wiki Pages
๐Ÿ”— How to Format and Save Content in Wikis


๐Ÿ“ธ Visual Guide (Optional)

If youโ€™re unsure where the Wiki tab is:
๐Ÿ“ Itโ€™s on the top-right area of the repository (next to Code, Issues, Pull Requests).

Youโ€™ll find your project listed there. Click on it, then click โ€œEditโ€ to begin updating.


๐Ÿค Need Help?

If you're confused at any step:

  • Ask your mentor or coordinator
  • Or drop a message in our Discord/WhatsApp support group

Letโ€™s build something awesome! ๐Ÿš€

Clone this wiki locally