Difference: DrewPilcherSandbox (1 vs. 23)

Revision 232013-05-07 - DrewPilcher

Line: 1 to 1
Changed:
<
<
>
>

%BLUEDIV% Hello hi! %ENDDIV%

Revision 222013-05-07 - DrewPilcher

Line: 1 to 1
Changed:
<
<

Test

  • Machine's name: markus002.student.cs.uwaterloo.ca
    • May be moved to another server in the winter term
  • Server's name:
    • Server1
    • Server2
>
>

Revision 212013-05-06 - DrewPilcher

Line: 1 to 1
 

Test

Deleted:
<
<
 
  • Machine's name: markus002.student.cs.uwaterloo.ca
    • May be moved to another server in the winter term

Revision 202013-05-06 - DrewPilcher

Line: 1 to 1
Changed:
<
<

The Name of the Page

>
>

Test

 
Changed:
<
<		A high-level description of the system

System Specifications

Hardware

Key hardware information related to the system.

Should be formatted as a list:

  • Hardware: Specification
  • Another hardware: Specification
If more than one specification applies, you may put the multiple specifications in a sub-list. If any details need to be added to any aspect of a specification, these can be added as a sub-list underneath the relevant specification.

Some examples:

>
>
 
  • Machine's name: markus002.student.cs.uwaterloo.ca
    • May be moved to another server in the winter term
  • Server's name:
    • Server1
    • Server2
Deleted:
<
<

Software

Key software information related to the system

  • Server OS: Linux or Windows?
  • Databases and their types

Authentication and Authorization Information

Many systems demand authentication before they can be accessed. List the information required to gain access to the system. Please do not put passwords on this page. This page will be public and accessible by Google.

People

People that may need to be contacted when working with this system

  • Administrator: Yan Martel
  • Point of contact (expert): Wilbur Smith
  • Stakeholders:
This section should be formatted as a list of stakeholders with a sub-list outlining some details specific to each stakeholder. These details will vary significantly, however they should generally include what makes them a stakeholder, what they commonly require from USG, and the name of the stakeholder's primary contact. For example:
  • Stakeholders:
    • CS 100
      • Requires system for use in assignments
      • Usually requires approximately 200 accounts
      • Primary contact: Arthur Conan Doyle (ext. 22790)
    • CS 136
      • Requires system for assignments
      • ...

Terminology

Unique terminology that might be required while performing tasks on this system

should be formatted as a list of terms, where each term has a definition in the form of a sub-list:

  • Definitum
    • Definition
  • Definitum
    • Definition
  • ...
For example:
  • Definitum
    • In a definition the word being defined is the definitum
    • Is a fancy word that nobody ever really uses
  • MarkUs
    • A marking system in which students can submit their code and faculty can provide feedback and assign grades
    • Originates from the University of Toronto
CAUTION: There is a feature for terminology in the Wiki Markup Language. Do not use it. It has been known to break pages.

Guides to the Completion of Scheduled Tasks

Some tasks must be completed on a regular basis. List the scheduled tasks from least frequently recurring to most frequently recurring. Each one must have a detailed guide on how to go about completing the task and how often/when the task must be completed. Try to be as detailed as possible. Use the following the formatting:

Level-3 heading with the frequency of occurrence. (More than one task can be under this heading)

Level-4 heading with a very general description of the task

A paragraph outlining the purpose of doing the task

  1. Description of step
    • Details and notes about how to complete the step
    • Details and notes about how to complete the step
  2. ...

Check for Success

How to see if the scheduled task was completed successfully

For example:

Between Every Term

Empty the database

Keeps things clean and organized

  1. Log in to the database.
    • This is a secure connection
  2. Run the purge command
  3. log out
    • The logout button is at the top-right of the page

Check for Success

Try to return an entry from the database. If it cannot find the entry, the database was emptied successfully.

Another Example, also completed between every term

This example will help you understand

  1. Do this
  2. Do that
  3. Now do something fancy

Check for Success

How to know if it worked

On the First Day of Every Month

Task Name

A really good purpose

  1. Do this
  2. Do that
  3. Now do something fancy

Check for Success

How to know if it worked

Guides to the Completion of Common Requests

This section outlines the guides to completing tasks that are commonly requested by clients

Formatting should be similar to the guides to the completion of scheduled tasks section

Level-3 heading with a very high-level description of the request

  1. Description of step
    • Details and notes about how to complete the step
    • Details and notes about how to complete the step
  2. ...

Check for Success

How to see if the requested task was completed successfully

For example:

Set Up an Exam

  1. Log into the system for setting up exams
  2. ...

Check for Success

A list of students and where they will be seated for their exam is outputted

Common Failures/Bugs & Troubleshooting

This section outlines some issues that have been known to occur with the system, along with details on how to fix them and when they occur.

Each section should be formatted like so:

A level-3 heading that describes the issue

Optional paragraph text that describes the potential causes of the issue

Optional paragraph text to direct which how-to steps should be followed (only applicable if there is more than one possible cause of the issue such that more than one how-to is needed)

A level-4 heading that describes the issue that this section will address. If there is only one how-to that will be included for this current issue, this heading may be omitted.

Optional paragraph text to provide any information that might be needed before beginning the how-to

A level-5 heading that says, "Test for Applicability of Fix"
  1. A test to determine if the issue addressed by the current section is what is causing the described problem (to prevent maintainers from addressing the wrong issue)
    • Formatted as an ordered list of steps
    • If the test is really simple, describing it in a small paragraph will suffice (instead of using the list format).
A level-5 heading that says, "Steps to Fix the Issue"
  1. A series of steps to fix the issue
    • Formatted as an ordered list of steps
    • If the fix is really simple, describing it in a small paragraph will suffice instead of using the list format.
A level-5 heading that says, "Test for Successful Fix"
  1. A test that will pass if and only if the issue is resolved.
    • Formatted as an ordered list of steps
    • If the test is really simple, describing it in a small paragraph will suffice (instead of using the list format).

Current Discussions Related to the System

Some systems have important long-term changes that are being discussed. If needed, a summary of each discussion may be included here.

See Also

Related material to learn more about the system.

Related ST Items

Formatted in a list.

For example:

Related Twiki Pages

Formatted in a list.

For example:

Related EDocs

Formatted in a list.

For example:

  • EDoc 1
  • EDoc 2
  • ...

Related External Links

Formatted in a list.

For example:

Revision 192013-05-06 - DrewPilcher

Line: 1 to 1
 

The Name of the Page

Changed:
<
<		Insert a high-level description of the system
>
>		A high-level description of the system
 
Line: 128 to 128
 

Guides to the Completion of Common Requests

Changed:
<
<		This section outlines the guides to completing tasks that are commonly requested by stakeholders
>
>		This section outlines the guides to completing tasks that are commonly requested by clients
  Formatting should be similar to the guides to the completion of scheduled tasks section

Level-3 heading with a very high-level description of the request

Revision 182013-04-26 - DrewPilcher

Line: 1 to 1
 

The Name of the Page

