From 2a8d75294f2a272e74c60977b71be66fdcd645e8 Mon Sep 17 00:00:00 2001 From: aki Date: Tue, 8 Apr 2025 12:06:20 +0800 Subject: [PATCH] Fix formatting --- docs/CONTRACT.md | 136 ++++++++++++++++++++++++++++++++++++----------- 1 file changed, 105 insertions(+), 31 deletions(-) diff --git a/docs/CONTRACT.md b/docs/CONTRACT.md index 3d2fddc..6ff5658 100644 --- a/docs/CONTRACT.md +++ b/docs/CONTRACT.md @@ -29,127 +29,201 @@ C. Client desires to engage Developer to perform such software development and ## ARTICLE 2: SCOPE OF SERVICES 2.1 **General Scope:** Developer shall perform the Services necessary to design, develop, test, and implement the System as described in this Agreement and its Exhibits. The System is intended to function as a Learner Management System providing functionalities for learners, instructors, and administrators. + 2.2 **Development Methodology:** Developer shall utilize an Agile (Iterative and Incremental) Software Development Life Cycle (SDLC) methodology for the performance of the Services. - a. **Process:** The project will be broken down into smaller, manageable cycles ("**Sprints**," typically 2-4 weeks). Each Sprint will generally include planning, design, development, testing, and stakeholder review, aiming to produce a potentially shippable increment of the System. - b. **Rationale:** This methodology is selected to provide adaptability to evolving requirements, facilitate early and frequent feedback from Client, foster collaboration and transparency, manage risks effectively, and maintain focus on user needs. - c. **Project Management:** Developer shall employ project management practices consistent with the Agile methodology, including but not limited to backlog grooming, sprint planning, daily stand-ups (as appropriate), sprint reviews, and retrospectives. Regular communication and progress reporting shall be provided to Client. *()*. Project tracking will utilize []. + +> a. **Process:** The project will be broken down into smaller, manageable cycles ("**Sprints**," typically 2-4 weeks). Each Sprint will generally include planning, design, development, testing, and stakeholder review, aiming to produce a potentially shippable increment of the System. +> +> b. **Rationale:** This methodology is selected to provide adaptability to evolving requirements, facilitate early and frequent feedback from Client, foster collaboration and transparency, manage risks effectively, and maintain focus on user needs. +> +> c. **Project Management:** Developer shall employ project management practices consistent with the Agile methodology, including but not limited to backlog grooming, sprint planning, daily stand-ups (as appropriate), sprint reviews, and retrospectives. Regular communication and progress reporting shall be provided to Client. *()*. Project tracking will utilize []. + 2.3 **Key System Features and Characteristics:** The System developed under this Agreement shall aim to possess the following features and characteristics: - a. **Technology Stack:** - i. Frontend: [Specify frontend tech: e.g., Vite Vanilla, React/Vue, etc.] - ii. Backend: Rust utilizing the Actix framework. - iii. Database: MariaDB. - iv. Deployment Environment: Containerized using Docker and orchestrated via Docker Compose. - b. **Performance & Scalability:** The architecture is designed for efficient performance and to accommodate future growth in user base and data volume. - c. **Security:** Development practices will incorporate security considerations, including secure authentication mechanisms (e.g., PAKE SRP planned for initial implementation), data validation, and adherence to standard secure coding practices. *()*. - d. **User Interface (UI) and User Experience (UX):** The System shall feature an intuitive, responsive user interface adaptable to various screen sizes (desktop, tablet, mobile) and designed according to the principles outlined in Section 3.1 and Exhibit A. Adherence to accessibility guidelines (e.g., WCAG) will be pursued where practicable. *()*. - e. **Modularity:** The System architecture promotes modularity to facilitate future enhancements and integrations. + +> a. **Technology Stack:** +> +> > i. Frontend: [Specify frontend tech: e.g., Vite Vanilla, React/Vue, etc.] +> > +> > ii. Backend: Rust utilizing the Actix framework. +> > +> > iii. Database: MariaDB. +> > +> > iv. Deployment Environment: Containerized using Docker and orchestrated via Docker Compose. +> +> b. **Performance & Scalability:** The architecture is designed for efficient performance and to accommodate future growth in user base and data volume. +> +> c. **Security:** Development practices will incorporate security considerations, including secure authentication mechanisms (e.g., PAKE SRP planned for initial implementation), data validation, and adherence to standard secure coding practices. *()*. +> +> d. **User Interface (UI) and User Experience (UX):** The System shall feature an intuitive, responsive user interface adaptable to various screen sizes (desktop, tablet, mobile) and designed according to the principles outlined in Section 3.1 and Exhibit A. Adherence to accessibility guidelines (e.g., WCAG) will be pursued where practicable. *()*. +> +> e. **Modularity:** The System architecture promotes modularity to facilitate future enhancements and integrations. + 2.4 **Video Demonstration:** As part of the development process or deliverables, Developer shall provide Client with a video demonstration showcasing core System functionalities, user roles (learner, instructor, administrator), and key workflows, substantially covering the items listed below: - a. Platform Navigation and Layout. - b. Key User Journeys (Learner Course Interaction, Instructor Course Management, Administrator User/Course Management). - c. Core Feature Highlights (Dashboard, Profiles, Course Interaction, Admin Interfaces). - d. Interface Responsiveness. + +> a. Platform Navigation and Layout. +> +> b. Key User Journeys (Learner Course Interaction, Instructor Course Management, Administrator User/Course Management). +> +> c. Core Feature Highlights (Dashboard, Profiles, Course Interaction, Admin Interfaces). +> +>d. Interface Responsiveness. + 2.5 **Excluded Services:** *()*. ## ARTICLE 3: SYSTEM SPECIFICATIONS AND ARCHITECTURE 3.1 **User Interface (UI) Layout and Flow:** The general layout principles and high-level component relationships for the System's user interface are conceptually depicted in **Exhibit A (User Interface Flow Diagram)**, incorporated herein by reference. Key layout components include a persistent Header, a contextual Sidebar (where applicable), a Main Content Area, and a Footer. Specific screen designs and detailed UI specifications will be developed and refined during the Sprints, subject to Client review and feedback. + 3.2 **Backend Architecture:** The high-level backend architecture, illustrating the interaction between the Actix framework, database (MariaDB), and other core components within the planned containerized environment, is conceptually depicted in **Exhibit B (Backend Architecture Diagram)**, incorporated herein by reference. *()*. + 3.3 **Technical Specifications:** *()*. ## ARTICLE 4: PROJECT TIMELINE AND DELIVERABLES 4.1 **Estimated Timeline:** The estimated timeline for the completion of the Services is approximately **[Calculate total weeks from Gantt, e.g., 35 weeks]**, commencing from the Effective Date or an otherwise agreed-upon project start date. A detailed breakdown of phases, estimated task durations, and dependencies is illustrated in the Gantt chart provided as **Exhibit C (Project Timeline Gantt Chart)**, incorporated herein by reference. + 4.2 **Acknowledgement of Estimates:** Client acknowledges that the timeline provided in Exhibit C is an estimate based on the initial Scope of Services and the Agile methodology. Timelines may be adjusted based on the evolution of requirements, Client feedback, unforeseen complexities, or mutually agreed-upon changes processed via the Change Management procedure (Article 6). + 4.3 **Key Deliverables:** Major deliverables under this Agreement include: - a. Access to incremental System builds for review at the end of relevant Sprints. - b. The final, deployed System software meeting the Acceptance Criteria (Article 5). - c. The Video Demonstration (as per Section 2.4). - d. System Documentation, including user guides for administrators, instructors, and learners, and technical documentation sufficient for ongoing maintenance and operation. *()*. - e. Source Code for the developed System. *()*. - f. Training materials and sessions as specified in Section 4.4. + + > a. Access to incremental System builds for review at the end of relevant Sprints. + > + > b. The final, deployed System software meeting the Acceptance Criteria (Article 5). + > + > c. The Video Demonstration (as per Section 2.4). + > + > d. System Documentation, including user guides for administrators, instructors, and learners, and technical documentation sufficient for ongoing maintenance and operation. *()*. + > + > e. Source Code for the developed System. *()*. + > + > f. Training materials and sessions as specified in Section 4.4. + 4.4 **Training and Handover:** Upon successful deployment, Developer shall provide: - a. Training for Client's designated administrators and instructors. *()*. - b. Onboarding materials (e.g., documentation, potentially videos) for learners. - c. A formal handover process concluding the development phase. + + > a. Training for Client's designated administrators and instructors. *()*. + > + > b. Onboarding materials (e.g., documentation, potentially videos) for learners. + > + > c. A formal handover process concluding the development phase. ## ARTICLE 5: TESTING AND ACCEPTANCE 5.1 **Testing:** Developer shall perform internal testing throughout the development process, including unit, integration, and functional testing, appropriate to the Agile methodology. + 5.2 **User Acceptance Testing (UAT):** Client shall be responsible for conducting UAT upon notification from Developer that specific features, modules, or the System as a whole are ready for review. Client shall perform UAT in accordance with agreed-upon test plans or criteria. *()*. + 5.3 **Acceptance Criteria:** The System shall be deemed accepted by Client upon the earlier of: (a) Client providing written notice of acceptance; or (b) Client using the System in a live production environment for purposes other than UAT; or (c) the expiration of the final UAT period without Client providing written notice of material non-conformities preventing acceptance. *()*. + 5.4 **Defect Resolution:** Developer shall use commercially reasonable efforts to correct any material defects or non-conformities to the agreed specifications identified during UAT and reported by Client in accordance with the agreed process. ## ARTICLE 6: CHANGE MANAGEMENT 6.1 **Change Request Process:** Recognizing the iterative nature of the Agile methodology, changes to the Scope of Services, requirements, or specifications may arise. All requests for changes ("**Change Requests**") must be submitted in writing. + 6.2 **Impact Assessment:** Developer shall assess the impact of each Change Request on the project scope, timeline, and cost. Developer will provide Client with a written analysis of the impact and any associated cost adjustments or schedule modifications. + 6.3 **Approval:** No Change Request shall be implemented by Developer unless and until both Parties have mutually agreed upon the change, its impact, and any associated adjustments in writing (e.g., via a formal Change Order document). ## ARTICLE 7: PROJECT CONSIDERATIONS AND RISK MITIGATION 7.1 **Potential Scope Evolution:** Client acknowledges that the flexibility of the Agile process requires diligent scope management by both Parties to control project timelines and costs. The Change Management process (Article 6) is the agreed mechanism for managing scope adjustments. + 7.2 **Initial Setup and Data Migration:** - a. Client is responsible for necessary preparations for System implementation, including user account provisioning (unless otherwise agreed) and ensuring readiness of any required infrastructure not provided by Developer. - b. If data migration from existing systems is required and included in the Scope of Services *()*, Client shall cooperate fully with Developer, providing data in the required format and participating in validation. Developer and Client will collaboratively develop a specific Data Migration Plan. The complexity of data migration may impact the project timeline and effort. - c. Developer shall provide reasonable onboarding support, training (as per Section 4.4), and documentation to facilitate a smooth transition. + + > a. Client is responsible for necessary preparations for System implementation, including user account provisioning (unless otherwise agreed) and ensuring readiness of any required infrastructure not provided by Developer. + > + > b. If data migration from existing systems is required and included in the Scope of Services *()*, Client shall cooperate fully with Developer, providing data in the required format and participating in validation. Developer and Client will collaboratively develop a specific Data Migration Plan. The complexity of data migration may impact the project timeline and effort. + > + > c. Developer shall provide reasonable onboarding support, training (as per Section 4.4), and documentation to facilitate a smooth transition. ## ARTICLE 8: FEES AND PAYMENT SCHEDULE *()* + 8.1 **Fees:** Detail the total project cost or the billing rate (e.g., Time & Materials with a cap, Fixed Fee). Specify currency. + 8.2 **Payment Schedule:** Outline milestones or dates for invoicing and payment terms (e.g., Net 30 days). Include details for initial deposit, milestone payments, final payment. + 8.3 **Expenses:** Specify how expenses (e.g., travel, third-party licenses) will be handled – included in fees or reimbursed separately. Require pre-approval for significant expenses. + 8.4 **Taxes:** State which party is responsible for applicable taxes. ## ARTICLE 9: INTELLECTUAL PROPERTY RIGHTS *()* + 9.1 **Ownership of Deliverables:** Typically, upon full payment, ownership of the custom code developed specifically for the Client (the System) transfers to the Client. Clearly define this. + 9.2 **Developer's Pre-Existing IP:** State that Developer retains ownership of its pre-existing tools, libraries, frameworks, know-how, and code used in the project but grants Client a license to use them as integrated into the System. Define the scope of this license (e.g., perpetual, non-exclusive, royalty-free). + 9.3 **Third-Party Materials:** Address ownership and licensing of any third-party components (e.g., open-source libraries) used. Client typically receives these under their respective licenses. ## ARTICLE 10: CONFIDENTIALITY *()* + 10.1 **Definition of Confidential Information:** Define what constitutes confidential information for both Parties. + 10.2 **Obligations:** State the receiving Party's obligation to protect the disclosing Party's confidential information, using a reasonable degree of care. + 10.3 **Exclusions:** List standard exclusions (e.g., publicly known information, independently developed, required by law). + 10.4 **Duration:** Specify the duration of the confidentiality obligations (e.g., a number of years after agreement termination). ## ARTICLE 11: WARRANTIES AND DISCLAIMERS *()* + 11.1 **Developer Warranties:** - a. **Performance Warranty:** Developer typically warrants that the System will perform substantially in accordance with the agreed specifications for a limited period (e.g., 90 days) after Acceptance ("Warranty Period"). Detail the remedy (e.g., Developer will correct defects). - b. **Authority:** Warrant that Developer has the right and authority to enter into this Agreement. - c. **Non-Infringement:** Warrant that, to Developer's knowledge, the custom-developed portions of the System do not infringe on third-party IP rights. *(Often subject to limitations)*. + + > a. **Performance Warranty:** Developer typically warrants that the System will perform substantially in accordance with the agreed specifications for a limited period (e.g., 90 days) after Acceptance ("Warranty Period"). Detail the remedy (e.g., Developer will correct defects). + > + > b. **Authority:** Warrant that Developer has the right and authority to enter into this Agreement. + > + > c. **Non-Infringement:** Warrant that, to Developer's knowledge, the custom-developed portions of the System do not infringe on third-party IP rights. *(Often subject to limitations)*. + 11.2 **Disclaimers:** **EXCEPT FOR THE EXPRESS WARRANTIES STATED HEREIN, DEVELOPER DISCLAIMS ALL OTHER WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.** State that the System is provided "AS IS" after the Warranty Period. ## ARTICLE 12: LIMITATION OF LIABILITY *()* + 12.1 **Exclusion of Certain Damages:** **NEITHER PARTY SHALL BE LIABLE TO THE OTHER FOR ANY INDIRECT, INCIDENTAL, SPECIAL, CONSEQUENTIAL, OR PUNITIVE DAMAGES (INCLUDING LOST PROFITS) ARISING OUT OF OR RELATING TO THIS AGREEMENT, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.** + 12.2 **Cap on Direct Damages:** **EACH PARTY'S TOTAL CUMULATIVE LIABILITY FOR DIRECT DAMAGES ARISING OUT OF OR RELATING TO THIS AGREEMENT SHALL BE LIMITED TO THE TOTAL FEES PAID OR PAYABLE BY CLIENT TO DEVELOPER UNDER THIS AGREEMENT.** *(This amount is often heavily negotiated)*. + 12.3 **Exceptions:** Specify exceptions to limitations (e.g., breach of confidentiality, indemnification obligations, infringement). ## ARTICLE 13: TERM AND TERMINATION *()* + 13.1 **Term:** The Agreement commences on the Effective Date and continues until the Services are completed and final payment is made, unless terminated earlier as provided herein. + 13.2 **Termination for Cause:** Either Party may terminate if the other Party materially breaches the Agreement and fails to cure within a specified period (e.g., 30 days) after written notice. + 13.3 **Termination for Convenience:** *(Optional)* Allow either Party (or just Client) to terminate without cause upon written notice (e.g., 30 or 60 days). Specify consequences (e.g., payment for work performed). + 13.4 **Effect of Termination:** Detail obligations upon termination (e.g., return of confidential information, final payments for work done, delivery of work-in-progress). ## ARTICLE 14: MISCELLANEOUS 14.1 **Governing Law:** Specify the jurisdiction whose laws will govern the Agreement (e.g., "State of [Your Jurisdiction], without regard to its conflict of laws principles"). + 14.2 **Dispute Resolution:** Outline the process for resolving disputes (e.g., negotiation, mediation, arbitration, litigation) and specify the venue/location. + 14.3 **Notices:** Define how formal notices must be sent between the Parties (e.g., certified mail, email with confirmation). + 14.4 **Entire Agreement:** State that this Agreement (including Exhibits) constitutes the entire understanding between the Parties and supersedes all prior discussions or agreements. + 14.5 **Amendments:** Specify that any changes must be in writing and signed by both Parties. + 14.6 **Assignment:** State whether either Party can assign its rights or obligations under the Agreement (usually requires consent). + 14.7 **Severability:** If any part of the Agreement is found invalid, the rest remains in effect. + 14.8 **Force Majeure:** Address delays caused by events beyond reasonable control. + 14.9 **Relationship of Parties:** State that Developer is an independent contractor, not an employee or partner of Client. ## ARTICLE 15: EXHIBITS