Template:Proposal
Project structure
{{{synopsis}}}
- Project Logic Model:
| Logic Model ([[{{{Project_name}}}]]) Template:LogicModel 06 4, 2022 | ||||||
|---|---|---|---|---|---|---|
| ||||||
| ||||||
|
This includes the following:
- Define [[{{{Project_name}}}/Context|context]] with historical factors(if needed e.g. education - What, How, why, etc... of curriculum or programs)
- Introduction and [[{{{Project_name}}}/Goal|Goal]]s of the project
- Quality issues ([[{{{Project_name}}}/Criteria|Success criteria]]) and relevant boundary conditions
- Required [[{{{Project_name}}}/Input|Input]]s and Stakeholders identification
- Proposed [[{{{Project_name}}}/Process|Process]] of Execution
- Budget
- Expected [[{{{Project_name}}}/Output|Output]]s/Outcomes
- References
- Related pages
Quality documentation
Mandatory documents; Apply to all projects
- Architecture relation diagram (Diagrams)
- Components Portfolio (PKC Portfolio)
- Security Protocol (SPD)
- Component build documentation tool (How to build a component for PKC, here
- Stress test and quality protocols
- Component Development protocol
- Project theme (Layout) structure (can be used with techs like storybook)
Quality Protocol
[DA]
Planning phase
- Portfolio components conception must follow
- Define tolerance specifications and Control limits specification
- Attend Meeting review for iterations week/component/work launch (sprints or similar), and discuss components on portfolio before develop to make sure everything is understood
Development
- by a DevOps approach, apply DDT (Data Driven Testing, according to [Security Protocol Document|SPD])
- e.g. Apply unit testings FrontEnd/BackEnd, Linters (ESLint), Prettier and (User-side) Sentry
- Report to Update all project-related documents and request for changes on plan
- Meeting review to validate products
Testing
- Quality review on development environment
- Review at six sigma level, no flaws
- Margins (controls and boundaries) defined on Project Planning
- apply complementary principles e.g. rule of seven if applicable
- Quality review on stage environment
- Apply Stress Test Protocol - User side testing
Stress Test Protocol
STP is documented here and it's a document as a checklist that defines all the steps for a user to run all the functionalities of the software
Procurements (HR/Materials agreements)
Form of Product proposal plan (description&budgeting)
Product description
- (define the state of art, what is the purpose of the product, why is being done and what is solving)
Learning today on the finest schools of the world is not anymore about the teacher speaking and students listening. Today and the future of education is based on concepts of building self-discipline, learning by self-pace and using data-driven to measure the quality of the education process. The objective of this product is implement a state-of-the-art engine to help education democratization and with high-quality standards
Product Scope
- (Define the requirements or deliverable of the scope)
There is two requirements specifically:
- XLP - Extreme learning programming which is the base for the learning methodology
- PKC - Which is the engine container packed with several web services and features that allows to run XLP
- (Define for each deliverable the packages of work specifically and the levels of complexity)
Team and skills
- (Define the Team you require to be able to complete this project)
- (Define the hierarchies of the team and the predicted amount of time for each role)
Budget
- (Define the budget discriminated by packages of work)
- (Define the budget discriminated by TRL or phases)
Phases of delivery/Technology Readiness Levels(TRLs)
Web-based Smart Contract Demonstration
The first three levels of TRL will use Smart Contracts and Ethereum-based account classification to perform LKPP-defined product catalog data update and publication business process. From the beginning of this project, all business requirements, account types, and data content types will all be organized and managed using a consistent data packaging workflow, namely Project Knowledge Container(PKC), which is designed to support Web3-based software development projects. This includes the following levels of Technology Readiness Levels(TRLs):
TRL 1
Demonstrate that each Programmable Account represents a self-contained LKPP-specified business process, each business process would involve a set of explicitly defined roles, such as buyers/vendors/administrators, who are identified by Externally Owned Accounts. These account authentication and authorization services will be integrated with the open-source account authentication microservice in a local instance of PKC, operated and administered by LKPP technical staff with technical support from this project team.
TRL 2
Demonstrate how data transparency and non-corruptibility is achievable by the security model of blockchain-based Smart Contracts. A few low complexity use cases will be identified by LKPP with the implementation team, and data transparency and non-corruptibility will be revealed and explained by these use cases.
TRL 3
Document the data types and data content categories in terms of what must be made public and what must be encrypted or stored privately. Define the data storage, backup/restore mechanisms leveraging the existing infrastructure of PKC. A specific data storage and backup/restore procedure, co-developed with LKPP will be the foundation for establishing guidelines for implementing the evolving business processes as they will necessary to be defined incrementally by LKPP when new requirements and needs reveal themselves.
Technology Demonstration and Deployment Process
TRL 4
Refine and ensure all code base can switch between public and self-hosted Ethereum-compatible blockchains, and works on generic web-based human-machine interfaces. Demonstrate the PKC can serve as a framework to deploy and test varying versions of the same code base, include relevant web-based documentation that facilitate this overall project.
TRL 5
Based on data types defined in TRL 3, present repetitive control structures in LKPP-defined business processes as standardized templates in Smart Contracts. These standardized templates should be initially written in the programming language Solidity, and they are defined to enhance software reusability and reduce the complexity of business process verification and validation.
TRL 6
Establish a full stack programming protocol (from secured data to user interfaces, or generically called Web3 programming protocol) for LKPP's blockchain catalog system. Starting from the beginning of the project, working with LKPP to define the look and feel of web interfaces, and incorporate UI/UX designers to create an adequate user experience that matches the expectation of stakeholders. The UI/UX code base will incrementally converge with the Smart Contracts that are being developed in parallel, many design decisions will affect the code integration efforts and influence data service deployment processes.
System/Subsystem Integration, Test and Product Launch
TRL 7
Develop working prototypes of modularized catalog data publishing and updating web services. Work with an initial group of actual buyers/vendors/administrators as early adopters to validate the workflow. Create automated or semi-automated test processes to load a significant amount of test data to stress test the system.
TRL 8
Based on the Web3 programming protocol defined in TRL 6, this project phase will demonstrate that LKPP-defined business processes (relevant to catalog data publishing and editing), can be organized as modularized building blocks, as explicitly documented web pages with hyperlinked/version controlled data/source code assets, so that accountability of changes of data sources and data assets' control structures can be explicitly traced.
TRL 9
Deploy LKPP's product catalog data service to the public. This deployment should demonstrate that web-based user interfaces, data backup/restore procedures, blockchain-based account and data transparency features, testing, usage statistics, user documentation, source code and data content version control can all be subsumed in an SSOT framework, namely Project Knowledge Container, as a meta catalog of data and source code. LKPP can utilize the above mentioned features to evolve the overall functionalities of this product catalog service and potentially other web-based data intensive applications.
NDA Non-disclosure Agreement
For the fact that PKC is a unique and state-of-the-art, there is no "secrets" making us a 100% OSS organization, therefore, no NDA is necessary. We take for granted that people are self-accountable and should be responsible for what they say, do and create.
Time & Material agreement
(To be updated)
International Employment Agreement
THIS AGREEMENT made as of the 6th day of June, 2022 , between Del Foundation, a corporation incorporated under the laws of the {{{Region}}}, and having its principal place of business at {{{Employer_name}}} (the "Employer"); and {{{Employee_name}}}, of the City of {{{Employee_city}}} in the Province of {{{Employee_province}}} (the "Employee").
WHEREAS the Employer desires to obtain the benefit of the services of the Employee, and the Employee desires to render such services on the terms and conditions set forth.
IN CONSIDERATION of the promises and other good and valuable consideration (the sufficiency and receipt of which are hereby acknowledged) the parties agree as follows:
1. Employment
The Employee agrees that he will at all times faithfully, industriously, and to the best of his skill, ability, experience and talents, perform all of the duties required of his position. In carrying out these duties and responsibilities, the Employee shall comply with all Employer policies, procedures, rules and regulations, both written and oral, as are announced by the Employer from time to time. It is also understood and agreed to by the Employee that his assignment, duties and responsibilities and reporting arrangements may be changed by the Employer in its sole discretion without causing termination of this agreement.
2. Position Title
As a _____________, the Employee is required to perform the following duties and undertake the following responsibilities in a professional manner. (a)-. (b) - (c) - (d) - (e) Other duties as may arise from time to time and as may be assigned to the employee.
3. Compensation
(a) As full compensation for all services provided the employee shall be paid at the rate of ____. Such payments shall be subject to such normal statutory deductions by the Employer. (b) (may wish to include bonus calculations or omit in order to exercise discretion). (c) The salary mentioned in paragraph (l)(a) shall be review on an annual basis. (d) All reasonable expenses arising out of employment shall be reimbursed assuming same have been authorized prior to being incurred and with the provision of appropriate receipts.
4. Vacation
The Employee shall be entitled to vacations in the amount of ____ weeks per annum.
5. Benefits
The Employer shall at its expense provide the Employee with the Health Plan that is currently in place or as may be in place from time to time.
6. Probation Period
It is understood and agreed that the first ninety days of employment shall constitute a probationary period during which period the Employer may, in its absolute discretion, terminate the Employee's employment, for any reason without notice or cause.
7. Performance Reviews The Employee will be provided with a written performance appraisal at least once per year and said appraisal will be reviewed at which time all aspects of the assessment can be fully discussed.
8. Termination
(a) The Employee may at any time terminate this agreement and his employment by giving not less than two weeks written notice to the Employer. (b) The Employer may terminate this Agreement and the Employee’s employment at any time, without notice or payment in lieu of notice, for sufficient cause. (c) The Employer may terminate the employment of the Employee at any time without the requirement to show sufficient cause pursuant to (b) above, provided the Employer pays to the Employee an amount as required by the Employment Standards Act 2000 or other such legislation as may be in effect at the time of termination. This payment shall constitute the employees entire entitlement arising from said termination. (d) The employee agrees to return any property of ___________________________ at the time of termination.
9. Non- Competition
(1) It is further acknowledged and agreed that following termination of the employee’s employment with ________________ for any reason the employee shall not hire or attempt to hire any current employees of _________________.
(2) It is further acknowledged and agreed that following termination of the employee’s employment with ________________ for any reason the employee shall not solicit business from current clients or clients who have retained ________________ in the 6 month period immediately preceding the employee’s termination.
10. Laws
This agreement shall be governed by the laws of the Province of Ontario.
11. Independent Legal Advice
The Employee acknowledges that the Employer has provided the Employee with a reasonable opportunity to obtain independent legal advice with respect to this agreement, and that either: (a) The Employee has had such independent legal advice prior to executing this agreement, or; (b) The Employee has willingly chosen not to obtain such advice and to execute this agreement without having obtained such advice.
12. Entire Agreement
This agreement contains the entire agreement between the parties, superseding in all respects any and all prior oral or written agreements or understandings pertaining to the employment of the Employee by the Employer and shall be amended or modified only by written instrument signed by both of the parties hereto.
13. Severability
The parties here to agree that in the event any article or part thereof of this agreement is held to be unenforceable or invalid then said article or part shall be struck and all remaining provision shall remain in full force and effect.
IN WITNESS WHEREOF the Employer has caused this agreement to be executed by its duly authorized officers and the Employee has set his hand as of the date first above written. SIGNED, SEALED AND DELIVERED in the presence of: ________________________________________ [Name of employee] ________________________________________ [Signature of Employee] ________________________________________ [Name of Employer Rep] ________________________________________ [Signature of Employer Rep] [Title]