Skip to content

Commit

Permalink
Deployed 2174ebd to latest with MkDocs 1.5.3 and mike 1.1.2
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-actions
github-actions[bot] committed Feb 9, 2024
1 parent 64d72c1 commit 41fce10
Show file tree
Hide file tree
Showing 3 changed files with 69 additions and 170 deletions.
57 changes: 52 additions & 5 deletions latest/02 Skills4EOSC/FAIR-by-Design_content/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -462,12 +462,55 @@


<h1 id="introduction">Introduction</h1>
<p>Introduction</p>
<p>The FAIR-by-Design Methodology for developing learning materials has been introduced by Skills4EOSC aiming to provide a comprehensive way of developing FAIR learning materials where the necessary FAIR elements are embedded in the materials design process. In this way the methodology guarantees that the produced materials will be FAIR not just from the point of view of the learners, but also other designers and trainers that would like to reuse and adapt the materials for their own purposes. </p>
<p>The premises embedded in the FAIR-by-Design methodology are transcending the fields of learning materials. Therefore, it is quite straightforward to adapt the methodology to produces other types of FAIR digital objects. In the frames of this workshop, we are considering how the FAIR-by-Design methodology can be adapted and used to create FAIR software objects.</p>
<p>We are first going to take a look at the original FAIR-by-Design methodology use for developing learning materials, and then discuss the necessary changes so that it can be reused to produce FAIR software objects. </p>
<h1 id="fair-by-design-methodology-for-learning-materials">FAIR-by-Design Methodology for Learning Materials</h1>
<p><img alt="FAIR-by-Design Methodology for Learning Materials" src="../attachments/FbD-org.png" /></p>
<p>Here goes the content of the learning unit divided into a number of subtopics and any additional headings as necessary.</p>
<p>Use blank rows to divide between paragraphs.</p>
<p>References to external or internal content provided elsewhere should be linked with <a href="https://pages.github.com/">hyperlinks</a>.</p>
<p>The FAIR-by-Design Methodology is created around the popular backward instructional design process that is used to develop high-quality learner-centric materials. We have taken the steps of the backward instruction design process and added additional considerations to ensure that the process will be aimed towards the design of FAIR learning content from both the perspective of the learners and the perspective of the instructional designers and trainers.</p>
<p>The methodology is broken down into a number of stages that are connected in a feedback loop thus enabling continuous improvement:</p>
<ol>
<li>Prepare<ul>
<li>In the Prepare stage the instructional designers need to expand their skillset so that they can practically implement the FAIR principles. This means that in addition to the traditional instructional design skills, they should also be able to work with PIDs, repositories and catalogues, use a corresponding metadata schema, choose a license, and know how to acknowledge reused work with attribution.</li>
<li>One of the important tasks in this stage is to familiarize with the RDA minimal metadata schema for learning resources as this is the basis for the description of the FAIR learning materials.</li>
<li>This is the initial stage of the learning materials development process and thus it is important that in this stage the designer clearly defines the purpose of the learning materials, the target audience and the learning objectives while taking into consideration any prerequisites. </li>
</ul>
</li>
<li>Discover<ul>
<li>Once the vision of what needs to be created is clear, the next step is to discover any existing learning materials that can be reused or simply serve as inspiration. For these purposes the designer needs to search different types of repositories that might host similar learning materials including OER repositories, learning platforms, general repositories and catalogues, as well as multimedia repositories that can provide sources of audio/visual props that are essential in multi-modal learning.</li>
</ul>
</li>
<li>Design<ul>
<li>At this stage the designer has a clear idea of what is needed and what already exists. The next step is to sketch a conceptual map of the learning materials that will help crystalize the ideas and prepare the syllabus for the learning materials. The syllabus is then used as a high-level blueprint for the development of the learning materials.</li>
<li>In the design stage the overall structure of the learning materials is defined identifying all modules and learning units necessary together with the information on what can be reused and what needs to be designed from scratch. Careful attention should be put on license compatibility during this work.</li>
<li>Upon completing the structure, each learning unit needs to be designed using a modeling technique such as the Hunter's model </li>
<li>The design stage should also take into account the need for development of a facilitation guide that explains in details how to prepare and put the training into practice, as well as a feedback form that should be used to gather feedback after the learning process has finished</li>
</ul>
</li>
<li>Produce<ul>
<li>When the design is complete, it is time to move to the produce stage and choose the tools and file formats necessary to develop all of the content. Care must be taken that the chosen file formats are open so that reusability is supported, and it is recommended that a collaborative, versioning system is used to keep track of all contributions and changes. It is important to consider both the editable files that can be reused by trainers and the final file formats intended for learners.</li>
<li>One of the most important aspects of the produce stage is accessibility of the developed learning materials. Accessibility standards should be followed so as to maximize the audience for the learning materials. </li>
<li>During this stage the designers must not forget to add the human-readable and machine-readable metadata in the developed content as well as to develop the content of all facilitation documents such as the guide, activities description, lesson plans, etc.</li>
<li>The final step in the produce stage is to perform an internal Quality Assessment that will check that all elements are present and that the content is adequate.</li>
</ul>
</li>
<li>Publish<ul>
<li>A satisfactory completion of the internal QA leads to the publication steps. Before the actual publication, very important final touches need to be done including activities such as the definition of the content of accompanying files: license, readme, citation, code of conduct and alike.</li>
<li>Once all necessary elements are in place, the learning materials can be published to a selected repo. If GitHub was chosen as the repository in the Produce stage, then the automated bridge between GitHub and Zenodo can be used to create a Zenodo record and obtain a DOI PID for the learning materials. This records is primarily intended for reuse by other designers and trainers. </li>
<li>In addition, the complete learning environment should be setup in a learning platform where the final file formats will be provided to the learners.</li>
</ul>
</li>
<li>Verify<ul>
<li>The final steps in the methodology is to perform another QA round, this time focusing on external QA. At this stage the overall level of FAIRness of the learning materials needs to be checked and external experts should be used to provide unbiased feedback regarding the quality of the produced materials. </li>
<li>This stage also focuses on setting up different mechanism for gathering feedback so that the learning materials can be further improved. In this way it fosters the co-creation process that empowers learners and other designers and trainers to actively participate in the development.</li>
</ul>
</li>
<li>Continuous Improvement<ul>
<li>the gathered internal and external feedback should be used as input for the development of a new version of the learning materials.</li>
<li>upon the identification of potential improvements that should be implemented, the development processes circles back to the first stage aiming to publish a new improved version of the learning materials.</li>
</ul>
</li>
</ol>
<h1 id="fair-by-design-methodology-for-software-objects">FAIR-by-Design Methodology for Software Objects</h1>
<p><img alt="Software Development Process" src="../attachments/SDP.png" />
Taken from https://www.spaceotechnologies.com/blog/software-development-process/ </p>
Expand All @@ -477,7 +520,11 @@ <h2 id="summary">Summary</h2>
<h2 id="suggested-reading">Suggested Reading</h2>
<ul>
<li><a href="https://zenodo.org/records/8419242">Skills4EOSC FAIR-by-Design Methodology for Learning Materials Development</a></li>
<li><a href="https://zenodo.org/records/10063110">FAIR-by-Design Learning Materials Methodology Training of Trainers</a></li>
<li><a href="https://zenodo.org/records/10063110">FAIR-by-Design Learning Materials Methodology Training of Trainers on Zenodo</a></li>
<li><a href="https://learning.skills4eosc.eu/course/view.php?id=19">FAIR-by-Design Learning Materials Methodology Training of Trainers on LMS</a></li>
<li><a href="https://github.com/FAIR-by-Design-Methodology/FAIR-by-Design_ToT">FAIR-by-Design Learning Materials Methodology Training of Trainers on GitHub</a></li>
<li><a href="https://fair-by-design-methodology.github.io/FAIR-by-Design_ToT/latest/">FAIR-by-Design Learning Materials Methodology Training of Trainers GitBook</a></li>
<li><a href="https://github.com/FAIR-by-Design-Methodology/templates">FAIR-by-Design Learning Materials Methodology Templates Repository</a></li>
</ul>