Changed:
<
<		A high-level description of the system
>
>		 Insert a high-level description of the system
 

System Specifications

Hardware

Changed:
<
<		 Key hardware information related to the system.
>
>		 Key hardware information related to the system.
  Should be formatted as a list:
  • Hardware: Specification
Line: 24 to 24
 

Software

Changed:
<
<		 Key software information related to the system
>
>		 Key software information related to the system
 
  • Server OS: Linux or Windows?
  • Databases and their types
Line: 34 to 35
 Many systems demand authentication before they can be accessed. List the information required to gain access to the system. Please do not put passwords on this page. This page will be public and accessible by Google.

People

Added:
>
>
 People that may need to be contacted when working with this system
  • Administrator: Yan Martel
  • Point of contact (expert): Wilbur Smith
  • Stakeholders:
Changed:
<
<
This section should be formatted as a list of stakeholders with a sub-list outlining some details specific to each stakeholder. These details will vary significantly, however they should generally include what makes them a stakeholder, what they commonly require from USG, and the name of the stakeholder's primary contact. For example:
>
>
This section should be formatted as a list of stakeholders with a sub-list outlining some details specific to each stakeholder. These details will vary significantly, however they should generally include what makes them a stakeholder, what they commonly require from USG, and the name of the stakeholder's primary contact. For example:
 
  • Stakeholders:
    • CS 100
      • Requires system for use in assignments
Line: 50 to 51
 
      • Requires system for assignments
      • ...
Added:
>
>
 

Terminology

Changed:
<
<		 Unique terminology that might be required while performing tasks on this system
>
>		 Unique terminology that might be required while performing tasks on this system
  should be formatted as a list of terms, where each term has a definition in the form of a sub-list:
  • Definitum
Line: 78 to 79
 Some tasks must be completed on a regular basis. List the scheduled tasks from least frequently recurring to most frequently recurring. Each one must have a detailed guide on how to go about completing the task and how often/when the task must be completed. Try to be as detailed as possible. Use the following the formatting:

Level-3 heading with the frequency of occurrence. (More than one task can be under this heading)

Level-4 heading with a very general description of the task

Added:
>
>
 A paragraph outlining the purpose of doing the task
Changed:
<
<
  1. Description of step
>
>
  1. Description of step
 
    • Details and notes about how to complete the step
    • Details and notes about how to complete the step
Changed:
<
<
  1. ...
>
>
  1. ...
 

Check for Success

Added:
>
>
 How to see if the scheduled task was completed successfully

For example:

Line: 90 to 93
 

Between Every Term

Empty the database

Added:
>
>
 Keeps things clean and organized
Changed:
<
<
  1. Log in to the database.
>
>
  1. Log in to the database.
 
    • This is a secure connection
Changed:
<
<
  1. Run the purge command
  2. log out
>
>
  1. Run the purge command
  2. log out
 
    • The logout button is at the top-right of the page

Check for Success

Added:
>
>
 Try to return an entry from the database. If it cannot find the entry, the database was emptied successfully.

Another Example, also completed between every term

Line: 100 to 105
 Try to return an entry from the database. If it cannot find the entry, the database was emptied successfully.

Another Example, also completed between every term

Added:
>
>
 This example will help you understand
Changed:
<
<
  1. Do this
  2. Do that
  3. Now do something fancy
>
>
  1. Do this
  2. Do that
  3. Now do something fancy
 

Check for Success

Added:
>
>
 How to know if it worked

On the First Day of Every Month

Line: 109 to 116
 

On the First Day of Every Month

Task Name

Added:
>
>
 A really good purpose
Changed:
<
<
  1. Do this
  2. Do that
  3. Now do something fancy
>
>
  1. Do this
  2. Do that
  3. Now do something fancy
 

Check for Success

Added:
>
>
 How to know if it worked

Guides to the Completion of Common Requests

Changed:
<
<		This section outlines the guides to completing tasks that are commonly requested by clients
>
>		 This section outlines the guides to completing tasks that are commonly requested by stakeholders
  Formatting should be similar to the guides to the completion of scheduled tasks section

Level-3 heading with a very high-level description of the request

Changed:
<
<
  1. Description of step
>
>
  1. Description of step
 
    • Details and notes about how to complete the step
    • Details and notes about how to complete the step
Changed:
<
<
  1. ...
>
>
  1. ...
 

Check for Success

Added:
>
>
 How to see if the requested task was completed successfully

For example:

Set Up an Exam

Changed:
<
<
  1. Log into the system for setting up exams
>
>
  1. Log into the system for setting up exams
 
Changed:
<
<
  1. ...
>
>
  1. ...
 

Check for Success

Added:
>
>
 A list of students and where they will be seated for their exam is outputted

Common Failures/Bugs & Troubleshooting

Line: 148 to 162
 Optional paragraph text to direct which how-to steps should be followed (only applicable if there is more than one possible cause of the issue such that more than one how-to is needed)

A level-4 heading that describes the issue that this section will address. If there is only one how-to that will be included for this current issue, this heading may be omitted.

Added:
>
>
 Optional paragraph text to provide any information that might be needed before beginning the how-to
A level-5 heading that says, "Test for Applicability of Fix"
Changed:
<
<
  1. A test to determine if the issue addressed by the current section is what is causing the described problem (to prevent maintainers from addressing the wrong issue)
>
>
  1. A test to determine if the issue addressed by the current section is what is causing the described problem (to prevent maintainers from addressing the wrong issue)
 
    • Formatted as an ordered list of steps
    • If the test is really simple, describing it in a small paragraph will suffice (instead of using the list format).
A level-5 heading that says, "Steps to Fix the Issue"
Changed:
<
<
  1. A series of steps to fix the issue
>
>
  1. A series of steps to fix the issue
 
    • Formatted as an ordered list of steps
    • If the fix is really simple, describing it in a small paragraph will suffice instead of using the list format.
A level-5 heading that says, "Test for Successful Fix"
Changed:
<
<
  1. A test that will pass if and only if the issue is resolved.
>
>
  1. A test that will pass if and only if the issue is resolved.
 
    • Formatted as an ordered list of steps
    • If the test is really simple, describing it in a small paragraph will suffice (instead of using the list format).
Line: 164 to 179
 

Current Discussions Related to the System

Added:
>
>
  Some systems have important long-term changes that are being discussed. If needed, a summary of each discussion may be included here.

See Also

Changed:
<
<		 Related material to learn more about the system.
>
>		 Related material to learn more about the system.
 

Related ST Items

Changed:
<
<		 Formatted in a list.
>
>		 Formatted in a list.
  For example:

Revision 172013-04-16 - DrewPilcher

Line: 1 to 1
 

The Name of the Page

A high-level description of the system
Line: 41 to 41
 
This section should be formatted as a list of stakeholders with a sub-list outlining some details specific to each stakeholder. These details will vary significantly, however they should generally include what makes them a stakeholder, what they commonly require from USG, and the name of the stakeholder's primary contact. For example:
Changed:
<
<
  • Major clients:
>
>
  • Stakeholders:
 
    • CS 100
      • Requires system for use in assignments
      • Usually requires approximately 200 accounts

