diff --git a/docs/DEV.md b/docs/DEV.md index 5a195581..464f8836 100644 --- a/docs/DEV.md +++ b/docs/DEV.md @@ -244,7 +244,7 @@ After you are set-up, the steps you take depend on what you want to do: ## Editor _All code is just plain text, so it doesn't really matter what you use to edit them._ However, -using modern, feature-rich IDEs/text-editors like [_**Atom**_](https://github.blog/2022-06-08-sunsetting-atom/), +using modern, feature-rich IDEs/text-editors like [_**Atom**_](https://github.blog/news-insights/product-news/sunsetting-atom/), [_**Brackets**_](https://brackets.io), [_**WebStorm**_](https://www.jetbrains.com/webstorm/), [_**Sublime Text**_](https://www.sublimetext.com/), [_**Visual Studio Code**_](https://code.visualstudio.com/), etc. makes life way easier. These come diff --git a/docs/functional-requirements.md b/docs/functional-requirements.md index 1934c259..237c8332 100644 --- a/docs/functional-requirements.md +++ b/docs/functional-requirements.md @@ -2,11 +2,16 @@ ## Introduction -This document outlines the **functional requirements** of the web application, detailing the core features and capabilities necessary for its development. Each requirement is carefully structured to enhance usability, flexibility, and efficiency. +This document outlines the **functional requirements** of the web application, detailing the core features +and capabilities necessary for its development. Each requirement is carefully structured to enhance +usability, flexibility, and efficiency. -Additionally, these functional requirements have been **grouped into clusters** based on their intent and purpose. This categorization helps in understanding the relationships between different features, making it easier to plan development, prioritize tasks, and optimize the overall user experience. +Additionally, these functional requirements have been **grouped into clusters** based on their intent +and purpose. This categorization helps in understanding the relationships between different features, +making it easier to plan development, prioritize tasks, and optimize the overall user experience. -The following sections provide a **detailed list of functional requirements** and their respective **clusters** for better organization and clarity. +The following sections provide a **detailed list of functional requirements** and their respective +**clusters** for better organization and clarity. ## Functional Requirements @@ -44,18 +49,18 @@ The following sections provide a **detailed list of functional requirements** an ### Clustered Groups -| Grouped Points | Rationale | -|------------------------------|-----------------------------------------------------------------------------| -| **1-6, 18 (Build Programs)** | Construct and organize programs | -| **6, 10 (Artworks)** | Empower users to create and visualize art programmatically. | -| **7, 9, 22, 26, 28 (Bricks)**| Create, modify, categorize, and search bricks. | -| **8, 14, 30 (WS Viewing)** | Adapt the workspace to user preferences for comfort and productivity. | -| **11, 29 (Run Program)** | Run, stop, and run step-by-step through programs | -| **12, 19, 20, 21 (Save)** | Ensure users can save, export, and access projects across formats/devices. | -| **12, 31 (Save/Merge)** | Save, load, merge and create new projects. | -| **13, 23 (Show Info)** | Help users track progress and learn through statistics and guides. | -| **15 (Language)** | Broaden app accessibility for non-English speakers. | -| **16, 17 (CRUD on Bricks)** | CRUD operation to minimize friction from mistakes and streamline editing. | -| **24 (Modes)** | Cater to diverse skill levels with tailored interfaces. | -| **25 (Configurations)** | Allow users to tailor the app to their workflow and hardware. | -| **27 (Text Editor)** | Support both visual and traditional coding preferences. | +| Grouped Points | Rationale | +| ----------------------------- | ---------------------------------------------------------------- | +| **1-6, 18 (Build Programs)** | Construct and organize programs | +| **6, 10 (Artworks)** | Empower users to create and visualize art programmatically. | +| **7, 9, 22, 26, 28 (Bricks)** | Create, modify, categorize, and search bricks. | +| **8, 14, 30 (WS Viewing)** | Adapt the workspace to user preferences for comfort and productivity.| +| **11, 29 (Run Program)** | Run, stop, and run step-by-step through programs | +| **12, 19, 20, 21 (Save)** | Ensure users can save, export, and access projects across formats/devices.| +| **12, 31 (Save/Merge)** | Save, load, merge and create new projects. | +| **13, 23 (Show Info)** | Help users track progress and learn through statistics and guides.| +| **15 (Language)** | Broaden app accessibility for non-English speakers. | +| **16, 17 (CRUD on Bricks)** | CRUD operation to minimize friction from mistakes and streamline editing.| +| **24 (Modes)** | Cater to diverse skill levels with tailored interfaces. | +| **25 (Configurations)** | Allow users to tailor the app to their workflow and hardware. | +| **27 (Text Editor)** | Support both visual and traditional coding preferences. |