Expand Down
182 changes: 17 additions & 165 deletions latest/03 Put it into practice/metadata_content/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -446,54 +446,6 @@
Learning Content Topic
</a>

<nav class="md-nav" aria-label="Learning Content Topic">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#sub-subtitle" class="md-nav__link">
Sub-subtitle
</a>

</li>

<li class="md-nav__item">
<a href="#lists" class="md-nav__link">
Lists
</a>

</li>

<li class="md-nav__item">
<a href="#images" class="md-nav__link">
Images
</a>

</li>

<li class="md-nav__item">
<a href="#accessibility" class="md-nav__link">
Accessibility
</a>

</li>

<li class="md-nav__item">
<a href="#tables" class="md-nav__link">
Tables
</a>

</li>

<li class="md-nav__item">
<a href="#related-learning-materials" class="md-nav__link">
Related Learning Materials
</a>

</li>

</ul>
</nav>

</li>

<li class="md-nav__item">
Expand Down Expand Up @@ -605,54 +557,6 @@
Learning Content Topic
</a>

<nav class="md-nav" aria-label="Learning Content Topic">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#sub-subtitle" class="md-nav__link">
Sub-subtitle
</a>

</li>

<li class="md-nav__item">
<a href="#lists" class="md-nav__link">
Lists
</a>