Revision 162013-03-06 - DrewPilcher

Line: 1 to 1
 

The Name of the Page

A high-level description of the system
Line: 65 to 65
  For example:
  • Definitum
Changed:
<
<
    • In a defintion the word being defined is the definitum
>
>
    • In a definition the word being defined is the definitum
 
    • Is a fancy word that nobody ever really uses
  • MarkUs
    • A marking system in which students can submit their code and faculty can provide feedback and assign grades
Line: 133 to 133
 

Set Up an Exam

  1. Log into the system for setting up exams
Changed:
<
<
    • use your Watiam credentials
>
>
 
  1. ...

Check for Success

A list of students and where they will be seated for their exam is outputted
Line: 149 to 149
 

A level-4 heading that describes the issue that this section will address. If there is only one how-to that will be included for this current issue, this heading may be omitted.

Optional paragraph text to provide any information that might be needed before beginning the how-to
Changed:
<
<
A level-5 heading that says, "Test for Applicabiilty of Fix"
>
>
A level-5 heading that says, "Test for Applicability of Fix"
 
  1. A test to determine if the issue addressed by the current section is what is causing the described problem (to prevent maintainers from addressing the wrong issue)
    • Formatted as an ordered list of steps
    • If the test is really simple, describing it in a small paragraph will suffice (instead of using the list format).
Line: 196 to 196
  For example:
  • EDoc 1
Changed:
<
<
  • Edoc 2
>
>
  • EDoc 2
 
  • ...

Revision 152013-03-06 - DrewPilcher

Line: 1 to 1
Changed:
<
<

The Name of the Page

>
>

The Name of the Page

 A high-level description of the system
Line: 76 to 76
 

Guides to the Completion of Scheduled Tasks

Some tasks must be completed on a regular basis. List the scheduled tasks from least frequently recurring to most frequently recurring. Each one must have a detailed guide on how to go about completing the task and how often/when the task must be completed. Try to be as detailed as possible. Use the following the formatting:
Changed:
<
<

Level-3 heading with the frequency of occurrence. (More than one task can be under this heading)

Level-4 heading with a very general description of the task

>
>

Level-3 heading with the frequency of occurrence. (More than one task can be under this heading)

Level-4 heading with a very general description of the task

 A paragraph outlining the purpose of doing the task
  1. Description of step
    • Details and notes about how to complete the step
Line: 88 to 88
  For example:
Changed:
<
<

Between Every Term

Empty the database

>
>

Between Every Term

Empty the database

 Keeps things clean and organized
  1. Log in to the database.
    • This is a secure connection
Line: 99 to 99
 

Check for Success

Try to return an entry from the database. If it cannot find the entry, the database was emptied successfully.
Changed:
<
<

Another Example, also completed between every term

>
>

Another Example, also completed between every term

 This example will help you understand
  1. Do this
  2. Do that
Line: 107 to 107
 

Check for Success

How to know if it worked
Changed:
<
<

On the First Day of Every Month

Task Name

>
>

On the First Day of Every Month

Task Name

 A really good purpose
  1. Do this
  2. Do that
Line: 121 to 121
 This section outlines the guides to completing tasks that are commonly requested by clients

Formatting should be similar to the guides to the completion of scheduled tasks section

Changed:
<
<

Level-3 heading with a very high-level description of the request

>
>

Level-3 heading with a very high-level description of the request

 
  1. Description of step
    • Details and notes about how to complete the step
    • Details and notes about how to complete the step
Line: 130 to 130
 How to see if the requested task was completed successfully

For example:

Changed:
<
<

Set Up an Exam

>
>

Set Up an Exam

 
  1. Log into the system for setting up exams
    • located at insert_url
    • use your Watiam credentials
Line: 142 to 142
 This section outlines some issues that have been known to occur with the system, along with details on how to fix them and when they occur.

Each section should be formatted like so:

Changed:
<
<

A level-3 heading that describes the issue

>
>

A level-3 heading that describes the issue

 Optional paragraph text that describes the potential causes of the issue

Optional paragraph text to direct which how-to steps should be followed (only applicable if there is more than one possible cause of the issue such that more than one how-to is needed)

Revision 142013-03-05 - DrewPilcher

Line: 1 to 1
 

The Name of the Page

A high-level description of the system
Line: 83 to 83
 
    • Details and notes about how to complete the step
    • Details and notes about how to complete the step
  1. ...
Changed:
<
<

Check for Success

>
>

Check for Success

 How to see if the scheduled task was completed successfully

For example:

Line: 96 to 96
 
  1. Run the purge command
  2. log out
    • The logout button is at the top-right of the page
Changed:
<
<

Check for Success

>
>

Check for Success

 Try to return an entry from the database. If it cannot find the entry, the database was emptied successfully.

Another Example, also completed between every term

Line: 104 to 104
 
  1. Do this
  2. Do that
  3. Now do something fancy
Changed:
<
<

Check for Success

>
>

Check for Success

 How to know if it worked

On the First Day of Every Month

Line: 114 to 114
 
  1. Do that
  2. Now do something fancy
Changed:
<
<

Check for Success

>
>

Check for Success

 How to know if it worked

Guides to the Completion of Common Requests

Line: 126 to 126
 
    • Details and notes about how to complete the step
    • Details and notes about how to complete the step
  1. ...
Changed:
<
<

Check for Success

>
>

Check for Success

 How to see if the requested task was completed successfully

For example:

Line: 135 to 135
 
    • located at insert_url
    • use your Watiam credentials
  1. ...
Changed:
<
<

Check for Success

>
>

Check for Success

 A list of students and where they will be seated for their exam is outputted

Common Failures/Bugs & Troubleshooting

Revision 132013-03-01 - DrewPilcher

Line: 1 to 1
 

The Name of the Page

A high-level description of the system
Changed:
<
<
>
>
 

System Specifications

Hardware

Line: 31 to 31
 

Authentication and Authorization Information

Changed:
<
<		Some systems demand authentication before they can be accessed. List the information required to gain access to the system. Please do not put passwords on this page. This page will be public and accessible by Google.
>
>		Many systems demand authentication before they can be accessed. List the information required to gain access to the system. Please do not put passwords on this page. This page will be public and accessible by Google.
 

People

People that may need to be contacted when working with this system
  • Administrator: Yan Martel
  • Point of contact (expert): Wilbur Smith
Changed:
<
<
  • Major clients:
>
>
  • Stakeholders:
 
Changed:
<
<		 Should be formatted as a list of clients with a sub-list outlining some details specific to each client. These details will vary significantly, however they should generally include how each client uses the system, what they commonly require from USG, and the name of the primary contact. For example:
>
>
This section should be formatted as a list of stakeholders with a sub-list outlining some details specific to each stakeholder. These details will vary significantly, however they should generally include what makes them a stakeholder, what they commonly require from USG, and the name of the stakeholder's primary contact. For example:
 
  • Major clients:
    • CS 100
      • Requires system for use in assignments
Line: 48 to 49
 
    • CS 136
      • Requires system for assignments
      • ...
