User:Jrkenti/Convention

General Formatting[edit]

All MediaWiki formatting is acceptable. There is lots of descriptions on this formatting here.

Look at the source code of any CIS page to get examples.

CIS-specific formatting[edit]

There is a lot of convention and several rules.

Document Approval[edit]

All documents that are part of our Quality Management System

need to include a 'Quality Assurance' section at the bottom of the page. This section can be easily added by inserting the 'Quality Assurance' template. Below the template the document author needs to also include the list of document approvers (one or more subject-matter experts, zero or more managers, and Document Control). The approvers themselves will later add their signatures beside their names.
need to be signed by approvers at the bottom of the page. Signatures in MediaWiki include usernames and date/time stamps. They can easily be added by editing the section of the page needing signatures and inserting four tilda characters (~~~~). This short string will be converted to a full signature of the user when the page is saved.
- - more information than you wanted: Automated scripts on the server scour all pages looking for special cases:
    - review pages where the most recent date is older than 1 year & the approved revision is also older than 1 year (such pages need to be reviewed).
    - training pages where the most recent date for each name on the page is older than 1 year and the user is still active (such pages need to be retrained).
    - unapproved revisions that are NEWER than the approved revision that have more than 0 signatures but fewer than the required number of signatures, excluding DocCon (remaining approvers need to sign).
    - unapproved revisions that are NEWER than the approved revision that have all signatures except DocCon (DocCon needs to sign, and approve)
    - unapproved revisions that are NEWER than the approved revision but older than 1 year (proceed with the update, or promote the approved revision to newest)
    - newest revisions that are unapproved and have signatures older than (or equal to) the approved revision (need to be deleted immediately: signatures cannot be carried over)
    - namespace:main pages that have been edited to include a signature of another user need to be deleted immediately (signing for another person is strictly verboten)
need to be released as approved documents after they are fully signed. This approval process is achieved through an extension to the MediaWiki software: it creates a single official 'approver' (Document Control), whose editing of a document (adding a signature) causes a that revision of the document to become the the 'approved revision'. All links to the page will point to the latest approved revision.
need to include a 'Review' subpage. A link to the subpage is automatically added with the 'Quality Assurance' template, but the page itself must also be set up. It should initially just include the 'Review Page Template'. Signatures will be added to the page with the yearly reviews.
need to include a 'Training' subpage. A link to the subpage is automatically added with the 'Quality Assurance' template, but the page itself must also be set up. It should initially just include the 'Training Page Template'. Signatures will be added to the page with the yearly retraining.

Safety[edit]

Safety requirements associated with any procedures should be added through one of the 'Safety Templates'. There is a list of these templates here. Additional templates can be made as necessary, or very specific templates can be created directly on a page.

Pictures[edit]

Some experience has shown that an effective way to include multiple pictures on the same line is through the 'multiple images' template. It is not necessary to use this particular template. Additional experience has shown that the {{-}} template is a nice way to ensure that text that should be after a picture does not show up beside the picture.

Special Cases[edit]

Additional templates exist for special cases

Some steps of some work instructions require the user to be grounded to prevent electrostatic discharge. These steps can be wrapped in the 'ESD' template to add extra emphasis.
Some steps of some work instructions dangerous chemicals. These steps can include a special warning via template.

Talk pages[edit]

Talk pages are additional space beside every main page. MediaWiki has given talk pages a slightly different set of rules than main pages. Talk pages can be used for any purpose deemed acceptable by the document owner. A few examples:

SWR No.	Status	Requester	Request Date	Last Update	Dept	Summary
SWR-001	Half done On hold	Jrkentii (talk)	17:14, 13 April 2022 (UTC)	28 March 2023	DT	Cats and Dogs
SWR-002	Approved	Jrkentii (talk)	17:14, 13 April 2022 (UTC)	28 March 2023	DT	mustard
SWR-003	Done	Jrkentii (talk)	17:14, 13 April 2022 (UTC)	28 March 2023	special	clean the floor

a	b	a/b
(65+3)	7	9.7142857142857
(60+3)	7	9
(55+3)	7	8.2857142857143
(50+3)	7	7.5714285714286
(45+3)	7	6.8571428571429
(40+3)	7	6.1428571428571
(35+3)	7	5.4285714285714
(30+3)	7	4.7142857142857
(25+3)	7	4
(20+3)	7	3.2857142857143
(15+3)	7	2.5714285714286
(10+3)	7	1.8571428571429