- Do your best to finish your work plans by end of day Mondays. It's better to have a more detailed work plan that you get done later in the day than having a half-assed workplan. The first time/couple times you do it it might take more than a day!
- Gists should be properly formatted
.mdfiles. Here's a link to markdown formatting information. - All work plans should have 3 sections Weekly Goal, Specifications & Implementation Plan
- This is a short 1-3 sentence overview of what you'll accomplish this week.
- A spec is a user facing to do list item. It doesn't include engineering details. It might include something like:
- As a user, I can log in to the website.
- As a user, I can edit my profile.
- As a user, I can upload a picture to my profile.
- This section should include any links to external projects.
- The Implementation Plan is your engineering to do list. They have a ton of detail and it's where you do your heavy thinking for the week. Once your implementation plan is complete you should be able to focus on code.
- For the 'a user can log in' example above, it might look like:
- create
userstable with username, email, & password columns - create log in route
- create log in form view
- write functions that check user form inputs are valid
- etc ...
- create
- For the 'a user can log in' example above, it might look like:
- You should be 90% sure that you can get through your specs inside of this week. Don't over or under estimate what you can get done, try to hit the nail on the head!
- If it feels easy you didn't plan enough.
- If it makes you panic you're past your ZPD.
- Use an active voice and pretend you're writing for use on a team.
- Don't just say 'user's table', instead say 'will create
userstable withusername,email&passwordcolumns' - Don't just say 'choose colors', instead say 'choose 3 primary colors for use throughout site and record hex codes in the readme'
- Don't just say 'user's table', instead say 'will create
- Use correct engineering language.
- Don't say 'will use heroku', instead say 'will deploy site on heroku'