Added:
>
>
 

Terminology

Changed:
<
<		Terminology that might be required while performing tasks on this system
>
>		Unique terminology that might be required while performing tasks on this system
  should be formatted as a list of terms, where each term has a definition in the form of a sub-list:
  • Definitum
Line: 77 to 79
 

Level-3 heading with the frequency of occurrence. (More than one task can be under this heading)

Level-4 heading with a very general description of the task

A paragraph outlining the purpose of doing the task
Changed:
<
<
  1. Step #
    • Description of step
>
>
  1. Description of step
 
      • Details and notes about how to complete the step
      • Details and notes about how to complete the step
Deleted:
<
<
    • ...
 
  1. ...
Changed:
<
<		Test: A test case that will only pass if the scheduled task has been done successfully
>
>

Check for Success

How to see if the scheduled task was completed successfully
  For example:

Between Every Term

Empty the database

Keeps things clean and organized
Changed:
<
<
  1. Step 1
  2. Step 2
    • Run the :purge command
  3. Step 3
    • log out
Test: Try to return an entry from the database. If it cannot find the entry, the database was emptied successfully.
>
>
  1. Log in to the database.
    • This is a secure connection
  2. Run the purge command
  3. log out
    • The logout button is at the top-right of the page

Check for Success

Try to return an entry from the database. If it cannot find the entry, the database was emptied successfully.
 

Another Example, also completed between every term

This example will help you understand
Changed:
<
<
  1. Step 1
    • Do this
  2. Step 2
    • Do that
  3. Step 3
    • Now do something fancy
Test: How to know if it worked
>
>
  1. Do this
  2. Do that
  3. Now do something fancy

Check for Success

How to know if it worked
 

On the First Day of Every Month

Task Name

A really good purpose
Changed:
<
<
  1. Step 1
    • Do this
  2. Step 2
    • Do that
  3. Step 3
    • Now do something fancy
Test: How to know if it worked
>
>
  1. Do this
  2. Do that
  3. Now do something fancy

Check for Success

How to know if it worked
 

Guides to the Completion of Common Requests

Changed:
<
<		 This section outlines the guides to completing tasks that are commonly requested by clients
>
>		This section outlines the guides to completing tasks that are commonly requested by clients
  Formatting should be similar to the guides to the completion of scheduled tasks section

Level-3 heading with a very high-level description of the request

Changed:
<
<
  1. Step #
    • Description of step
>
>
  1. Description of step
 
      • Details and notes about how to complete the step
      • Details and notes about how to complete the step
Deleted:
<
<
    • ...
 
  1. ...
Changed:
<
<		A test case that will pass iff the request's procedure was completed successfully
>
>

Check for Success

How to see if the requested task was completed successfully
  For example:

Set Up an Exam

Changed:
<
<
  1. Step 1
    • Log into the system for setting up exams
>
>
  1. Log into the system for setting up exams
 
      • located at insert_url
      • use your Watiam credentials
Changed:
<
<
  1. Step 2
    • ...
A list of students and where they will be seated for their exam is outputted

>
>
  1. ...

Check for Success

A list of students and where they will be seated for their exam is outputted
 

Common Failures/Bugs & Troubleshooting

Changed:
<
<		 This section outlines some issues that have been known to occur with the system, along with details on how to fix them when they occur.
>
>		This section outlines some issues that have been known to occur with the system, along with details on how to fix them and when they occur.
  Each section should be formatted like so:

A level-3 heading that describes the issue

Line: 156 to 147
  Optional paragraph text to direct which how-to steps should be followed (only applicable if there is more than one possible cause of the issue such that more than one how-to is needed)
Changed:
<
<

A level-4 heading that describes the issue that this section will address. If there is only one how-to that will be included for this current issue, this heading may be omitted. If the heading is omitted, all sub-headings in this section must decrease by one level (i.e. level 4 would become level 3). If more than one how-to will be present, this heading and all of its subheadings shuold be reapeated as necessary.

A level-5 heading describing the part of the system that this how-to will fix
>
>

A level-4 heading that describes the issue that this section will address. If there is only one how-to that will be included for this current issue, this heading may be omitted.

 Optional paragraph text to provide any information that might be needed before beginning the how-to
Changed:
<
<
A level-6 heading that says, "Test for Applicabiilty of Fix"
>
>
A level-5 heading that says, "Test for Applicabiilty of Fix"
 
  1. A test to determine if the issue addressed by the current section is what is causing the described problem (to prevent maintainers from addressing the wrong issue)
    • Formatted as an ordered list of steps
    • If the test is really simple, describing it in a small paragraph will suffice (instead of using the list format).
Changed:
<
<
A level-6 heading that says, "Steps to Fix the Issue"
>
>
A level-5 heading that says, "Steps to Fix the Issue"
 
  1. A series of steps to fix the issue
    • Formatted as an ordered list of steps
    • If the fix is really simple, describing it in a small paragraph will suffice instead of using the list format.
Changed:
<
<
A level-6 heading that says, "Test for Successful Fix"
>
>
A level-5 heading that says, "Test for Successful Fix"
 
  1. A test that will pass if and only if the issue is resolved.
    • Formatted as an ordered list of steps
    • If the test is really simple, describing it in a small paragraph will suffice (instead of using the list format).

Revision 122013-02-20 - DrewPilcher

Line: 1 to 1
 

The Name of the Page

A high-level description of the system

Revision 112013-02-13 - DrewPilcher

Line: 1 to 1
 

The Name of the Page

A high-level description of the system
Line: 30 to 30
 
  • Databases and their types
Changed:
<
<

Important Passwords

Some systems require passwords to access key parts for maintenance. List those passwords here.
>
>

Authentication and Authorization Information

Some systems demand authentication before they can be accessed. List the information required to gain access to the system. Please do not put passwords on this page. This page will be public and accessible by Google.
 

People

People that may need to be contacted when working with this system
Line: 69 to 69
 
    • A marking system in which students can submit their code and faculty can provide feedback and assign grades
    • Originates from the University of Toronto
Changed:
<
<		CAUTION: There is a feature for terminology in the Wiki Markup Language. Do not use it. It has been known to render pages inaccessible.

Set-up Instructions for new Implementations of the System

A section with a how-to that will be used when the system needs to be put on a new machine or server.

Formatted as a list:

  1. Step #
    • Do this
  2. Step #
    • Do that
  3. Step #
    • Now do something fancy
>
>		CAUTION: There is a feature for terminology in the Wiki Markup Language. Do not use it. It has been known to break pages.
 

Guides to the Completion of Scheduled Tasks

Some tasks must be completed on a regular basis. List the scheduled tasks from least frequently recurring to most frequently recurring. Each one must have a detailed guide on how to go about completing the task and how often/when the task must be completed. Try to be as detailed as possible. Use the following the formatting:

Level-3 heading with the frequency of occurrence. (More than one task can be under this heading)

Level-4 heading with a very general description of the task

