tools:wiki

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
tools:wiki [2015/09/15 22:57]
cobatake
tools:wiki [2021/09/19 21:59] (current)
Line 1: Line 1:
 ====== How to Use our Wiki ====== ====== How to Use our Wiki ======
 +
 +===== How to Create A New Wiki Page =====
 +    * Use a namespace (https://​www.dokuwiki.org/​namespaces) and put the date.  The namespace can be see at the top corner of the page or the end of the url for the page.  When creating a new page for your notes, it should be of the following format:<​code>​
 +[[< namespace >: < Name of page >]]\\
 +</​code>​
 +    * You can also use a dot which specifies the current namespace. <​code>​
 +[[.: < Name of page >]]\\
 +</​code>​
 +    * For example, if one were to create the Dragonfruit Design team’s page, they would use the weatherbox namespace: “weatherbox”. ​ When creating their page, it would look like one of the following:<​code>​
 +[[weatherbox:​Dragonfruit]]\\
 +[[.:​Dragonfruit]]\\
 +</​code>​
 +
 +=====How to Organize your Wiki Page=====
 +  * **At the top of your wiki page should be a brief description of your team**
 +  * **Include goals for the semester and long term goals**
 +  * **Include a block diagram of your system**
 +  * **Include a power budget and BOM (build of materials) if applicable**
 +  * **Include Resources**
 +    * Instructions of how to install software
 +    * Links to written instructions or videos tutorials
 +    * Data sheets
 +    * Links to website pages you have referenced
 +    * Links to website pages you used to solve issues/​problems
 +    * Links to examples that are relevant to your work
 +  * **Meeting minutes**
 +    * Please format according to instructions below
 +    * Order your notes in chronological order with the newest notes at the top
 +  * **Presentation slideshows**
 +    * Save a pdf version of your presentations and posters to the wiki
 +    * Presentation pdfs should be named <Team name>​_<​Presentation name>​.pdf
 +      * For example, Firmware would name their PDR pdf as: Firmware_PDR.pdf
  
 ===== How to Post Meeting Notes ===== ===== How to Post Meeting Notes =====
-  * Subteam meeting minutes should be added on your team name’s page +  ​* **Subteam meeting minutes should be added on your team name’s page** 
-    Weatherbox teams: https://​wiki.scel-hawaii.org/​doku.php?​id=weatherbox:​start+     ​[[..:weatherbox:​start|Weatherbox Teams]]
         * Xbee team should post their notes on the Networking page         * Xbee team should post their notes on the Networking page
-     ​* ​Forecasting team: https://​wiki.scel-hawaii.org/​doku.php?​id=forecasting:​start +     ​* ​[[..:forecasting:​start|Forecasting Team]] 
-     ​* ​Wind sensor team: https://​wiki.scel-hawaii.org/​doku.php?​id=wind_sensor:​start+     ​* ​[[..:wind_sensor:​start|Wind Sensor Team]]
  
-  * Creating a new page for your notes +  ​* **Creating a new page for your notes** 
-    * Use a namespace (https://​www.dokuwiki.org/​namespaces) and put the date.  The namespace can be see at the top corner of the page or the end of the url for the page.  When creating a new page for your notes, it should be of the following format: +    * Use a namespace (https://​www.dokuwiki.org/​namespaces) and put the date.  The namespace can be see at the top corner of the page or the end of the url for the page.  When creating a new page for your notes, it should be of the following format:<​code>​ 
-<​code>​ +[[< namespace >: Meeting Minutes < Month Day, Year >]]\\
- [[< namespace >: Meeting Minutes < Month Day, Year >]]\\+
 </​code>​ </​code>​
-    * You can also use a dot which specifies the current namespace. ​ +    * You can also use a dot which specifies the current namespace. <​code>​ 
-<​code>​ +[[.: Meeting Minutes < Month Day, Year >]]\\
- [[.: Meeting Minutes < Month Day, Year >]]\\+
 </​code>​ </​code>​
-    * For example, the namespace on the Dragonfruit Design team’s page is “weatherbox:​dragonfruit”. ​ When creating a new page for your notes, it would look like one of the following: +    * For example, the namespace on the Dragonfruit Design team’s page is “weatherbox:​dragonfruit”. ​ When creating a new page for your notes, it would look like one of the following:<​code>​ 
-<​code>​ +[[weatherbox:​dragonfruit:​ Meeting Minutes September 9, 2015]]\\ 
- [[weatherbox:​dragonfruit:​ Meeting Minutes September 9, 2015]]\\ +[[.: Meeting Minutes September 9, 2015]]\\
- [[.: Meeting Minutes September 9, 2015]]\\+
 </​code>​ </​code>​
  
-  * Contents of your notes+  * **Formatting ​your Notes**
     * The title of the notes should include your team name and the date     * The title of the notes should include your team name and the date
     * The title and any subsections of the notes should be headers     * The title and any subsections of the notes should be headers
     * Include the names of those who attended the meeting     * Include the names of those who attended the meeting
 +    * Split your notes into different sections (i.e. "​Reminders",​ "​Updates",​ "​Resolved Problems",​ "​Questions for Next Time", "To Work on", etc.)
     * Use bullet points for your notes     * Use bullet points for your notes
-    * The following is an example:+    * Make your notes readable and make sure you can understand them 
 +      * Would I be able to understand this months from now if you need to reference something?​ 
 +      * If someone new to the lab were looking at my notes, would they be able to understand them? 
 +  * **Content of your Notes** 
 +    * Include updates and your progress 
 +    * Include issues 
 +      * Document in your weekly notes how issues were resolved 
 +      * Write a short explanation of the problem and how you solved it 
 +      * Include links or resources you used to solve problems 
 +      * Will help future members in our lab if they run into the same problems 
 +    * Include technical notes 
 +  * **An Example of Meeting Minutes**
 <​code>​ <​code>​
 =====Website Team Meeting- September 9, 2015===== =====Website Team Meeting- September 9, 2015=====
-**Attended: Kenny, Christie, Michele**+**Attended: Kenny, Christie**
  
 =====Updates===== =====Updates=====
  • tools/wiki.1442357865.txt.gz
  • Last modified: 2021/09/19 21:59
  • (external edit)