From 066d7a91149f9a8ed6b0b600e20dfb3fe699aac2 Mon Sep 17 00:00:00 2001 From: TGyAkos Date: Mon, 13 May 2024 21:54:13 +0200 Subject: [PATCH] Operational documentations --- scrap/feature_template.md | 18 ++++++++++++++++++ scrap/idea_template.md | 7 +++++++ scrap/mm_template.md | 13 +++++++++++++ scrap/project_stages.md | 19 +++++++++++++++++++ scrap/sprint.md | 38 ++++++++++++++++++++++++++++++++++++++ scrap/workflow.md | 5 +++++ 6 files changed, 100 insertions(+) create mode 100644 scrap/feature_template.md create mode 100644 scrap/idea_template.md create mode 100644 scrap/mm_template.md create mode 100644 scrap/project_stages.md create mode 100644 scrap/sprint.md create mode 100644 scrap/workflow.md diff --git a/scrap/feature_template.md b/scrap/feature_template.md new file mode 100644 index 0000000..c69ff4f --- /dev/null +++ b/scrap/feature_template.md @@ -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] \ No newline at end of file diff --git a/scrap/idea_template.md b/scrap/idea_template.md new file mode 100644 index 0000000..37a7c54 --- /dev/null +++ b/scrap/idea_template.md @@ -0,0 +1,7 @@ +# Idea-[Idea name] + +### Key points + +- + +### Description diff --git a/scrap/mm_template.md b/scrap/mm_template.md new file mode 100644 index 0000000..9a7f031 --- /dev/null +++ b/scrap/mm_template.md @@ -0,0 +1,13 @@ +### [Date]-MeetingMinutes + +### Agenda + +- + +### Decisions + +- + +### Action Items + +- diff --git a/scrap/project_stages.md b/scrap/project_stages.md new file mode 100644 index 0000000..7ffcb08 --- /dev/null +++ b/scrap/project_stages.md @@ -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 \ No newline at end of file diff --git a/scrap/sprint.md b/scrap/sprint.md new file mode 100644 index 0000000..24fa9a2 --- /dev/null +++ b/scrap/sprint.md @@ -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 + +- +``` \ No newline at end of file diff --git a/scrap/workflow.md b/scrap/workflow.md new file mode 100644 index 0000000..755d4eb --- /dev/null +++ b/scrap/workflow.md @@ -0,0 +1,5 @@ +# Workflow + +1. Meeting +2. Sprint +3. Repeat \ No newline at end of file -- 2.44.1