Difference: DrewPilcherSandbox (19 vs. 20)
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 SpecificationsHardwareKey hardware information related to the system. Should be formatted as a list:
Some examples: | |||||||
| > > | ||||||||
| ||||||||
| Deleted: | ||||||||
| < < |
SoftwareKey software information related to the system
Authentication and Authorization InformationMany 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.
PeoplePeople that may need to be contacted when working with this system
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:
TerminologyUnique 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:
Guides to the Completion of Scheduled TasksSome 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 taskA paragraph outlining the purpose of doing the task
Check for SuccessHow to see if the scheduled task was completed successfully For example:
Between Every TermEmpty the databaseKeeps things clean and organized
Check for SuccessTry to return an entry from the database. If it cannot find the entry, the database was emptied successfully.
Another Example, also completed between every termThis example will help you understand
Check for SuccessHow to know if it worked
On the First Day of Every MonthTask NameA really good purpose
Check for SuccessHow to know if it worked
Guides to the Completion of Common RequestsThis 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
Check for SuccessHow to see if the requested task was completed successfully For example: Set Up an Exam
Check for SuccessA list of students and where they will be seated for their exam is outputted
Common Failures/Bugs & TroubleshootingThis 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 issueOptional 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"
A level-5 heading that says, "Steps to Fix the Issue"
A level-5 heading that says, "Test for Successful Fix"
Current Discussions Related to the SystemSome systems have important long-term changes that are being discussed. If needed, a summary of each discussion may be included here.
See AlsoRelated material to learn more about the system. Related ST ItemsFormatted in a list. For example:
Related Twiki PagesFormatted in a list. For example:
Related EDocsFormatted in a list. For example:
Related External LinksFormatted in a list. For example: | |||||||
Copyright © 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