Difference between revisions of "Writing your Work Log"

From edegan.com
Jump to navigation Jump to search
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
==Creating a Work Log==
 +
 +
Every team member should have a work log. To create a work log make a page on wiki called '''Full Name (Work Log)'''.
 +
 +
Note that you can do this by either searching for that page or by linking to it and then following the link.
 +
 +
Then:
 +
*Include <nowiki>[[Full Name]] [[Work Logs]] [[Full Name (Work Log)|(log page)]]</nowiki> at the top of your new work log page.
 +
*[[Help:Editing_Content#Transclusion|Transclude]] your current semester's work to the master log by wrapping the log of this semester, including the header your just made, with <nowiki><onlyinclude></nowiki> tags.
 +
*At the very bottom of your log page, include <nowiki>[[Category:Work Log]]</nowiki> to categorize your page.
 +
 +
===Master Work Log===
 +
 +
The master [Work Log] includes extracts of everyone's individual work logs.
 +
 +
After creating your work log, add yourself to the master work log under your designated category (e.g. Technical) by adding this text:
 +
:<nowiki>==Full Name==</nowiki> ''(Replace ''Full Name'' with your name.)''
 +
:<nowiki>{{:Full Name (Work Log)}}</nowiki>
 +
 +
===User Profile Work Log Link===
 +
 +
Add a link to your work log in your user profile by adding this text at the bottom:
 +
:<nowiki>==Time at McNair==</nowiki>
 +
:<nowiki>[[Full Name (Work Log)]]</nowiki> ''(Replace ''Full Name'' with your name.)''
 +
 +
==About Work Logs==
 +
 
Work logs are used to track your progress and tasks for each workday. Here are some general rules when setting up your work log:  
 
Work logs are used to track your progress and tasks for each workday. Here are some general rules when setting up your work log:  
 
*Divide your work log by semesters (fall, spring, summer) followed by the year with sub-section header formatting (=== wrapping).
 
*Divide your work log by semesters (fall, spring, summer) followed by the year with sub-section header formatting (=== wrapping).
 
*Log everything in reverse chronological order (most recent first) so that it's easier to read.
 
*Log everything in reverse chronological order (most recent first) so that it's easier to read.
*For daily logging, put the date in YYYY-MM-DD format followed by a colon and then whatever you did that day.  
+
*For daily logging, put the date in YYYY-MM-DD format followed by a colon and then whatever you did that day. You don't have to include time.
*[http://mcnair.bakerinstitute.org/wiki/Help:Editing_Content#Transclusion Transclude] your current semester's work to the master log by wrapping the logs of this semester with <nowiki><onlyinclude></nowiki> tags. Include <nowiki>[[Full Name]] [[Work Logs]] [[Full Name (Work Log)|(log page)]]</nowiki> after that tag. ''You will need to move these every semester so that the master work log is updated.'' See the Example Work Log below for more information.
 
*At the very bottom of your log page, include <nowiki>[[Category:Work Log]]</nowiki> to categorize your page.
 
 
 
'''For inactive members:''' If you are/will be no longer working, put <nowiki><onlyinclude></nowiki> tags around <nowiki>[[Full Name]] [[Work Logs]] [[Full Name (Work Log)|(log page)]]</nowiki> in your work log on one line.  
 
  
 
'''Remember to add yourself to the master log as well as create a link to your work log on your user profile page.  
 
'''Remember to add yourself to the master log as well as create a link to your work log on your user profile page.  
Line 12: Line 35:
 
==Example Work Log==
 
==Example Work Log==
  
'''For active members'''
+
===For active members===
  
 
<nowiki>===Fall 2017===</nowiki> ''(The most recent semester goes on top.)''
 
<nowiki>===Fall 2017===</nowiki> ''(The most recent semester goes on top.)''
Line 20: Line 43:
 
<nowiki>[[Full Name]] [[Work Logs]] [[Full Name (Work Log)|(log page)]]</nowiki> ''(This allows you to be directed to your user profile, your own work log, and the master work log. You can also see which page you're currently on. Replace ''Full Name'' with your first and last name.)''
 
<nowiki>[[Full Name]] [[Work Logs]] [[Full Name (Work Log)|(log page)]]</nowiki> ''(This allows you to be directed to your user profile, your own work log, and the master work log. You can also see which page you're currently on. Replace ''Full Name'' with your first and last name.)''
  
<nowiki>YYYY-MM-DD: Description here.</nowiki> ''(The most recent date goes on top in the format ''YYY-MM-DD'' followed by the work you did for the day. Put line breaks between every day.)''
+
<nowiki>YYYY-MM-DD: Description here.</nowiki> ''(The most recent date goes on top in the format ''YYYY-MM-DD'' followed by the work you did for the day. Put line breaks between every day.)''
  
 
<nowiki>YYYY-MM-DD: Description here.</nowiki>
 
<nowiki>YYYY-MM-DD: Description here.</nowiki>
Line 44: Line 67:
 
<nowiki>[[Category:Work Log]]</nowiki> ''(Include this at the very end of your work log.)''
 
<nowiki>[[Category:Work Log]]</nowiki> ''(Include this at the very end of your work log.)''
  
 
+
===For inactive members===
'''For inactive members'''
 
  
 
<nowiki><onlyinclude>[[Full Name]] [[Work Logs]] [[Full Name (Work Log)|(log page)]]</onlyinclude></nowiki>
 
<nowiki><onlyinclude>[[Full Name]] [[Work Logs]] [[Full Name (Work Log)|(log page)]]</onlyinclude></nowiki>
Line 62: Line 84:
  
 
<nowiki>[[Category:Work Log]]</nowiki>
 
<nowiki>[[Category:Work Log]]</nowiki>
 
==Master Work Log==
 
The master work log can be found [http://mcnair.bakerinstitute.org/wiki/Work_Logs here].
 
 
After creating your work log, add yourself to the master work log under your designated category (e.g. Technical) by adding this text:
 
:<nowiki>==Full Name==</nowiki> ''(Replace ''Full Name'' with your name.)''
 
:<nowiki>{{:Full Name (Work Log)}}</nowiki>
 
 
==User Profile Work Log==
 
Add a link to your work log in your user profile by adding this text at the bottom:
 
:<nowiki>==Time at McNair==</nowiki>
 
:<nowiki>[[Full Name (Work Log)]]</nowiki> ''(Replace ''Full Name'' with your name.)''
 

Latest revision as of 11:00, 7 March 2019

Creating a Work Log

Every team member should have a work log. To create a work log make a page on wiki called Full Name (Work Log).

Note that you can do this by either searching for that page or by linking to it and then following the link.

Then:

  • Include [[Full Name]] [[Work Logs]] [[Full Name (Work Log)|(log page)]] at the top of your new work log page.
  • Transclude your current semester's work to the master log by wrapping the log of this semester, including the header your just made, with <onlyinclude> tags.
  • At the very bottom of your log page, include [[Category:Work Log]] to categorize your page.

Master Work Log

The master [Work Log] includes extracts of everyone's individual work logs.

After creating your work log, add yourself to the master work log under your designated category (e.g. Technical) by adding this text:

==Full Name== (Replace Full Name with your name.)
{{:Full Name (Work Log)}}

User Profile Work Log Link

Add a link to your work log in your user profile by adding this text at the bottom:

==Time at McNair==
[[Full Name (Work Log)]] (Replace Full Name with your name.)

About Work Logs

Work logs are used to track your progress and tasks for each workday. Here are some general rules when setting up your work log:

  • Divide your work log by semesters (fall, spring, summer) followed by the year with sub-section header formatting (=== wrapping).
  • Log everything in reverse chronological order (most recent first) so that it's easier to read.
  • For daily logging, put the date in YYYY-MM-DD format followed by a colon and then whatever you did that day. You don't have to include time.

Remember to add yourself to the master log as well as create a link to your work log on your user profile page.

Example Work Log

For active members

===Fall 2017=== (The most recent semester goes on top.)

<onlyinclude> (Wrap this tag around the current semester's work so it'll be included in the master work log page.)

[[Full Name]] [[Work Logs]] [[Full Name (Work Log)|(log page)]] (This allows you to be directed to your user profile, your own work log, and the master work log. You can also see which page you're currently on. Replace Full Name with your first and last name.)

YYYY-MM-DD: Description here. (The most recent date goes on top in the format YYYY-MM-DD followed by the work you did for the day. Put line breaks between every day.)

YYYY-MM-DD: Description here.

YYYY-MM-DD: Description here.

YYYY-MM-DD: Description here.

...

</onlyinclude> (Include the closing tag at the end of the current semester.)

===Spring 2017===

YYYY-MM-DD: Description here.

YYYY-MM-DD: Description here.

YYYY-MM-DD: Description here.

...

[[Category:Work Log]] (Include this at the very end of your work log.)

For inactive members

<onlyinclude>[[Full Name]] [[Work Logs]] [[Full Name (Work Log)|(log page)]]</onlyinclude>

===Fall 2017=== (The most recent semester goes on top.)

YYYY-MM-DD: Description here. (The most recent date goes on top in the format YYY-MM-DD followed by the work you did for the day. Put line breaks between every day.)

YYYY-MM-DD: Description here.

YYYY-MM-DD: Description here.

YYYY-MM-DD: Description here.

...

[[Category:Work Log]]