From 578582951e4cc3cc06323e8525b14ecd04c85d87 Mon Sep 17 00:00:00 2001 From: nils <48135649+Nilstrieb@users.noreply.github.com> Date: Mon, 4 Jul 2022 16:08:42 +0200 Subject: [PATCH] cod --- doc/src/03_system_scope_and_context.adoc | 15 +++++---------- doc/src/07_deployment_view.adoc | 6 ++++++ doc/src/10_quality_requirements.adoc | 3 +++ 3 files changed, 14 insertions(+), 10 deletions(-) diff --git a/doc/src/03_system_scope_and_context.adoc b/doc/src/03_system_scope_and_context.adoc index d0bf901..4151055 100644 --- a/doc/src/03_system_scope_and_context.adoc +++ b/doc/src/03_system_scope_and_context.adoc @@ -1,14 +1,9 @@ [[section-system-scope-and-context]] == System Scope and Context +[plantuml] +---- +(crapderive) --- User : Terminal +---- - -=== Technical Context - - - -**** - -**** - -**** +The user interacts with crapderive via a terminal and standard input and output. \ No newline at end of file diff --git a/doc/src/07_deployment_view.adoc b/doc/src/07_deployment_view.adoc index b72056f..75d313a 100644 --- a/doc/src/07_deployment_view.adoc +++ b/doc/src/07_deployment_view.adoc @@ -8,5 +8,11 @@ The code is available on GitHub (https://github.com/Nilstrieb/crapderive). The u To build and install crapderive, they can run the following command if they have Rust installed: `cargo install --git https://github.com/Nilstrieb/crapderive`. +[plantuml] +---- +(Github) -- User1 : cargo install +(Github) -- User2 : git clone +---- + === Installing Rust To install Rust, visit https://www.rust-lang.org/tools/install. \ No newline at end of file diff --git a/doc/src/10_quality_requirements.adoc b/doc/src/10_quality_requirements.adoc index 52c041e..f45dfb0 100644 --- a/doc/src/10_quality_requirements.adoc +++ b/doc/src/10_quality_requirements.adoc @@ -4,6 +4,7 @@ * Parser tests * Idiomatic Rust code * Good diagnostics +* Performance === Quality Tree @@ -16,6 +17,7 @@ left to right direction (Quality) --> (usability) (usability) --> (3 diagnostics) +(usability) --> (4 performance) ---- === Quality Scenarios @@ -26,4 +28,5 @@ left to right direction |1|A developer wants to add a new feature to the parser. It should be ensured that they don't break existing functionality. |2|A new developer that is already familiar with rust wants to get started contributing to the project. The project should be familiar to them. |3|Someone wants to use crapderive, but they have syntax errors since they aren't familiar with the language yet. The compiler should help them find the issues and fix them. +|4|A user wants to rewrite their slow bash script in a faster language. Crapderive should give them this capability. |=== \ No newline at end of file