Template:Proposal
Project page structure
Projects scope must be described on PKC on the following structure:
- Intro (no title)
- History factors (in case it needed or if exists)
- Logic Model (Purpose, Problem-solving or how project differ from others, success criteria; inputs, process, Outputs) There is a template for the logic model in [PKC Logic Model |here].
- Define project needs (resources, time, costs)
- Define context (if needed e.g. education - What, How, why, etc... of curriculum or programs)
- Quality issues or boundary conditions
- Stakeholders identification
- Budget
- 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 deliver/TRLs
- (Define the levels for each phase)
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)