Description
| F´ Version | |
| Affected Component | Docs/website |
Feature Description
Need a document that describes how to call and spell out F Prime and FPP. Where to publish on the website is TBD (maybe docs/reference?)
Content, as provided by Jeff, below:
Nomenclature
F Prime Nomenclature Reference
The name chosen for our ecosystem invites several different ways of representing it in print. This guide provides the official representations for both formal and informal documents.
The representation can be in both long and short forms.
Long form name representation: F Prime
Application: All Communication.
Notes: Capital F, capital P, with space in between. No dashes, underscores, lower case ‘f’ and ‘p’ or missing space unless being used as a variable or filename or similar.
Short form name representation - formal: F′
Application: All Communication, notably presentations, papers, posters, user guides, proposals, etc.
Notes: Capital F followed by the prime symbol. You can add a prime symbol in PowerPoint, Word or Outlook by bringing up the Insert header, choosing Symbols, and selecting the prime symbol from the pop-up symbol list.
Short form name representation – informal: F’
Application: Informal communication like email.
Notes: Capital F followed by apostrophe.
Usage
Generally the long and short forms can be used interchangeably, with a couple exceptions. In formal narrative documents (like papers or presentations), the first use of the name should be in the long form with subsequent uses in the short form as one would use an acronym (or can stick with the long form throughout). In major headers or banners where it is likely that the name will be seen for the first time by a wide audience, use the full name (long form) only.
F Prime Prime Nomenclature Reference
The name for the software modeling front end domain specific language also has a long and short form.
Long form name representation: F Prime Prime
Application: All Communication.
Notes: Referring to it as “F double-prime” is acceptable in informal verbal communication, but not in print.
Short form name representation: FPP
Referencing by short name (all communication): FPP
Application: All Communication.
Notes: Why is it F′ for the framework but not F′′ for the DSL? Because that’s the way it is! If you need a reason, it’s because FPP is easier to distinguish from F′ than F′′. But that’s not the reason!