# HG changeset patch # User František Kučera # Date 1654720721 -7200 # Node ID ae9effae2857be820abb2f24c3313aa2dcff8b54 # Parent ee9683c59746a9be80d289f2d99cb50db762f861 new chapter: „Names and identifiers“ diff -r ee9683c59746 -r ae9effae2857 text/ssm.en.xml --- a/text/ssm.en.xml Wed Jun 08 08:40:32 2022 +0200 +++ b/text/ssm.en.xml Wed Jun 08 22:38:41 2022 +0200 @@ -227,6 +227,60 @@ + Names and identifiers + a416d88d-6a8f-4219-85f4-367a89396da9 + + b231cf73-6509-45d4-96c4-79060bf4f7bd + recommendation + The name of the product and its significant parts should be reasonably unique, so it can be found using full-text search or other standard methods. + Significant part is e.g. a protocol, a file format or a CLI command. + Global uniqueness is not necessary – such name is not a unique identifier. Collisions cannot be completely avoided, but we should make reasonable efforts to prevent them. + + ebb8c013-a309-486d-b17b-04a73dd57969 + recommendation + Avoid generic words like common verbs, nouns or adjectives. + + + d923f626-5fd9-4e6d-8f16-af9711ac6e2e + recommendation + Avoid name collisions with well known and used software. + + + fc3fab39-dfaa-4b90-b51d-11e6b9bf3f2f + recommendation + Use company or organization name as part of the name if the name itself would be too generic (e.g. „Speed“ is wrong while „SaneCorp Speed“ is right). + + + + d71ec208-7657-4914-a00e-d9008c8d7138 + recommendation + For globally unique identifiers, the URI format is recommended. + + a60448ba-451d-4176-a3ef-fa537698dbc2 + information + Besides the uniqueness, the most important feature of it is immutability and stability. + + + fea4993c-7405-4755-b66a-68cd1f57637b + information + Identifiers can be derived from an internet domain, an OID or PEN number etc. + + + eb3bb5fa-a99e-4ffa-b27f-2f024e43f3eb + recommendation + When deriving from internet domains use the tag URI scheme to create timeless identifiers that are not affected by the changes in domain ownership. + + + aa0554cf-0cac-47c2-8075-54a84cb20e74 + recommendation + Use randomly generated identifiers when full decentralization is desired. These identifiers might be just random (e.g. UUID version 4) or derived from a public key (e.g. an SSH key or a Tor address) or a hash of a (secret) data. + When public key or a hash of secret data is used, then ownership of the name or namespace can be reliably proved. + Random identifiers must be picked from a sufficiently large space where we can assume that collisions are effectively eliminated. + + + + + Interfaces, formats and protocols d34ce339-197c-44ee-9e5c-6d7e212f8c10