Skip to content

Document ID

Leon Starr edited this page Jul 24, 2026 · 1 revision

I picked up my document naming convention from Sally Shlaer herself and never stopped using it:

Organization name, system name possibly followed by subsystem or any other focusing qualifiers ending with td for technical document or tn for technical note or any other document type qualifier followed by a number.

Document ID : mint.elevator3.td.7

Documents are generally things that are source materials that are used to generate other artifacts like code. So they are typically maintained like code whereas notes are anything from a screenshot of a note scrawled on a whiteboard to a detailed study of some topic.

And I often use bk referencing background docs sourced by other people or organizations.

Each state model in a domain gets its own number in the sequence. In the Elevator Management domain, for example, the Door state machine is td.7 while the Transfer state machine is td.5 and the R53 assigner is td.10.

Again, the grammar just sees an unstructured string.

Clone this wiki locally