Giter Site home page Giter Site logo

e-journal's Introduction

e-Journal

This repository is meant to be a boilerplate to create a file system that helps people to complete online courses.

e-Journal is a system inspired by Bullet Journal which can be used with any project file system, but also by using a notebook or blank sheets.

Recommended steps:

Course:

Index

  1. Write down the whole structure of the course in INDEX.md (no descriptions needed at this point). There are three levels: Course > Lesson > Activity | Attachment | Concept | Exercise . Write only to LESSON level. Each lesson has its own INDEX.md file.

  2. Once you have the course structure clear, follow the STATS guidelines.

### Stats

#### Legend
* 0: Not Completed
* 1: Completed

---

COURSE 0000

LESSON 1 X00
ACTIVITY 1 X
ACTIVITY 2 0
ACTIVITY 3 0

LESSON 2 0000
...
LESSON n 00000
  • Each activity must have as much 0's as exercises, resources to read or watch. Every time you finish an exercise or resource, replace the 0 with an X.
  • Each lesson must have as much 0's as activities. Every time you finish an activity (no activity 0's left!) replace a 0 with an X.
  • Each course must have as much 0's as lessons. Every time you finish a lesson (no lesson 0's left!) replace a 0 with an X.

This is very helpful to visualize your progress and encourage yourself to complete all the progress bars.

Note: 0's and 1's are the default option. You can change the legends and, instead of using 0's and 1's, you can use, for instance, emoji.

Calendar:

Everytime you finish an exercise, a lesson, an activity... write it down in the CALENDAR.md file using the following format:

## DD/MM/YYYY

* I've finished lesson 1.
* I've finished the exercise "Exercise Title".

You can use this calendar as a TODO list with deadlines, but I do prefer to use it as a tracker of things I have already accomplished. I prefer seing this done rather than things that are still to be done.

Lesson:

Index:

Mandatory

Keep an index of all the content of the lesson.

# Lesson 1: Lesson Name

* 📝 [Activities](./LESSONS/LESSON_1/ACTIVITIES)
  * [Activity Name](./LESSONS/LESSON_1/1_Activity_Name.md)

* 📎 [Attachments](./LESSONS/LESSON_1/ACTIVITIES)

* 🧠 [Concepts](./LESSONS/LESSON_1/CONCEPTS)
  * [Concept Name](./LESSONS/LESSON_1/1_Concept_Name.md)

* ✏️ [Exercises](./LESSONS/LESSON_1/EXERCISES)
  * [Exercise Name](./LESSONS/LESSON_1/1_Exercise_Name.md)

* 📌 [Notes](./LESSONS/LESSON_2/NOTES.md)
* 🔗 [Resources](./LESSONS/LESSON_1/RESOURCES.md)

Activity:

Not Mandatory

Note Activity directories are optional. You can track quizzes, tests and other exercises in the EXERCISES.md file under the LESSON directory. The idea of Activities is to help you with tests and exams you can repeat several times, so you can save and track your errors and learn from them.

  1. In the RESULTS.md file [optional], write down all the attempt results of the activity chronologically. If the exercise consist in a test exam, try to add your answers and the correct / wrong answers too for every attempt.
# Result

## DD/MM/YYYY
1. Question

Answer

Attachments:

Not Mandatory

Concepts:

Mandatory

Save all useful concepts you learn in CONCEPTS directory.

Each filename should have the following format:

n_NameOfTheConcept.md

Where n is the concept's index.

Exercises:

Not Mandatory

In the EXERCISES directory, keep the different exercises. Remember to keep them as small and concise as possible. This file is optional, only needed if the activity has any exercise or if you want to put in practice a concept you have learned.

Each filename should have the following format:

n_NameOfTheExercise.md

Where n is the exercise's index.

Notes:

Not mandatory

Resources:

Not mandatory

In the RESOURCES.md file, keep a list with all the links you've used.

  • Optionally, rank them with stars (*) from 1 to 5, where 5 is the maximum positive score you can give to rank this resource (remember you can use another character on an emoji).
  • Optionally, add a short description of the resource.
# Resources

* [Resource Name](https://examplelink.com/asdfy) *
* [Resource Name](https://examplelink.com/jklnfdsa) *****
  * Resource Description.
* [Resource Name](https://examplelink.com/qwersdf) **

Examples

e-journal's People

Contributors

elenatorro avatar

Stargazers

Luis Colomé avatar Manel Alemany Martinez avatar  avatar Isaac Rozas García avatar gavioto avatar Gabriel Cueto avatar Israel Gutiérrez avatar Jorge Sanz avatar Carlos Azaustre avatar Ej.Gee avatar Manuel Romero avatar Jorge Sanz Pérez avatar Santiago Trigo Porres avatar Javier Cervantes avatar Cristina Fernández Sanz avatar

Watchers

Jan avatar James Cloos avatar gavioto avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.