Problem Reporting Guide

Overview

Each tool on the BNC Wiki has an Equipment Status Section at the top of the Wiki Page. This is used by users and BNC Staff to communicate the current status of a particular piece of equipment. All users are encouraged to show changed content in notification emails and Watch the tool pages of all equipment they are trained on. By doing both of these, users will be immediately notified of equipment issues via email.


Examples


This is a tool that is operating normally

StatusUP
Issue Date and Description
Estimated Fix Date and Comment

Responding Staff


This is a tool that has a problem, but still may be usable is the problem is taken into account

StatusPROBLEM
Issue Date and Description

01/23: Particle contamination, would require wipe out

Estimated Fix Date and Comment

01/25: Chamber will be lightly cleaned

Responding StaffDave Lubelski


This is a tool that is non-operational

StatusDOWN
Issue Date and Description

01/23: System contamination

Estimated Fix Date and Comment

02/20: Requires complete rebuild

Responding StaffDave Lubelski


Explanation

The top two lines of the Equipment Status Section should be set by users who encounter problems, or BNC staff who uncover an issue

Status: Set by a user or BNC staff member as UP, PROBLEM, or DOWN. This field is case insensitive, but the letters must be exact for it to show up on the repair page.

  • UP: Normal tool functionality
  • PROBLEM: Tool has a problem that restricts functionality, but it may be usable by some or all users if this is taken into account.
  • DOWN: The tool is unusable or effectively unusable to most or all users until the problem has been resolved. A tool in this state may not be used.

Other statuses set by BNC Staff for non-functional tools are:

  • Decomissioned
  • Shutdown - Longterm
  • WIP - Install

Issue Date and Description: Date (MM/DD) the issue was encountered/is being reported, and a brief description of the problem. Descriptions longer than a few words should be left as a comment on the tool page. If desired, this longer comment can be linked form the Issue description.

The bottom two lines of the Equipment Status Section are filled out by BNC staff in response to an issue, and should not be changed by users.

Estimated Fix Date and Comment: Will be updated by BNC Staff with the current estimated repair timeline. This can be hard to predict, and may frequently change in the course of a repair. Users should understand this is simply the current estimate, and should not confuse it for a guarantee or deadline. For staff, write the date as MM/DD. For the comment, a brief text comment may be left here explaining the current status of the fix.

Responding Staff: BNC Staff member taking charge of the fix.

Below is the master excerpt explanation to be displayed on each tool page.



Refer to the Material and Process Compatibility page for information on materials compatible with this tool.
Equipment Status
: Set as UP, PROBLEM, or DOWN, and report the issue date (MM/DD) and a brief description. Italicized fields will be filled in by BNC Staff in response to issues. See Problem Reporting Guide for more info.