Merge pull request #820 from Dasharo/dasharo-naming-convention

[RFC] Initial documentation of Dasharo Product Naming Convention

docs/dasharo-naming-convention.md

@@ -0,0 +1,78 @@
+# Dasharo Product Naming Convention
+
+Following documentation is results of [RFC](https://github.com/Dasharo/dasharo-issues/issues/762).
+
+## Synopsis
+
+```plain
+Dasharo (firmware_framework[+payload]) [customer_type] Package for
+market_segment
+```
+
+## Description
+
+Dasharo's naming scheme is crafted to convey the essential details of each
+firmware package. It includes the base firmware framework, an optional payload,
+the targeted market segment, and the customer type. This structure assists in
+identifying the most suitable package for specific technological needs, market
+segments, and customer categories.
+
+Components of the naming scheme:
+
+```plain
+Dasharo (firmware_framework[+payload]) [customer_type] Package for
+market_segment
+```
+
+- `firmware_framework`: Mandatory. Specifies the base firmware framework used
+  in the package. Available options:
+
+    + `coreboot` - [Dasharo downstream](https://github.com/Dasharo/coreboot) of
+    [coreboot](https://coreboot.org) open source project.
+    + `UEFI` - [Dasharo downstream](https://github.com/Dasharo/edk2) of
+    [Tianocore EDK II](https://github.com/tianocore/edk2) reference
+    implementation of the UEFI Specification.
+
+- `payload` (optional): Details the additional software loaded by the firmware.
+  Available options:
+
+    + `UEFI` - [Dasharo downstream](https://github.com/Dasharo/edk2) of
+    [Tianocore EDK II](https://github.com/tianocore/edk2) reference
+    implementation of the UEFI Specification.
+    + `SeaBIOS` - upstream or downstream version of [SeaBIOS](https://www.seabios.org/SeaBIOS)
+    + `Heads` - upstream or downstream version of [Heads](https://github.com/linuxboot/heads/)
+
+  The omission of this component implies no additional payload.
+
+- `market_segment`: Indicates the target market segment for the package.
+  Possible segments:
+
+  ```plain
+  Network Appliance/Embedded | Laptop | Desktop | Workstation | Server
+  ```
+
+- `customer_type`: Specifies whether the package is aimed at professional
+  retail customers or enterprise business customers. Options are:
+
+  ```plain
+  Pro | Enterprise
+  ```
+
+This naming convention aims to provide clarity and precision, facilitating ease
+of understanding across Dasharo's firmware offerings.
+
+## Examples
+
+```plain
+Dasharo (coreboot+Heads) Pro Package for Laptop
+```
+
+A package aimed at professional retail customers with laptops, incorporating
+coreboot with the Heads payload.
+
+```plain
+Dasharo (UEFI) Enterprise Package for Desktop
+```
+
+A package for enterprise business customers for desktops, employing UEFI with
+no additional payload specified.

mkdocs.yml

@@ -385,6 +385,7 @@ nav:
       - 'Documentation': dasharo-tools-suite/documentation.md
   - 'Knowledge base':
       - 'Glossary': glossary.md
+      - "Dasharo Product Naming Convention": dasharo-naming-convention.md
       - 'Dasharo menu documentation':
           - 'Overview': dasharo-menu-docs/overview.md
           - 'Boot Maintenance Manager': dasharo-menu-docs/boot-maintenance-mgr.md