Changed:
<
<		A paragraph outlining the purpose of doing such a task
>
>		A paragraph outlining the purpose of doing the task
 
  1. Step #
    • Description of step
      • Details and notes about how to complete the step
Line: 164 to 151
 This section outlines some issues that have been known to occur with the system, along with details on how to fix them when they occur.

Each section should be formatted like so:

Changed:
<
<

A level-2 heading that describes the issue

>
>

A level-3 heading that describes the issue

 Optional paragraph text that describes the potential causes of the issue

Optional paragraph text to direct which how-to steps should be followed (only applicable if there is more than one possible cause of the issue such that more than one how-to is needed)

Changed:
<
<

A level-3 heading that describes the issue that this section will address. If there is only one how-to that will be included for this current issue, this heading may be omitted. If the heading is omitted, all sub-headings in this section must decrease by one level (i.e. level 3 would become level 2). If more than one how-to will be present, this heading and all of its subheadings shuodl be reapeated as necessary.

A level-4 heading describing the part of the system that this how-to will fix

>
>

A level-4 heading that describes the issue that this section will address. If there is only one how-to that will be included for this current issue, this heading may be omitted. If the heading is omitted, all sub-headings in this section must decrease by one level (i.e. level 4 would become level 3). If more than one how-to will be present, this heading and all of its subheadings shuold be reapeated as necessary.

A level-5 heading describing the part of the system that this how-to will fix
 Optional paragraph text to provide any information that might be needed before beginning the how-to
Changed:
<
<
A level-5 heading that says, "Test for Applicabiilty of Fix"
>
>
A level-6 heading that says, "Test for Applicabiilty of Fix"
 
  1. A test to determine if the issue addressed by the current section is what is causing the described problem (to prevent maintainers from addressing the wrong issue)
    • Formatted as an ordered list of steps
    • If the test is really simple, describing it in a small paragraph will suffice (instead of using the list format).
Changed:
<
<

A level-5 heading that says, "Steps to Fix the Issue"

>
>
A level-6 heading that says, "Steps to Fix the Issue"
 
  1. A series of steps to fix the issue
    • Formatted as an ordered list of steps
    • If the fix is really simple, describing it in a small paragraph will suffice instead of using the list format.
Changed:
<
<
A level-5 heading that says, "Test for Successful Fix"
>
>
A level-6 heading that says, "Test for Successful Fix"
 
  1. A test that will pass if and only if the issue is resolved.
    • Formatted as an ordered list of steps
    • If the test is really simple, describing it in a small paragraph will suffice (instead of using the list format).

Revision 102013-02-11 - DrewPilcher

Line: 1 to 1
 

The Name of the Page

A high-level description of the system
Changed:
<
<
>
>
 

System Specifications

Hardware

Line: 231 to 231
 
Deleted:
<
<		Pages currently using the template MarkUs Printing Support

Revision 92013-02-04 - DrewPilcher

Line: 1 to 1
 

The Name of the Page

A high-level description of the system
Line: 13 to 13
 
  • Hardware: Specification
  • Another hardware: Specification
Changed:
<
<		If more than one specification applies, you may put the multiple specifications in a sub-list.
>
>		If more than one specification applies, you may put the multiple specifications in a sub-list. If any details need to be added to any aspect of a specification, these can be added as a sub-list underneath the relevant specification.
  Some examples:
  • Machine's name: markus002.student.cs.uwaterloo.ca
Added:
>
>
    • May be moved to another server in the winter term
 
  • Server's name:
    • Server1
    • Server2
Line: 38 to 39
 
  • Point of contact (expert): Wilbur Smith
  • Major clients:
Changed:
<
<		 Should be formatted as a list of clients with a sub-list outlining some details specific to each client. These details will vary significantly, however they should generally include how each client uses the system, what they commonly require from USG, and who the primary contact is. For example:
>
>		 Should be formatted as a list of clients with a sub-list outlining some details specific to each client. These details will vary significantly, however they should generally include how each client uses the system, what they commonly require from USG, and the name of the primary contact. For example:
 
  • Major clients:
    • CS 100
      • Requires system for use in assignments
      • Usually requires approximately 200 accounts
Changed:
<
<
      • Primary contact: Arthur Conan Doyle
>
>
      • Primary contact: Arthur Conan Doyle (ext. 22790)
 
    • CS 136
      • Requires system for assignments
      • ...
Changed:
<
<

Terminology

>
>

Terminology

  Terminology that might be required while performing tasks on this system
Line: 70 to 69
 
    • A marking system in which students can submit their code and faculty can provide feedback and assign grades
    • Originates from the University of Toronto
Changed:
<
<		CAUTION: There is a feature for terminology in the Wiki Markup Language. Do not use it. It has been known to render pages inaccessible.
>
>		CAUTION: There is a feature for terminology in the Wiki Markup Language. Do not use it. It has been known to render pages inaccessible.
 
Changed:
<
<

Set-up Instructions for new Implementations of the System

>
>

Set-up Instructions for new Implementations of the System

  A section with a how-to that will be used when the system needs to be put on a new machine or server.
Line: 88 to 86
 

Guides to the Completion of Scheduled Tasks

Changed:
<
<		Some tasks must be completed on a regular basis. List the scheduled tasks from least frequently recurring to most frequently recurring. Each one must have a detailed guide on how to go about completing the task and how often/when the task must be completed. Try to be as detailed as possible. Use the following the formatting:

Level-3 heading with the frequency of occurrence. (More than one task can be under this heading)

Level-4 heading with a very general description of the task

>
>		Some tasks must be completed on a regular basis. List the scheduled tasks from least frequently recurring to most frequently recurring. Each one must have a detailed guide on how to go about completing the task and how often/when the task must be completed. Try to be as detailed as possible. Use the following the formatting:

Level-3 heading with the frequency of occurrence. (More than one task can be under this heading)

Level-4 heading with a very general description of the task

 A paragraph outlining the purpose of doing such a task
  1. Step #
    • Description of step
Line: 104 to 100
  For example:
Changed:
<
<

Between Every Term

Empty the database

>
>

Between Every Term

Empty the database

 Keeps things clean and organized
  1. Step 1
Line: 115 to 111
 
    • log out
Test: Try to return an entry from the database. If it cannot find the entry, the database was emptied successfully.
Changed:
<
<

Another Example, also completed between every term

>
>

Another Example, also completed between every term

 This example will help you understand
  1. Step 1
    • Do this
Line: 125 to 121
 
    • Now do something fancy
Test: How to know if it worked
Changed:
<
<

On the First Day of Every Month

Task Name

>
>

On the First Day of Every Month

Task Name

 A really good purpose
  1. Step 1
    • Do this
Line: 142 to 138
 This section outlines the guides to completing tasks that are commonly requested by clients

Formatting should be similar to the guides to the completion of scheduled tasks section

Changed:
<
<

Level-3 heading with a very high-level description of the request

>
>

Level-3 heading with a very high-level description of the request

 
  1. Step #
    • Description of step
      • Details and notes about how to complete the step
Line: 152 to 148
 A test case that will pass iff the request's procedure was completed successfully

For example:

Changed:
<
<

