Introduction
Welcome to the Hudi Documentation!
Confidentiality
If you have not signed an NDA with 10/10, Hudi, Calm Experts or any of its subsidiaries, you are not permitted to have access to this document nor any of its associated documents. If you are an employee or contractor with any of these companies or brands, you are bound by your Employment Agreement, NDA, our Code of Conduct and Development Guidelines. Make sure you have refreshed your memory on all these internal guidelines before reading this document or working on this project.
Complience
Review carfulay the following document to ensure you are within complients.
The documents linked are drafts, be sure to review the copies you have signed. If you have not sign these documents, you should not continue reading this documentation and contact whoever shared this link with you.
- NDA
- Employment Agreement
- Code of Conduct
- Development Guidelines
It is important that you do not attempt to understand all of the documentation, many of the docs are not relevant and not complete.
Be sure to focuse on the docs that are most relevant to the tasks you are assigned to.
If you need more information about your task or things the doces need more information, please contact Mendy.
Knowladge
The "Knowladge" documentation is meant for you to gain knaladge about Hudi and it's development, it is an extemtion of the Calm Experts Knalwadge and is spesified to the Hudi developemnt. If you are alredy familiar with the Hudi Knowladge, feel free to jump into the Product+ or Turtleneck Documentation.
Resources
- Calm Experts Knowladge
- Knawladge Day
- Google Cources
Getting started
Depending on the role you play, the team you are on or how much knowlage you already have, you may want to start in difrent places.
If you have already been through the Knowladge Base, feel free to jump right into your work, otherwise it is crucal that you review how we work and how to keep your work safe and orginized.
Bellow are your staring points for you to choose, however, be sure to complete the Hudi Starter before you move on to the section of your choice.
- Knowladge
- Products & Features
- Development
Knowladge
The "Knowladge" part of the documentation is where you can find everything related to how we do things at Hudi, the particies you should be keeping and more.
Before you start, be sure to read or have a signed copy of all the nesasary documents.
- NDA
- Code of Conduct
- Employment Agreement
List of Contents
- Personas
- Securaty
- Best Prastices
Links & Resources
Hudi
Google
This is where you will find all the details about the "Products" and "Features" we have and want to build, it is a boths a guide on what/how to build as well as how things have been built and how to maintain them.
Here we focus on the information meant for developers, how this project should be or is developed. The development documentation is designed to outline the development method and to explain some technical aspects. For a full product description and operations details refer to Hudi | Documentation. Already read the legal gibarish? Now you can get familiar with the project.
Here are the technical details about the development of the products, features, infrastrcuture and more. Consider this the developers space, while all other documentation should be clear and understable to all team member inclusing sales, marketing, etc. this space is for details only devs may understand.
Data
Backend
Frontend
Expected Outcome
By the time we complete the development documentation, we should have a close to or complete understanding of the tech stack, data structure, code structure, dependencies and anything else needed to accomplish the full development of this product.
Links & Resources
Details & Status
| Owner | Mendy Marcus |
|---|---|
| Due | Date |
| Requirements | |
| Time Frame | 2 Weeks |
| Documents | File |
| Status | New |
Management
To deliver our product at the highest possible value, we are going to use the Scrum agile methodology, so we can manage our software development and solve our problems as new tasks will appear. Scrum is the practice of setting weekly or bi-monthly goals. Scrums and the project itself will be managed by Mendy Marcus and the lead developer will be Person. Management Tools Similar to our tech stack, here are the tools we will be using to organize our development. We will use Google chat to communicate internally
Email should be used for any official business questions or requests as well as all external communication such as with the client, suppliers, customers, etc. All documents will be stored and managed on Google Drive. GitHub will be our code manager. GitHub Projects will be our scrum manager We will also be transferring much of our documentation to docs.hudieverything.com
| Position | Held By |
|---|---|
| CTO | |
| Development Manager | |
| Frontend Lead | |
| Backend Lead | |
| Security Lead | |
| Tasks |
- [ ]
- [ ]
Docs
The documentation should be regularly updated, to contribute to the documentation, you will need to get familiar with Docusarus, in addition you should familirize yourself with our Documentation Structure
List of Contents
- Testing
- DevOps