Skip to content

Latest commit

 

History

History
218 lines (148 loc) · 4.41 KB

STYLEGUIDE.md

File metadata and controls

218 lines (148 loc) · 4.41 KB
Raw

DSNP Style Guide

Style guide defining wording, spelling, and other details regarding how DSNP terms are referenced.

For more information about DSNP, visit dsnp.org or DSNP on GitHub

General rules

  • Announcements specific to DSNP have initial caps. (i.e., Broadcast Announcement)
  • Announcement Types also have initial caps.
  • General words that aren't specific to DSNP are lowercase (i.e., announcement, batch, content hash).
  • Attribute is lowercase except when combined with an announcement or a specific DSNP set type. (i.e., Attribute Set Announcement)

Activity Content

Uppercase A and C

announcement

Generally all lowercase

Announcement Type

Uppercase A and T

attribute

All lowercase

attribute sets

All lowercase

Attribute Set Announcement

Uppercase A, S and A

Attribute Set Type

Uppercase A, S and T

Attribute Set Value Document

Uppercase A, S, V and D

batch

All lowercase

Batch Publication

Uppercase B and P

bloom filter

lowercase b and f

Broadcast Announcements

Uppercase B and A

Code of Conduct

Uppercase C and C

community

All lowercase

content announcement

All lowercase

Content Attribute Set

content hash

All lowercase

credential document

All lowercase

Decentralized Social Networking Protocol (DSNP)

Spelled out fully first time it appears and then acronym thereafter. Avoid preceding with the word "the" and never follow with the word "protocol".

development community

All lowercase

DSNP Announcements

Uppercase DSNP and A

DSNP public social graph

All lowercase after acronym

DSNP Batch Publications

Uppercase Acronym plus uppercase B and P

DSNP content

Uppercase acronym, lowercase c

DSNP Content Hash

Uppercase Acronym plus uppercase C and H

DSNP Content URI

Uppercase D, C and URI

DSNP graph

Only acronym is uppercase

DSNP Identifiers

Uppercase Acronym plus uppercase I

DSNP identity

Uppercase Acronym lowercase i

DSNP Id

Short for DSNP identity, Uppercase Acronym lowercase when spelled out

DSNP Protocol Scheme

Uppercase Acronym plus uppercase P and S

DSNP Specification

Uppercase DSNP and S, avoid preceding with the word "the"

DSNP user

Uppercase DSNP and lowercase u

DSNP User Id

Uppercase acronym, U and I, avoid preceding with the word "the"

DSNP User URI

Uppercase Acronyms plus uppercase U

Exclamation Marks

Should be avoided

External Content Attributes

Uppercase E, C and A

Graph Change Announcements

Uppercase G, C and A. Note: Graph Change Announcements and events have been migrated to use User Data Operations as of version 1.2.0.

Graph Change event

Uppercase G and C lowercase e. Note: Graph Change Announcements and events have been migrated to use User Data Operations as of version 1.2.0.

InterPlanetary File System (IPFS)

Uppercase I, P, F and S. In the first instance, spell out followed by the acronym in parentheses. Use the acronym only thereafter.

issuer

All lower case

MUST/MUST NOT

All Caps when defining rules for specification

on-demand credential

Hyphenated, all lower case

Operation

Uppercase O when referring to spec-defined DSNP Operations

Oxford Comma

Always use

Possessives

Making DSNP possessive should be avoided (e.g. DSNP’s)

Profile Announcement

Uppercase P and A

Project Liberty

Uppercase P and L

public key

All lowercase

public graph

All lowercase

Public Key Announcement

Uppercase P, K and A

Reaction Announcement

Uppercase R and A

Record

Uppercase R when referring to spec-defined DSNP State Change Records

Reply Announcements

Uppercase R and A

schema

All lowercase

social network graph

All lowercase

Team

Should not be used in context with DSNP

Tombstone Announcement

Uppercase T and A

User Attribute Set Announcement

Uppercase U, A, S and A

verifier

Lowercase v

Verifiable Credential

Uppercase V and C. Singular for one document/credential; plural when referring to the specification. If followed by "document", that should be lowercase.

Verifiable Credential Schema

Uppercase V, C, S. If followed by "document", that should be lowercase.

Update Announcement

Uppercase U and A

user

All lowercase

User Attribute Set

Uppercase U, A and S

verifier

All lowercase

We/Us/Our

Should not be used in context with Frequency

YES and no

When describing required items, use an all caps "YES", otherwise a lowercase "no".