From 97a93cceebe020deae315560f9e186dfcb0ba92e Mon Sep 17 00:00:00 2001 From: xengineering Date: Mon, 8 Jan 2024 21:37:16 +0100 Subject: WIP: doc: Add API structure from developer perspective --- doc/diagrams/device-semver-developer.svg | 239 +++++++++++++++++++++++++++++++ doc/diagrams/device-semver-user.svg | 223 ++++++++++++++++++++++++++++ doc/diagrams/device-semver.svg | 223 ---------------------------- doc/doc.mk | 2 +- doc/documentation.tex | 15 +- 5 files changed, 474 insertions(+), 228 deletions(-) create mode 100644 doc/diagrams/device-semver-developer.svg create mode 100644 doc/diagrams/device-semver-user.svg delete mode 100644 doc/diagrams/device-semver.svg diff --git a/doc/diagrams/device-semver-developer.svg b/doc/diagrams/device-semver-developer.svg new file mode 100644 index 0000000..fd5b38a --- /dev/null +++ b/doc/diagrams/device-semver-developer.svg @@ -0,0 +1,239 @@ + + + + + + + + + + Mechanicalparts + + Electronicparts + + Firmware + + Software + + + Device + + + + + + + + Developer + multipe 'API's as definedby Semantic Versioning + + + + diff --git a/doc/diagrams/device-semver-user.svg b/doc/diagrams/device-semver-user.svg new file mode 100644 index 0000000..8a68362 --- /dev/null +++ b/doc/diagrams/device-semver-user.svg @@ -0,0 +1,223 @@ + + + + + + + + + + Mechanicalparts + + Electronicparts + + Firmware + + Software + + + Device + + + + + + + User + 'API' as defined bySemantic Versioning + + + diff --git a/doc/diagrams/device-semver.svg b/doc/diagrams/device-semver.svg deleted file mode 100644 index 8a68362..0000000 --- a/doc/diagrams/device-semver.svg +++ /dev/null @@ -1,223 +0,0 @@ - - - - - - - - - - Mechanicalparts - - Electronicparts - - Firmware - - Software - - - Device - - - - - - - User - 'API' as defined bySemantic Versioning - - - diff --git a/doc/doc.mk b/doc/doc.mk index 351cd48..d1e4a1b 100644 --- a/doc/doc.mk +++ b/doc/doc.mk @@ -3,7 +3,7 @@ DOCS := documentation DOCUMENTS := $(DOCS:%=$(DOC_BUILD_DIR)/%.pdf) DIAGRAMS_BUILD_DIR := $(DOC_BUILD_DIR)/diagrams -DIAGRAMS := device-semver +DIAGRAMS := device-semver-user device-semver-developer IMAGES := $(DIAGRAMS:%=$(DIAGRAMS_BUILD_DIR)/%.pdf) .PHONY: doc diff --git a/doc/documentation.tex b/doc/documentation.tex index 91ff8e5..5713b3c 100644 --- a/doc/documentation.tex +++ b/doc/documentation.tex @@ -30,13 +30,20 @@ Versioning\footnote{\href{https://semver.org}{https://semver.org}}. The resulting version numbers have the format \texttt{..} like e.g. \texttt{2.0.3}. While Semantic Versioning is usually targeted at software only it is here used for the whole device. This includes mechanical, electronic -and software aspects as shown in figure \ref{diagram:device-semver}. +and software aspects as shown in figure \ref{diagram:device-semver-user}. \begin{figure}[h] \centering - \includegraphics[width=\textwidth]{device-semver.pdf} - \caption{API for a device versioned with Semantic Versioning} - \label{diagram:device-semver} + \includegraphics[width=\textwidth]{device-semver-user.pdf} + \caption{API for a device versioned with Semantic Versioning from a user perspective} + \label{diagram:device-semver-user} +\end{figure} + +\begin{figure}[h] + \centering + \includegraphics[width=\textwidth]{device-semver-developer.pdf} + \caption{API for a device versioned with Semantic Versioning from a developer perspective} + \label{diagram:device-semver-developer} \end{figure} This versioning makes sure that users do not have to care about the device -- cgit v1.2.3-70-g09d2