Difference between revisions of "New Member Orientation"
Jump to navigation
Jump to search
(→Documentation) |
(→Documentation) |
||
Line 48: | Line 48: | ||
=== Documentation === | === Documentation === | ||
− | Documentation is an important part of HIP because different people from different times will need to know about the work you did. | + | Documentation is an important part of HIP because different people from different times will need to know about the work you did.= |
− | |||
− | |||
* document projects | * document projects | ||
− | ** document | + | ** inline code documentation helps readability |
+ | ** document '''while''' working on a project | ||
** after completion, document changes to keep information relatively accurate | ** after completion, document changes to keep information relatively accurate | ||
Revision as of 16:07, 19 January 2014
I'm going to make no assumptions about you or your purpose for being here. Read what you need or want; you can always come back.
Contents
Statement
- HIP focuses on bringing hardware and software together
- HIP is merged with Green Science and so our projects can include subjects such as the use, representation, and creation of energy.
- There are software and hardware opportunities.
Workspaces
- Dennis roof
- Noyes basement
- Green Zone
Keys
- Dennis front entrance, code ???
- Dennis back entrance, code CAX
- Dennis roof, code CAB 6
- Noyse basement, code CAB 13
Projects
Check HIP for up-to-date project listings.
This is a list of present/past projects that we've worked on. It's intended to give you a taste of what we do.
- solar array
- wind generator
- energy monitoring of buildings
- normalization of resulting data
- kiosks that display energy information
- earthquake sensors
- time server
- construction cam
Communication
Group
- we use a listserv, email hip@cs.earlham.edu to email everyone
- generally it's good to notify the group about significant progress via email or in meetings
- phone numbers / emails are useful to have
- google services such as docs, spreadsheets, etc can be used for development
- you need gmail accounts to utilize these services
Meetings
- Friday in the Green Zone for lunch (12-1pm)
- general discussion about current and future projects
- bring-your-own-lunch style
- Sunday on the roof (1-3pm)
- working together in the same space
Documentation
Documentation is an important part of HIP because different people from different times will need to know about the work you did.=
- document projects
- inline code documentation helps readability
- document while working on a project
- after completion, document changes to keep information relatively accurate
- document your work, process, or experience
- your experience is invaluable to someone who is going through a similar experience
Wiki Basics
- how to use
- you need an account to be created by an admin; ask Charlie
- if a page doesn't exist, search for it and the wiki will let you create that page
- make sure to click "Save Page" after you're finished editing
- how to learn
- edit pages to look at their syntax
- use Wiki Syntax
- how to style
- group things sensibly because having too many headers can be overkill
- ordered lists are the simplest way to organize content