</li>

<li class="md-nav__item">
<a href="#images" class="md-nav__link">
Images
</a>

</li>

<li class="md-nav__item">
<a href="#accessibility" class="md-nav__link">
Accessibility
</a>

</li>

<li class="md-nav__item">
<a href="#tables" class="md-nav__link">
Tables
</a>

</li>

<li class="md-nav__item">
<a href="#related-learning-materials" class="md-nav__link">
Related Learning Materials
</a>

</li>

</ul>
</nav>

</li>

<li class="md-nav__item">
Expand Down Expand Up @@ -730,75 +634,23 @@ <h2 id="learning-tools">Learning Tools</h2>
<li>examples include required software, access to resources, etc.</li>
</ul>
<h2 id="learning-content-topic">Learning Content Topic</h2>
<p>Here goes the content of the learning unit divided into a number of subtopics and any additional headings as necessary.</p>
<p>Use blank rows to divide between paragraphs.</p>
<p>References to external or internal content provided elsewhere should be linked with <a href="https://pages.github.com/">hyperlinks</a>.</p>
<h3 id="sub-subtitle">Sub-subtitle</h3>
<p>Refer to a different learning unit using a relative link. For an example, see the <a href="../../">Syllabus</a> file.</p>
<p><em>Example italic text</em></p>
<p><strong>Example bold text</strong></p>
<h3 id="lists">Lists</h3>
<p>Example numbered bullets:</p>
<ol>
<li>numbered list one</li>
<li>two</li>
<li>three</li>
</ol>
<p>Example unnumbered list.</p>
<ul>
<li>unnumbered list</li>
<li>item two</li>
<li>item three<ul>
<li>subitem</li>
<li>use 4 spaces to create nested subitem</li>
</ul>
</li>
</ul>
<p>You can also create mixed lists:</p>
<ul>
<li>mixed list<ol>
<li>now numbered subitem</li>
<li>subitem number two</li>
</ol>
</li>
<li>back to mixed list level 1 bullet</li>
</ul>
<h3 id="images">Images</h3>
<p>To add an image, first place the image in the /attachments folder and then use a relative link similar to above using a ! in front.
All images should be located in the attachments folder that is on the same level with the content file. </p>
<p><img alt="alternative text for accessibility an image of a macaw parrot" src="attachments/macaw-g8f80c4f64_640.jpg" /></p>
<p>Caption: Macaw Parrot
Image by <a href="https://pixabay.com/users/kayuli-781524">Karina Copa</a> from <a href="https://pixabay.com">Pixabay</a></p>
<p>Don't forget attribution if the image was not created by you. If you are reusing images or text clear attribution should be provided as in the example above. Same applies in case of reusing text or other type of content. Be careful to follow the attribution rules as provided by the image source (in the example above it is Pixabay).</p>
<h3 id="accessibility">Accessibility</h3>
<p>Using headings and subheadings, lists and alternative text for images is extremely important so as to ensure accessibility of the content for people with impairments. Also, take care to choose the appropriate color pallette for images.</p>
<h3 id="tables">Tables</h3>
<p>Tables are a bit tricky in md, the easiest way to create them is to use a tool that will generate the md code that you can then just copy paste in your content file.
One such tool that can be used is the <a href="https://www.tablesgenerator.com/markdown_tables">Markdown Tables Generator</a> available online. The provided example table has been generated using this tool. </p>
<table>
<thead>
<tr>
<th><strong>Column 1 title</strong></th>
<th><strong>Column 2 title</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>content 1</td>
<td>content 4</td>
</tr>
<tr>
<td>content 2</td>
<td>content 5</td>
</tr>
<tr>
<td>content 3</td>
<td>content 6 content 7</td>
</tr>
</tbody>
</table>
<h3 id="related-learning-materials">Related Learning Materials</h3>
<p>Refer to exercises, quizzes, games or other types of learning materials where ever they should be included in the unit and provide links to this content.</p>
<p>Create a repo on GitHub
Use GitDesktop
Add sample Jupyter notebooks (supplied) or other software of choice
Adapt file headers with info
Define Metadata (metacode.json)
Define Citation (citation.cff)
Define License
Define Readme
Description
Dependencies
Test
…
Use SWH or Zenodo?
Review template for possible automated workflow
Measure the FAIRness of your effort
Paper based +
Example tools that are in their development stage</p>
<h2 id="summary">Summary</h2>
<p>At the end provide a short summary of the main points of the learning unit (these are the key takeaways that help reflect on the learning outcomes)</p>
<h2 id="suggested-reading">Suggested Reading</h2>
Expand Down
Binary file modified latest/sitemap.xml.gz
View file
Binary file not shown.

0 comments on commit 41fce10

Please sign in to comment.