diff --git a/SUMMARY.md b/SUMMARY.md index 3d53320..5f9241c 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -1,5 +1,26 @@ # Table of contents +## ACCESSIBLE SURVEYS APP + +* [Accessible Surveys App](accessible-surveys-app/README.md) + * [Tutorials](accessible-surveys-app/tutorials/README.md) + * [Training Course](accessible-surveys-app/training-course/README.md) + * [Application Views](accessible-surveys-app/app/README.md) + * [Overview](accessible-surveys-app/app/overview.md) + * [Build](accessible-surveys-app/app/build/README.md) + * [Compose](accessible-surveys-app/app/build/compose.md) + * [Form Behavior](accessible-surveys-app/app/build/form-behavior.md) + * [Localize](accessible-surveys-app/app/build/localize.md) + * [Image Library](accessible-surveys-app/app/build/image-library.md) + * [Test](accessible-surveys-app/app/test.md) + * [Share](accessible-surveys-app/app/share/README.md) + * [Status](accessible-surveys-app/app/share/status.md) + * [Publish](accessible-surveys-app/app/share/publish.md) + * [Distribute](accessible-surveys-app/app/share/distribute.md) + * [Account Type](accessible-surveys-app/app/share/account-type.md) + * [Redirection](accessible-surveys-app/app/share/redirection.md) + * [Access](accessible-surveys-app/app/share/access.md) + ## TRAINING COURSE * [Introduction](README.md) diff --git a/accessible-surveys-app/README.md b/accessible-surveys-app/README.md new file mode 100644 index 0000000..b3a351e --- /dev/null +++ b/accessible-surveys-app/README.md @@ -0,0 +1,9 @@ +# Accessible Surveys App — User Guide + +Welcome to the Accessible Surveys App user documentation. This guide is structured into: + +- Tutorials: Short, practical walkthroughs to get productive quickly. +- Training course: A guided, session-based learning path. +- Application views: An overview of each screen in the app and how to use it. + +If you’re new, start with Tutorials → Getting started. For a deeper dive, follow the Training Course. If you need targeted help, open the relevant Application view. diff --git a/accessible-surveys-app/app/README.md b/accessible-surveys-app/app/README.md new file mode 100644 index 0000000..f192374 --- /dev/null +++ b/accessible-surveys-app/app/README.md @@ -0,0 +1,8 @@ +# Application Views + +Documentation organized by the app’s main views: + +- Overview +- Build (Compose, Form behavior, Localize, Image library) +- Test +- Share (Status, Publish, Distribute, Account type, Redirection, Access) diff --git a/accessible-surveys-app/app/build/README.md b/accessible-surveys-app/app/build/README.md new file mode 100644 index 0000000..74be231 --- /dev/null +++ b/accessible-surveys-app/app/build/README.md @@ -0,0 +1,8 @@ +# Build + +Configure and assemble your form. Use the subsections to structure content, set behavior, add translations, and manage media. + +- Compose: pages, sections, questions +- Form Behavior: navigation, validation, accessibility defaults +- Localize: languages and translations +- Image Library: upload and reuse assets diff --git a/accessible-surveys-app/app/build/compose.md b/accessible-surveys-app/app/build/compose.md new file mode 100644 index 0000000..62aea74 --- /dev/null +++ b/accessible-surveys-app/app/build/compose.md @@ -0,0 +1,20 @@ +# Build — Compose + +## Summary + +Compose is where you structure your form: pages, sections, and questions. + +## Features + +- Pages and sections: add, rename, reorder via drag‑and‑drop. +- Questions: text, choice, media, rating, order, range, and free‑text blocks. +- Reuse options: share option lists across questions. +- Logic markers: quick badges for visibility and requirements. +- Accessibility helpers: label position, inline radio, Specify Other. + +## How it works + +1) Create pages, then add questions inside sections. +2) Configure each question’s label, help, validation, and display. +3) Use drag‑and‑drop to reorder; use the context menu to duplicate or delete. +4) Use logic or behavior (next tab) to control visibility and validation. diff --git a/accessible-surveys-app/app/build/form-behavior.md b/accessible-surveys-app/app/build/form-behavior.md new file mode 100644 index 0000000..b1a6b35 --- /dev/null +++ b/accessible-surveys-app/app/build/form-behavior.md @@ -0,0 +1,20 @@ +# Build — Form Behavior + +## Summary + +Form Behavior controls navigation, validation, and defaults that affect the whole form. + +## Features + +- Navigation: next/previous, page menu visibility, skip hidden pages. +- Validation: per‑page checks before moving forward and before submit. +- Required rules: make questions or pages mandatory. +- Defaults: font size, contrast, read‑aloud availability. +- Keyboard focus: focus returns to the current page’s header/first input. + +## How it works + +1) Choose when validation runs (on page change, on submit) and how errors surface. +2) Decide if the page menu shows hidden pages; typically, hide them. +3) Set accessibility defaults (e.g., larger font, high contrast) for your audience. +4) Test navigation with keyboard to confirm expected focus management. diff --git a/accessible-surveys-app/app/build/image-library.md b/accessible-surveys-app/app/build/image-library.md new file mode 100644 index 0000000..c179e79 --- /dev/null +++ b/accessible-surveys-app/app/build/image-library.md @@ -0,0 +1,19 @@ +# Build — Image Library + +## Summary + +Manage images for Easy Read and media questions, with reuse and accessibility in mind. + +## Features + +- Upload and organize images with titles and tags. +- Alt text: add and enforce descriptive alternatives. +- Reuse assets across multiple questions and forms. +- Optimization: automatic resizing/format for faster loading. + +## How it works + +1) Upload images and complete title + alt text. +2) Tag assets to make them easy to find. +3) Insert images into questions or free‑text blocks. +4) Review performance recommendations before publish. diff --git a/accessible-surveys-app/app/build/localize.md b/accessible-surveys-app/app/build/localize.md new file mode 100644 index 0000000..a2d0d71 --- /dev/null +++ b/accessible-surveys-app/app/build/localize.md @@ -0,0 +1,19 @@ +# Build — Localize + +## Summary + +Localize lets you add languages and translate every visible string in your form. + +## Features + +- Languages: choose default language and add translations. +- Inline editor: translate labels, help text, options, and free‑text. +- Missing translation warnings: see what’s not yet translated. +- Import/Export: exchange CSV/JSON for offline translation workflows. + +## How it works + +1) Add target languages and set a default. +2) Translate each item; the UI highlights missing strings. +3) Optionally export, translate externally, then import back. +4) Preview in Test to verify language switching and right‑to‑left layouts. diff --git a/accessible-surveys-app/app/overview.md b/accessible-surveys-app/app/overview.md new file mode 100644 index 0000000..93b7e37 --- /dev/null +++ b/accessible-surveys-app/app/overview.md @@ -0,0 +1,16 @@ +# Overview + +Short summary + +- The Overview gives you a high-level snapshot of your survey: title, language, accessibility mode defaults, and key actions. + +Features + +- Survey meta: name, description, default language, accessibility defaults. +- Quick actions: open Build, Test, Share. +- Health checks: warnings for missing pages, logic issues, or translation gaps. + +How it works + +- Use the Overview to confirm setup before building or sharing. +- Resolve any warnings for a smoother publish experience. diff --git a/accessible-surveys-app/app/share/README.md b/accessible-surveys-app/app/share/README.md new file mode 100644 index 0000000..8350138 --- /dev/null +++ b/accessible-surveys-app/app/share/README.md @@ -0,0 +1,10 @@ +# Share + +Prepare, publish, and distribute your form. Check status, publish versions, and control access. + +- Status: readiness and checks +- Publish: versions, environments, schedules +- Distribute: links, QR codes, UTM +- Account Type: anonymous vs. sign‑in +- Redirection: thank‑you or external URL +- Access: permissions and protections diff --git a/accessible-surveys-app/app/share/access.md b/accessible-surveys-app/app/share/access.md new file mode 100644 index 0000000..87a8538 --- /dev/null +++ b/accessible-surveys-app/app/share/access.md @@ -0,0 +1,17 @@ +# Share — Access + +## Summary + +Define who can view, edit, and publish the form, and protect respondent access. + +## Features + +- Team roles: owner, editor, viewer with scoped rights. +- Form access: private, link‑only, password/code protected. +- Respondent permissions: per‑app/user rights for editing/publishing. + +## How it works + +1) Set team and form permissions according to your governance policy. +2) Use link‑only or codes to prevent unwanted respondents. +3) Review access regularly, especially before publishing updates. diff --git a/accessible-surveys-app/app/share/account-type.md b/accessible-surveys-app/app/share/account-type.md new file mode 100644 index 0000000..319da95 --- /dev/null +++ b/accessible-surveys-app/app/share/account-type.md @@ -0,0 +1,17 @@ +# Share — Account Type + +## Summary + +Control whether respondents need accounts or can answer anonymously. + +## Features + +- Anonymous responses: no sign‑in required. +- Named accounts: require sign‑in; track by user. +- Session recovery: allow resuming partially completed forms. + +## How it works + +1) Choose Anonymous for frictionless access or Accounts for identity. +2) If using accounts, confirm your organization’s sign‑in options. +3) Enable resume so respondents can continue later without losing progress. diff --git a/accessible-surveys-app/app/share/distribute.md b/accessible-surveys-app/app/share/distribute.md new file mode 100644 index 0000000..4cf1dae --- /dev/null +++ b/accessible-surveys-app/app/share/distribute.md @@ -0,0 +1,19 @@ +# Share — Distribute + +## Summary + +Distribute gives you respondent‑facing links and tools to reach your audience. + +## Features + +- Survey links: unique URLs per language or batch. +- Aliases and QR codes: friendly links and printable codes. +- UTM tracking: add campaign parameters for analytics. +- Batches: generate sets of links for events or cohorts. + +## How it works + +1) Copy the main link or language‑specific links. +2) Create an alias for shorter URLs or print a QR code. +3) Add UTM parameters if tracking campaigns. +4) Use batches when you need separate links per group. diff --git a/accessible-surveys-app/app/share/publish.md b/accessible-surveys-app/app/share/publish.md new file mode 100644 index 0000000..9cd1d1b --- /dev/null +++ b/accessible-surveys-app/app/share/publish.md @@ -0,0 +1,18 @@ +# Share — Publish + +## Summary + +Publish creates a versioned, read‑only build that respondents will use. + +## Features + +- Versioning: create immutable versions; roll back to a previous version. +- Environments: publish to test or production. +- Scheduling: set availability window (start/end dates). + +## How it works + +1) Ensure Status shows no blocking issues. +2) Choose environment and version label, then publish. +3) Optionally schedule activation and expiry. +4) Use roll back if a regression is found after release. diff --git a/accessible-surveys-app/app/share/redirection.md b/accessible-surveys-app/app/share/redirection.md new file mode 100644 index 0000000..e561395 --- /dev/null +++ b/accessible-surveys-app/app/share/redirection.md @@ -0,0 +1,17 @@ +# Share — Redirection + +## Summary + +Choose what happens after submission: thank‑you page or redirect to a URL. + +## Features + +- Thank‑you screen: configurable message and resources. +- External redirect: send respondents to a follow‑up site. +- Parameters: optionally include language, batch, or response ID. + +## How it works + +1) Select Thank‑you or Redirect. +2) If redirecting, provide a full URL and optional query parameters. +3) Test the end‑to‑end flow in Test to verify the destination. diff --git a/accessible-surveys-app/app/share/status.md b/accessible-surveys-app/app/share/status.md new file mode 100644 index 0000000..358167c --- /dev/null +++ b/accessible-surveys-app/app/share/status.md @@ -0,0 +1,17 @@ +# Share — Status + +## Summary + +Status shows whether your form is ready to publish and highlights issues to fix. + +## Features + +- Build health: errors and warnings (missing translations, invalid logic, unused items). +- Readiness checklist: must‑fix vs. recommended improvements. +- Timestamps: last build, last publish, pending changes since publish. + +## How it works + +- Resolve must‑fix issues before you can publish. +- Use the list to jump directly to problematic questions/pages. +- Rebuild after fixes to refresh status. diff --git a/accessible-surveys-app/app/test.md b/accessible-surveys-app/app/test.md new file mode 100644 index 0000000..e2fb853 --- /dev/null +++ b/accessible-surveys-app/app/test.md @@ -0,0 +1,20 @@ +# Test + +## Summary + +Test provides a safe environment to trial your form as respondents would see it. + +## Features + +- Preview by page or full flow; start from any page. +- Accessibility modes: font size, high contrast, read‑aloud, sign language. +- Logic inspector: confirm visibility and branching; hidden pages stay hidden. +- Validation checks: see required and format errors. +- Submission simulation: test the submit page and thank‑you screen. + +## How it works + +1) Open Test to preview the currently active page. +2) Toggle accessibility modes and verify layout, voice, and video. +3) Walk through logic paths (including hidden branches) using test data. +4) Submit a test response to verify the end‑to‑end flow. diff --git a/accessible-surveys-app/training-course/README.md b/accessible-surveys-app/training-course/README.md new file mode 100644 index 0000000..3eb38fa --- /dev/null +++ b/accessible-surveys-app/training-course/README.md @@ -0,0 +1,9 @@ +# Training Course + +A session-based learning path to master the Accessible Surveys App. + +- Session 1: Creating a new survey +- Session 2: Adding accessibility options +- Session 3: Translating a form +- Session 4: Sharing your survey +- Session 5: Analysing responses and exporting data diff --git a/accessible-surveys-app/tutorials/README.md b/accessible-surveys-app/tutorials/README.md new file mode 100644 index 0000000..5edc7bb --- /dev/null +++ b/accessible-surveys-app/tutorials/README.md @@ -0,0 +1,9 @@ +# Tutorials + +Quick, focused walkthroughs to help you perform common tasks. + +- Getting started: create, preview, and share your first form +- Add accessibility options +- Translate your form +- Test and validate +- Publish and distribute diff --git a/faq/How-does-the-referral-scheme-work b/faq/How-does-the-referral-scheme-work new file mode 100644 index 0000000..c8fc34c --- /dev/null +++ b/faq/How-does-the-referral-scheme-work @@ -0,0 +1 @@ +# How \ No newline at end of file diff --git a/faq/a new test folder/docs/1. Survey Questions.pdf b/faq/a new test folder/docs/1. Survey Questions.pdf deleted file mode 100644 index 1e7ab4d..0000000 Binary files a/faq/a new test folder/docs/1. Survey Questions.pdf and /dev/null differ diff --git a/faq/a new test folder/image/button.png b/faq/a new test folder/image/button.png deleted file mode 100644 index 404b74e..0000000 Binary files a/faq/a new test folder/image/button.png and /dev/null differ diff --git a/faq/a new test folder/image/snippet.png b/faq/a new test folder/image/snippet.png deleted file mode 100644 index 9d3c3bc..0000000 Binary files a/faq/a new test folder/image/snippet.png and /dev/null differ diff --git a/faq/a new test folder/image/tree.png b/faq/a new test folder/image/tree.png deleted file mode 100644 index 91b3279..0000000 Binary files a/faq/a new test folder/image/tree.png and /dev/null differ diff --git a/faq/a new test folder/new-test-page.md b/faq/a new test folder/new-test-page.md deleted file mode 100644 index a8cd9ba..0000000 --- a/faq/a new test folder/new-test-page.md +++ /dev/null @@ -1,33 +0,0 @@ -# Heading 1 - -## Heading 2 - -### Heading 3 - -#### Heading 4 - -##### Heading 5 - -###### heading 6 - -This is normal text

- -This is leaving a blank line - -*This is italic* - -Insert an image - -Insert a video - -Insert a pdf - -Insert a warning - -{% hint style="info" %} -Enter text here -{% endhint %} - -![alt text](image/snippet.png) -[Survey questions]() -