Set Up an Exam

>
>

Set Up an Exam

 
  1. Step 1
    • Log into the system for setting up exams
Line: 165 to 161
 

Common Failures/Bugs & Troubleshooting

Changed:
<
<		This section outlines some issues that have been known to occur with the system, along with details on how to fix them should they become an issue.
>
>		This section outlines some issues that have been known to occur with the system, along with details on how to fix them when they occur.
 
Changed:
<
<		Each section should come with the following information:
  • A heading that describes the error
  • A test to determine if the issue addressed by the current section is causing the problem that is being described (to prevent maintainers from addressing the wrong issue)
  • A list of steps that will address the issue, assuming that the aforementioned test was true
  • A test that will only pass if the problem has been resolved
>
>		Each section should be formatted like so:

A level-2 heading that describes the issue

Optional paragraph text that describes the potential causes of the issue

Optional paragraph text to direct which how-to steps should be followed (only applicable if there is more than one possible cause of the issue such that more than one how-to is needed)

A level-3 heading that describes the issue that this section will address. If there is only one how-to that will be included for this current issue, this heading may be omitted. If the heading is omitted, all sub-headings in this section must decrease by one level (i.e. level 3 would become level 2). If more than one how-to will be present, this heading and all of its subheadings shuodl be reapeated as necessary.

A level-4 heading describing the part of the system that this how-to will fix

Optional paragraph text to provide any information that might be needed before beginning the how-to
A level-5 heading that says, "Test for Applicabiilty of Fix"
  1. A test to determine if the issue addressed by the current section is what is causing the described problem (to prevent maintainers from addressing the wrong issue)
    • Formatted as an ordered list of steps
    • If the test is really simple, describing it in a small paragraph will suffice (instead of using the list format).

A level-5 heading that says, "Steps to Fix the Issue"

  1. A series of steps to fix the issue
    • Formatted as an ordered list of steps
    • If the fix is really simple, describing it in a small paragraph will suffice instead of using the list format.
A level-5 heading that says, "Test for Successful Fix"
  1. A test that will pass if and only if the issue is resolved.
    • Formatted as an ordered list of steps
    • If the test is really simple, describing it in a small paragraph will suffice (instead of using the list format).
 
Added:
>
>

Current Discussions Related to the System

Some systems have important long-term changes that are being discussed. If needed, a summary of each discussion may be included here.
 

See Also

Related material to learn more about the system.
Line: 218 to 231
 
Added:
>
>		Pages currently using the template MarkUs Printing Support

Revision 82013-02-04 - DrewPilcher

Line: 1 to 1
Changed:
<
<

The name of the page

>
>

The Name of the Page

 A high-level description of the system
Line: 163 to 163
 
Changed:
<
<

Common Failures/bugs & Troubleshooting

>
>

Common Failures/Bugs & Troubleshooting

  This section outlines some issues that have been known to occur with the system, along with details on how to fix them should they become an issue.

Revision 72013-01-31 - DrewPilcher

Line: 1 to 1
 

The name of the page

A high-level description of the system

Revision 62013-01-29 - DrewPilcher

Line: 1 to 1
 

The name of the page

A high-level description of the system
Line: 88 to 88
 

Guides to the Completion of Scheduled Tasks

Changed:
<
<		Some tasks must be completed on a regular basis. List the scheduled tasks from least frequently recurring to most frequently recurring. Each one must have a detailed guide on how to go about completing the task and how often/when the task must be completed. Try to be as detailed as possible. Use the following the formatting:
>
>		Some tasks must be completed on a regular basis. List the scheduled tasks from least frequently recurring to most frequently recurring. Each one must have a detailed guide on how to go about completing the task and how often/when the task must be completed. Try to be as detailed as possible. Use the following the formatting:
 

Level-3 heading with the frequency of occurrence. (More than one task can be under this heading)

Level-4 heading with a very general description of the task

A paragraph outlining the purpose of doing such a task
Line: 180 to 180
  Related material to learn more about the system.
Changed:
<
<

Important ST Items Related to the System.

>
>

Related ST Items

  Formatted in a list.
Line: 214 to 214
 Formatted in a list.

For example:

Changed:
<
<
>
>
 

Revision 52013-01-22 - DrewPilcher

Line: 1 to 1
 

The name of the page

A high-level description of the system

Revision 42013-01-21 - DrewPilcher

Line: 1 to 1
Changed:
<
<

The name of the page

>
>

The name of the page

 A high-level description of the system
Line: 15 to 15
  If more than one specification applies, you may put the multiple specifications in a sub-list.
Changed:
<
<		Examples:
>
>		Some examples:
 
  • Machine's name: markus002.student.cs.uwaterloo.ca
  • Server's name:
    • Server1
Line: 91 to 91
 Some tasks must be completed on a regular basis. List the scheduled tasks from least frequently recurring to most frequently recurring. Each one must have a detailed guide on how to go about completing the task and how often/when the task must be completed. Try to be as detailed as possible. Use the following the formatting:
Changed:
<
<

Level-3 heading with the frequency of occurrence. (More than one task can be under this heading)

Level-4 heading with a very general description of the task

>
>

Level-3 heading with the frequency of occurrence. (More than one task can be under this heading)

Level-4 heading with a very general description of the task

 A paragraph outlining the purpose of doing such a task
  1. Step #
    • Description of step
Line: 100 to 100
 
      • Details and notes about how to complete the step
    • ...
  1. ...
Added:
>
>		Test: A test case that will only pass if the scheduled task has been done successfully
  For example:
Changed:
<
<

Between Every Term

Empty the database

>
>

Between Every Term

Empty the database

 Keeps things clean and organized
  1. Step 1
Line: 112 to 113
 
    • Run the :purge command
  1. Step 3
    • log out
Added:
>
>		Test: Try to return an entry from the database. If it cannot find the entry, the database was emptied successfully.
 
Changed:
<
<

Another Example

To help understand
>
>

Another Example, also completed between every term

This example will help you understand
 
  1. Step 1
    • Do this
  2. Step 2
    • Do that
  3. Step 3
    • Now do something fancy
Added:
>
>		Test: How to know if it worked
 
Changed:
<
<

On the First Day of Every Month

Task Name

>
>

On the First Day of Every Month

Task Name

 A really good purpose
  1. Step 1
    • Do this
Line: 131 to 134
 
    • Do that
  1. Step 3
    • Now do something fancy
Added:
>
>		Test: How to know if it worked
 

Guides to the Completion of Common Requests

Line: 138 to 142
 This section outlines the guides to completing tasks that are commonly requested by clients

Formatting should be similar to the guides to the completion of scheduled tasks section

Changed:
<
<

Level-3 heading with a very high-level description of the request

>
>

Level-3 heading with a very high-level description of the request

 
  1. Step #
    • Description of step
      • Details and notes about how to complete the step
      • Details and notes about how to complete the step
    • ...
  2. ...
Added:
>
>		A test case that will pass iff the request's procedure was completed successfully
  For example:
Changed:
<
<

Set Up an Exam

>
>

