...
 
Commits (2)
<!-- This is to propose a new learning structure to the fns community -->
<!-- This is for proposing a new Learning Structure (aka: Structure) -->
<!-- A learning structure is any tool, system, or technique that helps people "structure" their learning -->
<!-- Note: It's not required that you submit a proposal for each new structure you want to experiment with in your own learning. This is a means of proposing new structures you want to share, invite comment on, and make available for other community members to try out. It's the first step to getting a learning structure added to the "structures" repo -->
<!-- A Structure is any tool, system, or technique that helps people "structure" their learning -->
<!-- (https://gitlab.com/fathom/fns/structures) -->
--------------------------------------------------------------------------------
## What is the learning structure you are proposing?
<!-- write a short descriptive title for the structure -->
## Description of learning structure
<!-- Describe the structure in a simple way that learners of all stripes could understand -->
## Motivation
<!-- How does this structure help with learning? What problem does it solve for the learner? -->
## Describe the proposed Structure:
<!-- What is it? How does it help to structure one's learning? What problem does it solve for the learner? -->
## Implementation
<!-- How does the structure actually work? What steps would you need to follow? Suggest a way of implementing it into one's learning. If you have already experimented with it, you can describe how you used it in your own learning. Include any details people ought to consider when trying the structure out in their own learning context -->
## Implementation:
<!-- How does the structure actually work, in practice? What steps would you need to follow? -->
<!-- Include any information people ought to know when trying the structure out -->
## Links and Resources
<!-- Add relevant images, links, code-snippets, etc. -->
## Examples:
<!-- Describe actual examples of use, such as how you've used it in your own learning -->
<!-- This can also include links to other sources (images, documentation, etc.) -->
<!-- See Adventures (https://gitlab.com/fathom/fns/structures/tree/master/1-learning-adventures) -->
<!-- for a format that can help with generating examples of Structures within learning -->
--------------------------------------------------------------------------------
**NOTE**:
Please add your thoughts to the discussion below to help with the consideration of this proposal.
And if you decide to try out this structure within your own learning, please follow up with your feedback
about how the structure worked for you and your ideas about how it can be changed or improved.
**Note**:
Post to the discussion below to help consider and develop this proposal.
**For more on learning structures**:
Read more about [learning structures](https://gitlab.com/fathom/fns/structures). Also, read about [learning adventures](https://gitlab.com/fathom/fns/structures/tree/master/1-learning-adventures), a standardized format for experimenting with different learning structures within the context of a particular learning project/plan.
And if you try the Structure out for yourself, please contribute your reflections and feedback!
--------------------------------------------------------------------------------
......
# FNS Structures
# Structures (aka: learning structures)
This repository is a collection of **learning structures** that are defined and
developed by an open community.
This repository is a collection of Structures that are defined and developed by an open community. They are available for anybody to use, as they wish, for their own learning.
_What are learning structures?_
_What are Structures?_
They are any tools, systems, or techniques that we can use to "structure" our
learning.
They are available here for anybody to use, as they wish, within their own
learning experiences.
_What are some possible examples of learning structures?_
They are any tools, systems, or techniques that people can use to "structure" their learning. Some possible examples could be:
- a system for running online study groups
- a set of smart contracts for crowdfunding lectures
- an accountability system that keeps you (and any study partners) on track
- a method for taking notes
...or anything else that can be used for _structure_ in one's learning.
## Motivation
Formal structures are incredibly powerful for learning, but they often get
trapped in an institutional "school" context. This repository is intended to be
a context agnostic home for learning structures that anyone can contribute to
and use.
trapped in an institutional "school" context. This repository is intended to be a context agnostic home for learning structures that anyone can access, use, or contribute to.
<br>
<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-refresh-toc -->
**Table of Contents**
- [FNS Structures](#fns-structures)
- [Structures (aka: learning structures)](#structures-aka-learning-structures)
- [Motivation](#motivation)
- [How can you create a new structure?](#how-can-you-create-a-new-structure)
- [Step 1. Propose a new structure](#step-1-propose-a-new-structure)
- [Step 2. Test the structure and gather some examples](#step-2-test-the-structure-and-gather-some-examples)
- [Step 3. Format the structure for submission](#step-3-format-the-structure-for-submission)
- [Step 4. Merging In the structure](#step-4-merging-in-the-structure)
- [Step 5. Maintaining the structure](#step-5-maintaining-the-structure)
- [Format](#format)
- [How can you use a Structure?](#how-can-you-use-a-structure)
- [How can you create a new Structure?](#how-can-you-create-a-new-structure)
- [Step 1. Propose a new Structure](#step-1-propose-a-new-structure)
- [Using a Structure in an Adventure](#using-a-structure-in-an-adventure)
- [Step 2. Format, Review and Merge the Structure](#step-2-format-review-and-merge-the-structure)
- [Format](#format)
- [Review and Merge](#review-and-merge)
- [Step 3. Maintaining the Structure](#step-3-maintaining-the-structure)
- [Editors](#editors)
<!-- markdown-toc end -->
<br>
# How can you create a new structure?
# How can you use a Structure?
Do you have an idea for a learning structure that you'd like to propose? Anyone is welcome to contribute!
Just follow the steps below:
You can use a Structure anyway you want to. If it helps your learning, then you're using it well. The best way to start is by looking for one in this repo that interests you, and then trying it out for yourself.
## Step 1. Propose a new structure
The Structure's name may give you an initial idea of what it's about. Each Structure will also have documentation and examples to help explain how it can be used in learning. But don't feel bound to those instructions: feel free to adapt or extend Structures in order to support _your_ learning.
Start by opening a ~Proposal issue. In it you should describe the structure, how it helps with learning,
and how it can be implemented in actual practice. While not mandatory, it's recommended that the structure you're proposing is something that: you've actually
used, you're planning to use, or you've observed firsthand (See Step 2)
You can copy, clone, download or fork any of the Structures here. And if you have any questions about a Structure -- or suggestions for improving it -- you can contact its Maintainers directly.
## Step 2. Test the structure and gather some examples
Structures start with people, and are rooted in actual learning experiences.
In order for a proposal to be adopted into this repository as a new structure,
there needs to be at least one documented example of its use.
<br>
The [Learning Adventure](https://gitlab.com/fathom/fns/structures/tree/master/1-learning-adventures)
is a format you can use to test the structure in the context of your own learning.
It lays out a process for you to define a structure for yourself, implement it within
a learning project, reflect on it, and share it with the community.
This is a good way to build out the first examples of a structure's use in the real world.
# How can you create a new Structure?
Once you've got that in place, it's time to submit the new structure.
Do you have an idea for a learning structure that you'd like to propose? Anyone is welcome to contribute!
## Step 3. Format the structure for submission
Just follow the steps below:
You can submit the new structure by opening a ~Proposal Merge Request (MR) in this
repository. The file for the proposed structure should follow the [format](#format)
described below, and include links to assets (images, documentation, code, etc)
that provide evidence, context, and support.
<br>
The MR will be reviewed by the [editors](#editors) of this repository.
They will be checking that the proposal is correctly formatted,
sufficiently documented, and logically consistent.
During the review phase the editors will be in communication with you about any
additions, clarifications, or revisions that are needed.
## Step 1. Propose a new Structure
Start by opening a ~Proposal issue. In it you should describe the Structure, how it helps with learning, and how it can be implemented in actual practice.
## Step 4. Merging In the structure
- #### The Power of Examples
Structures come from real people and are rooted in actual learning experiences. The Structure you're proposing should be something that: you've actually used, you're planning to use, or you've observed firsthand.
Once the Structure is ready the editor will assign it a sequential number and merge it
in. At this point it's part of FNS and is available for others to use!
- #### Using a Structure in an Adventure
If you need to to generate examples for your Structure, the [Learning Adventure](https://gitlab.com/fathom/fns/structures/tree/master/1-learning-adventures) (aka: Adventure) is a format you may find helpful. A Structure, itself, it was designed to enable people to experiment with other Structures. The Adventure helps you define a self-directed learning plan and then execute on it, while also documenting and reflecting on the process. Thus you can consciously incorporate your Structure within your planned Adventure, and then document how it works in the context of your own learning. This is a good way to build out the first examples of a Structure's use in real life.
The issue you've opened will help you organize the fundamental aspects of the Structure. Once you've got them in place, it's time to move on to the next step: formatting and submitting the Structure for review.
## Step 5. Maintaining the structure
<br>
A structure isn't set in stone when it's merged in. Others can contribute
to it and propose changes. As the author you'll be the *maintainer* of the
structure. This means it'll be your responsibility to respond to contributors,
answer their questions, and work with them to approve or
reject additional proposals.
## Step 2. Format, Review and Merge the Structure
If you want, you can assign other individuals as co-maintainers. You can even
transfer your role to someone else and step down if you need to.
Just keep in mind that it's important for a structure to be well maintained
so that it can continue to provide relevance and value to its community of learners.
When you're ready to have your Structure reviewed, open a ~Proposal Merge Request (**MR**) in this repository. Along with that, you'll prepare a markdown document, as follows:
- ### Format
Create a `README.md` document in markdown to define your Structure (for examples, you can take a look at other Structures published to this repo).
The top of the page must include some metadata (YAML frontmatter):
# Format
```
number:
title:
maintainers:
```
The `number` will be assigned later by one of the [editors](#editors). The `title` is the name of the Structure you're submitting. The `maintainers` should list you, as the Structure's author (plus, optionally, any co-maintainers -- see more info below, in [Step 3](#step-3-maintaining-the-structure)).
Each structure is defined in a document written in markdown. Each has:
- a name
- a number, prefixed with FNS (e.g., FNS-1)
- a list of maintainers
- a high level definition
- and most importantly, *examples* of its actual use
After that part, the Structure's README should contain the following sections (which correlate with the contents in your ~Proposal issue):
- **Abstract**: a high level definition of the Structure and its goals
- **Implementation**: anything information that's essential or even helpful to know in using the Structure
- **Examples**: documented examples of the Structure's actual use (note: this can link to other sources)
**Examples** are instances of individuals actually using the structure (or some
variation of it) in the real world. We want structures to be deeply rooted in
the experience of those using them, not merely coming from some abstract place.
Beyond that, feel free to include other sections if you think they're important. For example, an _Assets_ section (e.g., images, documentation, code) could be useful; or a _References_ section could point out sources from which inspiration was drawn.
Each structure has YAML frontmatter that contains some metadata.
```
number:
title:
maintainers
```
- ### Review and Merge
The Merge Request for your Structure will be reviewed by the [editors](#editors) of this repository. They will be checking that the proposal is correctly formatted, sufficiently documented, and logically consistent.
It also **must** contain several top level headers:
During the review phase, the editors will be in communication with you about any additions, clarifications, or revisions that are needed.
- **Abstract**: a high level description of the structure and its goals
- **Examples**: a list of links to implementations of this structure
Once the Structure is ready, the editor will assign it a sequential number and merge it in. At this point it's part of Structures and is available for others to use!
There are also some suggested sections:
<br>
- **References**: a list of references that were used in the structure
## Step 3. Maintaining the Structure
A structure isn't set in stone when it's merged in. Others can contribute
to it and propose changes. As the author you'll be the *maintainer* of the
structure. This means it'll be your responsibility to respond to contributors,
answer their questions, and work with them to approve or
reject additional proposals.
If you want, you can assign other individuals as co-maintainers. You can even
transfer your role to someone else and step down if you need to.
Just keep in mind that it's important for a structure to be well maintained
so that it can continue to provide relevance and value to its community of learners.
<br>
# Editors
The editors are the ones responsible for maintaining this repository. They
review new structure submissions, manage changes in maintainers, and generally make sure
everything here runs smoothly.
review new Structure submissions, manage changes in maintainers, and generally make sure everything here runs smoothly.
The current editors are:
......