From 4efd3db8a79961f1778bfdc9fccd5e9a2b99b347 Mon Sep 17 00:00:00 2001 From: insleker Date: Wed, 27 Aug 2025 11:48:30 +0800 Subject: [PATCH] docs: add user stories --- .gitignore | 4 +++- README.md | 3 ++- docs/FRs.md | 24 ++++++++++++++++++++++++ docs/meta-arch.md | 0 docs/use_cases.md | 4 ++++ test/{ => widget}/widget_test.dart | 0 6 files changed, 33 insertions(+), 2 deletions(-) create mode 100644 docs/FRs.md create mode 100644 docs/meta-arch.md create mode 100644 docs/use_cases.md rename test/{ => widget}/widget_test.dart (100%) diff --git a/.gitignore b/.gitignore index 39b8814..e1e0c24 100644 --- a/.gitignore +++ b/.gitignore @@ -116,4 +116,6 @@ app.*.symbols !**/ios/**/default.pbxuser !**/ios/**/default.perspectivev3 !/packages/flutter_tools/test/data/dart_dependencies_test/**/.packages -!/dev/ci/**/Gemfile.lock \ No newline at end of file +!/dev/ci/**/Gemfile.lock + +docs/.* diff --git a/README.md b/README.md index ef5d7bb..35eeb98 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,3 @@ # pdf_signature -create a signature on pdf page + +A GUI app to create a signature on PDF page interactively. diff --git a/docs/FRs.md b/docs/FRs.md new file mode 100644 index 0000000..30d9977 --- /dev/null +++ b/docs/FRs.md @@ -0,0 +1,24 @@ +# Functional Requirements + +## user stories + +* name: PDF browser + * role: user + * functionality: view and navigate PDF documents + * benefit: select page to add signature +* name: load signature picture + * role: user + * functionality: load a signature picture file + * benefit: easily add signature to PDF +* name: geometrically adjust signature picture + * role: user + * functionality: adjust the size and position of the signature picture + * benefit: ensure the signature fits well on the PDF page +* name: graphically adjust signature picture + * role: user + * functionality: background removal, contrast adjustment... + * benefit: easily improve the appearance of the signature on the PDF without additional software. +* name: draw signature + * role: user + * functionality: draw a signature using mouse or touch input + * benefit: create a custom signature directly on the PDF if no pre-made signature is available. diff --git a/docs/meta-arch.md b/docs/meta-arch.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/use_cases.md b/docs/use_cases.md new file mode 100644 index 0000000..535354e --- /dev/null +++ b/docs/use_cases.md @@ -0,0 +1,4 @@ +# Use cases + +Use cases are generated from `FRs.md`, and `meta-arch.md` in `gherkin` format. + diff --git a/test/widget_test.dart b/test/widget/widget_test.dart similarity index 100% rename from test/widget_test.dart rename to test/widget/widget_test.dart