Set Up an Exam

 
  1. Step 1
    • Log into the system for setting up exams
      • located at insert_url
      • use your Watiam credentials
  2. Step 2
    • ...
Added:
>
>		A list of students and where they will be seated for their exam is outputted
 
Line: 195 to 201
 
Added:
>
>

Related EDocs

Formatted in a list.

For example:

  • EDoc 1
  • Edoc 2
  • ...
 

Related External Links

Formatted in a list.

Revision 32013-01-17 - DrewPilcher

Line: 1 to 1
 

The name of the page

A high-level description of the system
Changed:
<
<		!
>
>
 

System Specifications

Deleted:
<
<		Key information related to the system.
 

Hardware

Key hardware information related to the system.
Line: 35 to 33
 Some systems require passwords to access key parts for maintenance. List those passwords here.

People

Changed:
<
<		Key contacts for maintenance purposes
>
>		People that may need to be contacted when working with this system
 
  • Administrator: Yan Martel
  • Point of contact (expert): Wilbur Smith
  • Major clients:
Changed:
<
<		 Should be formatted as a list of clients with a sub-list outlining some details specific to each client. These details will vary significantly, however they should generally include how each client uses the system, what they commonly require from USG, and who the primary contact is. For example:
>
>		 Should be formatted as a list of clients with a sub-list outlining some details specific to each client. These details will vary significantly, however they should generally include how each client uses the system, what they commonly require from USG, and who the primary contact is. For example:
 
  • Major clients:
    • CS 100
      • Requires system for use in assignments
      • Usually requires approximately 200 accounts
Changed:
<
<
      • Primary contact is Arthur Conan Doyle
>
>
      • Primary contact: Arthur Conan Doyle
 
    • CS 136
      • Requires system for assignments
      • ...
Line: 71 to 70
 
    • A marking system in which students can submit their code and faculty can provide feedback and assign grades
    • Originates from the University of Toronto
Changed:
<
<		CAUTION: There is a feature for terminology in the Wiki Markup Language. Do not use it. It has been known to render pages inaccessible.
>
>		CAUTION: There is a feature for terminology in the Wiki Markup Language. Do not use it. It has been known to render pages inaccessible.
 
Changed:
<
<

Set-up instructions for new implementations of the system

>
>

Set-up Instructions for new Implementations of the System

  A section with a how-to that will be used when the system needs to be put on a new machine or server.
Line: 87 to 87
 
    • Now do something fancy
Changed:
<
<

Guides to the completion of scheduled tasks

Some tasks must be completed on a regular basis List the scheduled tasks from least frequently recurring to most frequently recurring. Each one must have a detailed guide on how to go about completing the task and how often/when the task must be completed. Try to be as detailed as possible. Use the following the formatting:
>
>

Guides to the Completion of Scheduled Tasks

Some tasks must be completed on a regular basis. List the scheduled tasks from least frequently recurring to most frequently recurring. Each one must have a detailed guide on how to go about completing the task and how often/when the task must be completed. Try to be as detailed as possible. Use the following the formatting:
 

Level-3 heading with the frequency of occurrence. (More than one task can be under this heading)

Level-4 heading with a very general description of the task

A paragraph outlining the purpose of doing such a task
Line: 102 to 103
  For example:
Changed:
<
<

Between every term

>
>

Between Every Term

 

Empty the database

Keeps things clean and organized
  1. Step 1
Line: 112 to 113
 
  1. Step 3
    • log out
Changed:
<
<

Another example

>
>

Another Example

 To help understand
  1. Step 1
    • Do this
Line: 121 to 122
 
  1. Step 3
    • Now do something fancy
Changed:
<
<

On the first day of every month

Task name

>
>

On the First Day of Every Month

Task Name

A really good purpose
 
  1. Step 1
    • Do this
  2. Step 2
Line: 131 to 133
 
    • Now do something fancy
Changed:
<
<

Guides to the completion of common requests

>
>

Guides to the Completion of Common Requests

  This section outlines the guides to completing tasks that are commonly requested by clients
Line: 145 to 147
 
  1. ...

For example:

Changed:
<
<

Set up an exam

>
>

Set Up an Exam

 
  1. Step 1
    • Log into the system for setting up exams
Changed:
<
<
>
>
 
      • use your Watiam credentials
  1. Step 2
    • ...

Changed:
<
<

Common failures/bugs & Troubleshooting

>
>

Common Failures/bugs & Troubleshooting

 
Changed:
<
<		This section outlines some issues that have been known to occur with the system, along with details on how to fix them should they become an issue.
>
>		This section outlines some issues that have been known to occur with the system, along with details on how to fix them should they become an issue.
  Each section should come with the following information:
  • A heading that describes the error
Changed:
<
<
  • A test to determine if the issue addressed by the current section is causing the problem that is being described (to prevent maintainers from addressing the wrong issue)
>
>
  • A test to determine if the issue addressed by the current section is causing the problem that is being described (to prevent maintainers from addressing the wrong issue)
 
  • A list of steps that will address the issue, assuming that the aforementioned test was true
  • A test that will only pass if the problem has been resolved
Line: 170 to 174
  Related material to learn more about the system.
Changed:
<
<

Important ST items related to the system.

>
>

Important ST Items Related to the System.

  Formatted in a list.

For example:

Changed:
<
<
>
>
 
Changed:
<
<

Relate Twiki pages

example:
>
>

Related Twiki Pages

Formatted in a list.

For example:

 
Added:
>
>

Related External Links

Formatted in a list.

For example:

 

Revision 22013-01-16 - DrewPilcher

Line: 1 to 1
Changed:
<
<

DrewPilcherSandbox

A high-level description of the system
>
>

The name of the page

A high-level description of the system
 
Changed:
<
<
>
>		!
 

System Specifications

Key information related to the system.

Hardware

Changed:
<
<		Key hardware information related to the system. Examples include:
>
>		 Key hardware information related to the system.
 
Added:
>
>		Should be formatted as a list:
  • Hardware: Specification
  • Another hardware: Specification

If more than one specification applies, you may put the multiple specifications in a sub-list.

Examples:

 * Machine's name: markus002.student.cs.uwaterloo.ca
Changed:
<
<		* Server's name: ...
>
>
  • Server's name:
    • Server1
    • Server2
 

Software

Changed:
<
<
>
>		 Key software information related to the system
 * Server OS: Linux or Windows? * Databases and their types
Added:
>
>
 

Important Passwords

Changed:
<
<		Some systems require passwords to access key parts for maintenance. List those passwords here.
>
>		Some systems require passwords to access key parts for maintenance. List those passwords here.
 

People

Key contacts for maintenance purposes
Changed:
<
<		* Administrator: Yan Martel * Point of contact (expert): Wilbur Smith
>
>
  • Administrator: Yan Martel
  • Point of contact (expert): Wilbur Smith
  • Major clients:
Should be formatted as a list of clients with a sub-list outlining some details specific to each client. These details will vary significantly, however they should generally include how each client uses the system, what they commonly require from USG, and who the primary contact is. For example:
 * Major clients:
