mirror of
https://github.com/clearlinux/clear-linux-documentation.git
synced 2026-04-28 19:13:46 +00:00
180 lines
9.9 KiB
HTML
180 lines
9.9 KiB
HTML
|
||
<!DOCTYPE html>
|
||
|
||
<html lang="en" data-content_root="../">
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||
|
||
<title>Tutorial difficulty ratings — Documentation for Clear Linux* project</title>
|
||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/bizstyle.css?v=5283bb3d" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
|
||
|
||
<script src="../_static/documentation_options.js?v=5929fcd5"></script>
|
||
<script src="../_static/doctools.js?v=9bcbadda"></script>
|
||
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||
<script src="../_static/clipboard.min.js?v=a7894cd8"></script>
|
||
<script src="../_static/copybutton.js?v=a56c686a"></script>
|
||
<script src="../_static/bizstyle.js"></script>
|
||
<link rel="canonical" href="https://clearlinux.github.io/clear-linux-documentation/reference/tutorial-ratings.html" />
|
||
<link rel="icon" href="../_static/favicon.ico"/>
|
||
<link rel="author" title="About these documents" href="../about.html" />
|
||
<link rel="index" title="Index" href="../genindex.html" />
|
||
<link rel="search" title="Search" href="../search.html" />
|
||
<link rel="next" title="FAQ" href="../FAQ/index.html" />
|
||
<link rel="prev" title="telemetry" href="manpages/telemetry.3.html" />
|
||
<meta name="viewport" content="width=device-width,initial-scale=1.0" />
|
||
<!--[if lt IE 9]>
|
||
<script src="_static/css3-mediaqueries.js"></script>
|
||
<![endif]-->
|
||
</head><body>
|
||
<div class="related" role="navigation" aria-label="Related">
|
||
<h3>Navigation</h3>
|
||
<ul>
|
||
<li class="right" style="margin-right: 10px">
|
||
<a href="../genindex.html" title="General Index"
|
||
accesskey="I">index</a></li>
|
||
<li class="right" >
|
||
<a href="../FAQ/index.html" title="FAQ"
|
||
accesskey="N">next</a> |</li>
|
||
<li class="right" >
|
||
<a href="manpages/telemetry.3.html" title="telemetry"
|
||
accesskey="P">previous</a> |</li>
|
||
<li class="nav-item nav-item-0"><a href="../index.html">Documentation for Clear Linux* project</a> »</li>
|
||
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Reference</a> »</li>
|
||
<li class="nav-item nav-item-this"><a href="">Tutorial difficulty ratings</a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
<div class="document">
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
<div class="body" role="main">
|
||
|
||
<section id="tutorial-difficulty-ratings">
|
||
<span id="tutorial-ratings"></span><h1>Tutorial difficulty ratings<a class="headerlink" href="#tutorial-difficulty-ratings" title="Link to this heading">¶</a></h1>
|
||
<p>Tutorial difficulty ratings provide a simple way to start using and developing with Clear Linux* OS. If you’re new to the distro, we suggest starting with <code class="docutils literal notranslate"><span class="pre">Easy</span></code> tutorials and working towards the more <code class="docutils literal notranslate"><span class="pre">Difficult</span></code>. Ratings not only expose learning paths but also provide a starting point from which to advance or improve use cases, so be sure to <a class="reference internal" href="../collaboration/collaboration.html#collaboration"><span class="std std-ref">share your insights</span></a>. Three main metrics help us to determine how to rate a tutorial:</p>
|
||
<nav class="contents local" id="contents">
|
||
<ul class="simple">
|
||
<li><p><a class="reference internal" href="#time-and-complexity" id="id2">Time and complexity</a></p></li>
|
||
<li><p><a class="reference internal" href="#user-experience-level" id="id3">User experience level</a></p></li>
|
||
<li><p><a class="reference internal" href="#impact-of-failure" id="id4">Impact of failure</a></p></li>
|
||
</ul>
|
||
</nav>
|
||
<p>The sum total of these metrics, the rating shown in Figure 1, represents the
|
||
ability to successfully complete a tutorial based on skill level, balanced against the risk of failure.</p>
|
||
<figure class="align-default" id="id1">
|
||
<a class="reference internal image-reference" href="../_images/tutorial-ratings-01.svg"><img alt="Tutorial difficulty ratings" src="../_images/tutorial-ratings-01.svg" style="width: 901.0px; height: 519.0px;" />
|
||
</a>
|
||
<figcaption>
|
||
<p><span class="caption-text">Figure 1: Tutorial difficulty ratings</span><a class="headerlink" href="#id1" title="Link to this image">¶</a></p>
|
||
</figcaption>
|
||
</figure>
|
||
<section id="time-and-complexity">
|
||
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Time and complexity</a><a class="headerlink" href="#time-and-complexity" title="Link to this heading">¶</a></h2>
|
||
<p>Are there about 8 or more <em>complex</em> steps? <em>Complex steps</em> are those that:</p>
|
||
<ul class="simple">
|
||
<li><p>Require more than one action</p></li>
|
||
<li><p>Require external reading/review</p></li>
|
||
<li><p>Include explanation or context</p></li>
|
||
<li><p>Give alternative(s)</p></li>
|
||
</ul>
|
||
<p>This metric factors in the cognitive load and its impact on a user.</p>
|
||
</section>
|
||
<section id="user-experience-level">
|
||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">User experience level</a><a class="headerlink" href="#user-experience-level" title="Link to this heading">¶</a></h2>
|
||
<p>Our tutorials primarily target two types of Linux users.</p>
|
||
<p><strong>Experienced</strong> A Linux* user who is familiar with common topics like userspace, networking, sudo privileges, services, and more.</p>
|
||
<p><strong>Advanced</strong> A Linux user who is beyond Experienced and is familiar with most sysadmin and programming topics.</p>
|
||
<p>This metric establishes a starting point for skills, based on user
|
||
experience.</p>
|
||
</section>
|
||
<section id="impact-of-failure">
|
||
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Impact of failure</a><a class="headerlink" href="#impact-of-failure" title="Link to this heading">¶</a></h2>
|
||
<p>The impact of failure calculates the risk of failing to complete a tutorial as a result of entering incorrect data or configuration, or failing to follow the steps in the given order. We estimate the potential state of a system, given these failure scenarios and their severity. This metric also factors in the ability to troubleshoot and recover when faced with errors. Therefore, the final impact incorporates the previous two metrics while it helps to predict an appropriate difficulty rating.</p>
|
||
<ul class="simple">
|
||
<li><p>Will impact of errors be inconsequential? <code class="docutils literal notranslate"><span class="pre">Easy</span></code></p></li>
|
||
<li><p>Will impact of errors cause inconvenience (but system still works)? <code class="docutils literal notranslate"><span class="pre">Moderate</span></code></p></li>
|
||
<li><p>Will impact of errors cause system failure (difficult to recover)? <code class="docutils literal notranslate"><span class="pre">Difficult</span></code></p></li>
|
||
</ul>
|
||
</section>
|
||
</section>
|
||
|
||
|
||
<div class="clearer"></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sphinxsidebar" role="navigation" aria-label="Main">
|
||
<div class="sphinxsidebarwrapper">
|
||
<p class="logo"><a href="../index.html">
|
||
<img class="logo" src="../_static/clearlinux.png" alt="Logo of Clear Linux* Project Docs"/>
|
||
</a></p>
|
||
<div>
|
||
<h3><a href="../index.html">Table of Contents</a></h3>
|
||
<ul>
|
||
<li><a class="reference internal" href="#">Tutorial difficulty ratings</a><ul>
|
||
<li><a class="reference internal" href="#time-and-complexity">Time and complexity</a></li>
|
||
<li><a class="reference internal" href="#user-experience-level">User experience level</a></li>
|
||
<li><a class="reference internal" href="#impact-of-failure">Impact of failure</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
</div>
|
||
<div>
|
||
<h4>Previous topic</h4>
|
||
<p class="topless"><a href="manpages/telemetry.3.html"
|
||
title="previous chapter">telemetry</a></p>
|
||
</div>
|
||
<div>
|
||
<h4>Next topic</h4>
|
||
<p class="topless"><a href="../FAQ/index.html"
|
||
title="next chapter">FAQ</a></p>
|
||
</div>
|
||
<div role="note" aria-label="source link">
|
||
<h3>This Page</h3>
|
||
<ul class="this-page-menu">
|
||
<li><a href="../_sources/reference/tutorial-ratings.rst.txt"
|
||
rel="nofollow">Show Source</a></li>
|
||
</ul>
|
||
</div>
|
||
<search id="searchbox" style="display: none" role="search">
|
||
<h3 id="searchlabel">Quick search</h3>
|
||
<div class="searchformwrapper">
|
||
<form class="search" action="../search.html" method="get">
|
||
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||
<input type="submit" value="Go" />
|
||
</form>
|
||
</div>
|
||
</search>
|
||
<script>document.getElementById('searchbox').style.display = "block"</script>
|
||
</div>
|
||
</div>
|
||
<div class="clearer"></div>
|
||
</div>
|
||
<div class="related" role="navigation" aria-label="Related">
|
||
<h3>Navigation</h3>
|
||
<ul>
|
||
<li class="right" style="margin-right: 10px">
|
||
<a href="../genindex.html" title="General Index"
|
||
>index</a></li>
|
||
<li class="right" >
|
||
<a href="../FAQ/index.html" title="FAQ"
|
||
>next</a> |</li>
|
||
<li class="right" >
|
||
<a href="manpages/telemetry.3.html" title="telemetry"
|
||
>previous</a> |</li>
|
||
<li class="nav-item nav-item-0"><a href="../index.html">Documentation for Clear Linux* project</a> »</li>
|
||
<li class="nav-item nav-item-1"><a href="index.html" >Reference</a> »</li>
|
||
<li class="nav-item nav-item-this"><a href="">Tutorial difficulty ratings</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class="footer" role="contentinfo">
|
||
© Copyright 2022 Intel Corporation. All Rights Reserved..
|
||
Last updated on Nov 04, 2024.
|
||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
|
||
</div>
|
||
</body>
|
||
</html> |