Abbreviations
FusionReactor Abbreviation and Acronym Guide
Abbreviations and acronyms are shortened forms of words or phrases, used to conserve space and improve readability. In FusionReactor documentation, they should be used judiciously and consistently.
General Rules
- On first use, spell out the full term followed by the acronym in parentheses. Example: "FusionReactor (FR) is a powerful application monitoring tool."
- Capitalize spelled-out acronyms only if they contain proper nouns (e.g., product names, team names).
- Always abbreviate units of measurement unless otherwise specified.
- Spell out common words like "average" instead of abbreviating them, unless space is extremely limited.
- For common word abbreviations:
- Avoid using them at the beginning of a sentence.
- Add a period after the abbreviation (e.g., "avg.").
- For large numbers, spell out thousand, million, billion, trillion unless space is tight. If abbreviating, use: 30K, 30M, 30B, 30T.
- Don't use apostrophes to make acronyms plural: "JVMs" not "JVM's".
FusionReactor-Specific Abbreviations
Always spell out on first use:
- FR: FusionReactor
- FRAM: FusionReactor Application Monitor
- CDS: Chart Data Service
- UEM: User Experience Monitoring
- JDBC: Java Database Connectivity
- JVM: Java Virtual Machine
- APM: Application Performance Monitoring
- OTel: OpenTelemetry
Examples
| Do | Don't |
|---|---|
| The FusionReactor Application Monitor (FRAM) provides detailed insights. | The FRAM provides detailed insights. |
| The Chart Data Service (CDS) is an API for rendering data in charts. | The CDS is an API for rendering data in charts. |
| The User Experience Monitoring (UEM) feature tracks end-user interactions. | The UEM feature tracks end-user interactions. |
| 4 kilobytes | 4 KB (unless space is limited) |
| Average response time | Avg. response time |
| 50K requests per minute avg. | 50k requests per minute Avg., 50k rpm avg |
Units of Time
Spell out all units wherever possible. If space is limited, use these abbreviations:
| Unit | Preferred | Abbreviation (when necessary) |
|---|---|---|
| Millisecond | 4 milliseconds | 4 ms |
| Seconds | 5 seconds | 5 s |
| Minutes | 6 minutes | 6 min |
| Hours | 7 hours | 7 h |
| Days | 8 days | 8 d |
| Weeks | 9 weeks | 9 w |
| Months | 10 months | 10 mo |
| Years | 11 years | 11 yr |
FusionReactor-Specific Metrics
For FR-specific metrics, use these standard abbreviations consistently:
- CPU: Central Processing Unit
- RAM: Random Access Memory
- I/O: Input/Output
- DB: Database
- SQL: Structured Query Language
- HTTP: Hypertext Transfer Protocol
- API: Application Programming Interface
- UI: User Interface
Remember to spell these out on first use in each major section of documentation.