Deleted:
<
<
 * CS 100
  • Requires system for use in assignments
  • Usually requires approximately 200 accounts
  • Primary contact is Arthur Conan Doyle
Changed:
<
<
>
>
    • CS 136
      • Requires system for assignments
      • ...
 

Terminology

Added:
>
>
 Terminology that might be required while performing tasks on this system
Changed:
<
<
>
>		 should be formatted as a list of terms, where each term has a definition in the form of a sub-list:

  • Definitum
    • Definition
  • Definitum
    • Definition
  • ...

For example:

  • Definitum
    • In a defintion the word being defined is the definitum
    • Is a fancy word that nobody ever really uses
 * MarkUs
  • A marking system in which students can submit their code and faculty can provide feedback and assign grades
  • Originates from the University of Toronto
Changed:
<
<		* Another definitum
  • Definition
  • More definition
>
>		 CAUTION: There is a feature for terminology in the Wiki Markup Language. Do not use it. It has been known to render pages inaccessible.
 

Set-up instructions for new implementations of the system

Changed:
<
<		 1. Step 1
>
>		 A section with a how-to that will be used when the system needs to be put on a new machine or server.

Formatted as a list:

  1. Step #
 
  • Do this
Changed:
<
<		1. Step 2
>
>
  1. Step #
 
  • Do that
Changed:
<
<		1. Step 3
>
>
  1. Step #
 
  • Now do something fancy
Changed:
<
<
>
>
 

Guides to the completion of scheduled tasks

Some tasks must be completed on a regular basis
Changed:
<
<		List the scheduled tasks from least frequently required to most frequently required. Each one must have a detailed guide on how to go about completing the task and how often/when the task must be completed. Try to be as detailed as possible Follow the formatting shown below:
>
>		List the scheduled tasks from least frequently recurring to most frequently recurring. Each one must have a detailed guide on how to go about completing the task and how often/when the task must be completed. Try to be as detailed as possible. Use the following the formatting:

Level-3 heading with the frequency of occurrence. (More than one task can be under this heading)

Level-4 heading with a very general description of the task

A paragraph outlining the purpose of doing such a task
  1. Step #
    • Description of step
      • Details and notes about how to complete the step
      • Details and notes about how to complete the step
    • ...
  2. ...

For example:

 
Changed:
<
<

Between terms

>
>

Between every term

 

Empty the database

Added:
>
>		Keeps things clean and organized
 1. Step 1
Changed:
<
<
>
>
 1. Step 2
  • Run the :purge command
1. Step 3
  • log out

Another example

Added:
>
>		To help understand
 1. Step 1
  • Do this
1. Step 2
Line: 83 to 128
 1. Step 2
  • Do that
1. Step 3
Changed:
<
<
  • Now do something fancy
>
>
    • Now do something fancy
 
Changed:
<
<

Common requests (how-to's)

>
>

Guides to the completion of common requests

 This section outlines the guides to completing tasks that are commonly requested by clients
Changed:
<
<

Exam setup

>
>		 Formatting should be similar to the guides to the completion of scheduled tasks section

Level-3 heading with a very high-level description of the request

  1. Step #
    • Description of step
      • Details and notes about how to complete the step
      • Details and notes about how to complete the step
    • ...
  2. ...

For example:

Set up an exam

 1. Step 1
Changed:
<
<
  • Do this
>
>
    • Log into the system for setting up exams
 1. Step 2
Changed:
<
<
  • Do that
1. Step 3
  • Now do something fancy
>
>
    • ...

 

Common failures/bugs & Troubleshooting

Changed:
<
<		This section outlines some issues that have been known to occur with this system, along with details on how to fix them should they become an issue.
>
>		 This section outlines some issues that have been known to occur with the system, along with details on how to fix them should they become an issue.
 Each section should come with the following information: * A heading that describes the error * A test to determine if the issue addressed by the current section is causing the problem that is being described (to prevent maintainers from addressing the wrong issue)
Changed:
<
<		* A list of steps that will address the issue, assuming the the aforementioned test was true
>
>
  • A list of steps that will address the issue, assuming that the aforementioned test was true
 * A test that will only pass if the problem has been resolved
Changed:
<
<
>
>
 

See Also

Changed:
<
<		Related material to learn more about the system.
>
>		 Related material to learn more about the system.
 

Important ST items related to the system.

Changed:
<
<		example: * * *
>
>		 Formatted in a list.

For example:

 

Relate Twiki pages

example:
Changed:
<
<		* * *
>
>
 

Revision 12013-01-15 - DrewPilcher

Line: 1 to 1
Added:
>
>

DrewPilcherSandbox

A high-level description of the system

System Specifications

Key information related to the system.

Hardware

Key hardware information related to the system. Examples include:

* Machine's name: markus002.student.cs.uwaterloo.ca * Server's name: ...

Software

* Server OS: Linux or Windows? * Databases and their types

Important Passwords

Some systems require passwords to access key parts for maintenance. List those passwords here.

People

Key contacts for maintenance purposes * Administrator: Yan Martel * Point of contact (expert): Wilbur Smith * Major clients: * CS 100
  • Requires system for use in assignments
  • Usually requires approximately 200 accounts
  • Primary contact is Arthur Conan Doyle

Terminology

Terminology that might be required while performing tasks on this system * MarkUs
  • A marking system in which students can submit their code and faculty can provide feedback and assign grades
  • Originates from the University of Toronto
* Another definitum
  • Definition
  • More definition

Set-up instructions for new implementations of the system

1. Step 1
  • Do this
1. Step 2
  • Do that
1. Step 3
  • Now do something fancy

Guides to the completion of scheduled tasks

Some tasks must be completed on a regular basis List the scheduled tasks from least frequently required to most frequently required. Each one must have a detailed guide on how to go about completing the task and how often/when the task must be completed. Try to be as detailed as possible Follow the formatting shown below:

Between terms

Empty the database

1. Step 1 1. Step 2
  • Run the :purge command
1. Step 3
  • log out

Another example

1. Step 1
  • Do this
1. Step 2
  • Do that
1. Step 3
  • Now do something fancy

On the first day of every month

Task name

1. Step 1
  • Do this
1. Step 2
  • Do that
1. Step 3
  • Now do something fancy

Common requests (how-to's)

This section outlines the guides to completing tasks that are commonly requested by clients

Exam setup

1. Step 1
  • Do this
1. Step 2
  • Do that
1. Step 3
  • Now do something fancy

Common failures/bugs & Troubleshooting

This section outlines some issues that have been known to occur with this system, along with details on how to fix them should they become an issue. Each section should come with the following information: * A heading that describes the error * A test to determine if the issue addressed by the current section is causing the problem that is being described (to prevent maintainers from addressing the wrong issue) * A list of steps that will address the issue, assuming the the aforementioned test was true * A test that will only pass if the problem has been resolved

See Also

Related material to learn more about the system.

Important ST items related to the system.

example: * * *

Relate Twiki pages

example: * * *
View topic | History: r23 < r22 < r21 < r20 | More topic actions...
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 2008-2025 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback