Operational documentations
This commit is contained in:
parent
4c4fe2bb21
commit
066d7a9114
18
scrap/feature_template.md
Normal file
18
scrap/feature_template.md
Normal file
|
@ -0,0 +1,18 @@
|
|||
#### This provides a template for feature documentations
|
||||
|
||||
# [Name of the feature]
|
||||
|
||||
### Description (what the feature should do)
|
||||
|
||||
|
||||
### Requirements (prerequisite features for the feature)
|
||||
|
||||
- [ ] [Previous feature]
|
||||
|
||||
### Implementation (how the feature should be implemented)
|
||||
|
||||
- [ ] [Classes and methods]
|
||||
|
||||
### Testing (how the feature should be tested)
|
||||
|
||||
- [ ] [Test cases]
|
7
scrap/idea_template.md
Normal file
7
scrap/idea_template.md
Normal file
|
@ -0,0 +1,7 @@
|
|||
# Idea-[Idea name]
|
||||
|
||||
### Key points
|
||||
|
||||
-
|
||||
|
||||
### Description
|
13
scrap/mm_template.md
Normal file
13
scrap/mm_template.md
Normal file
|
@ -0,0 +1,13 @@
|
|||
### [Date]-MeetingMinutes
|
||||
|
||||
### Agenda
|
||||
|
||||
-
|
||||
|
||||
### Decisions
|
||||
|
||||
-
|
||||
|
||||
### Action Items
|
||||
|
||||
-
|
19
scrap/project_stages.md
Normal file
19
scrap/project_stages.md
Normal file
|
@ -0,0 +1,19 @@
|
|||
# Milestones
|
||||
1. MVP (Minimum Viable Product)
|
||||
2. Alpha
|
||||
3. Beta
|
||||
4. Release
|
||||
|
||||
|
||||
## Minimum viable product
|
||||
|
||||
### Feature sets to be done
|
||||
|
||||
- Google Classroom
|
||||
- Redmenta
|
||||
|
||||
## Alpha
|
||||
- TODO Meeting
|
||||
|
||||
## Beta
|
||||
- TODO Meeting
|
38
scrap/sprint.md
Normal file
38
scrap/sprint.md
Normal file
|
@ -0,0 +1,38 @@
|
|||
# Sprint documentation
|
||||
|
||||
### Characteristics of the sprint
|
||||
|
||||
- One week long
|
||||
- Starts on Wednesday
|
||||
- Ends on next Tuesday
|
||||
- The first will start on **2024.05.15**
|
||||
|
||||
## Meeting Structure
|
||||
How a meeting should go down on each wednesday.
|
||||
|
||||
1. Discuss what was done or not done last week.
|
||||
2. Share new ideas or problems.
|
||||
3. Decide what will be done and how this week.
|
||||
4. Assign tasks.
|
||||
5. Set by what sprint it should be done.
|
||||
6. Come up with ideas for the next sprint.
|
||||
|
||||
# Template for the meeting minutes
|
||||
|
||||
The rest of the meeting will be tracked in **OpenProject**.
|
||||
|
||||
```markdown
|
||||
### 2024.05.15-MeetingMinutes
|
||||
|
||||
### Agenda
|
||||
|
||||
-
|
||||
|
||||
### Decisions
|
||||
|
||||
-
|
||||
|
||||
### Action Items
|
||||
|
||||
-
|
||||
```
|
5
scrap/workflow.md
Normal file
5
scrap/workflow.md
Normal file
|
@ -0,0 +1,5 @@
|
|||
# Workflow
|
||||
|
||||
1. Meeting
|
||||
2. Sprint
|
||||
3. Repeat
|
Reference in a new issue