REFERENCE-MEMO-STANDARDS. Intro doc for WHISPERS department styleguide.
WHISP-0002.REFERENCE-MEMO-STANDARDS
- PREPARER(S)
- ██. ██████ █. █████ (WHISPERS.ARCHIVAL)
This document serves as a reference standard for other documents, prepared after ██████. All internal memos must be prepared according to these rules.
Prior to the official start of The Whispers Department many documents became misfiled and have been lost to time. This is unacceptable. Your job as a document author is to aid us in our mandate to keep this information referenceble from here unto eternity.
WHISP-0002.NAMING
Documents shall be primarily named according to their department, secondarily by a monotonically incrementing numeric identifier. Documents may grow in scope past their initial authoring and a more precise naming choice risks burdening archivists with misleading information about what is contained. This title must abide by a third rule: it is immutable. Once a document has entered the archives it MAY be amended and appended to, but it MAY NOT be renamed. Specifics:
- A document’s title MUST begin with a departmental categorization. WHISPERS reserves WHISP.
- A document’s title MUST include a unique numeric identifier within its category. If you are submitting a document and do not have trustworthy access to the latest numbers, submit with -NNNN.
- The first document in a category MUST be the category’s index. At minimum it MUST introduce the category’s full name and the scope of its subject matter.
Specifics departmental conventions apply, and are numerous. WHISPERS takes no firm stance on these choices beyond the above rules. We will offer advice, and hold office hours at SITE-01. Common recommendations:
- Due to the names frequent use, your category should be shortened. Preserving understanding is crucial, so we do not mandate a specific length.
- Choosing the appropriate numbering scheme is important. If your categorization is broad, a 4 digit scheme is generally appropriate. If you think a fifth number is necessary we advise establishing a narrower category. If you are considering a 2 digit scheme we advise using a broader category
WHISP-0002.DEPARTMENTS
- ART
- Artifacts
- DR
- Dimensional Research
- FAC
- Facilities
- GLASS
- Project Looking Glass
- IM
- Incident Management
- ISLES
- The Holy Isles
- NREACH
- The Northern Reaches
- OPS
- Operations
- M - Medical
- RD
- Research & Development
- WHISP
- Whispers
WHISP-0002.ORGANIZATION
Documents should be divided into sections to aid archivists in skimming.