-
Notifications
You must be signed in to change notification settings - Fork 115
Phase 2 Initial Edit
Anisa Hawes edited this page Mar 14, 2024
·
9 revisions
Contents of this page:
timeline
Title Phase 2 Initial Edit
Section Overview
Who's responsible? : Editor
Expected timeframe? : 30 days
timeline
Section Process
Read : Read for <br> Usability Sustainability Accessibility Inclusivity : Consider Difficulty
Feedback : Post your feedback as a comment in the Issue : Anchor your comments to particular sections or paragraph numbers (found at the right edge of the text in the lesson's live preview) : Define Revisions or Reject
timeline
Section Editorial Considerations
Usability : Usable lessons summarise learning outcomes in an opening paragraph : Are structured logically, with clear section headings and meaningful signposting : Are robust, with clear instructions and thoroughly-tested code : Keep within the word limit (8,000 words including code)
Sustainability : Sustainable lessons cite software versions, specify technical dependencies : Provide general methodological narratives rather than interface-specific instructions : Anticipate challenges, support trouble-shooting
Accessibility : Accessible lessons caption images concisely, describe visuals with detailed alt-text : Provide cut and pasteable code, rather than showing it in screenshots : Keep accessibility in mind when choosing data, case studies, and software : Comply with our difficulty matrix to specify prerequisite knowledge, define technical terms, rate the complexity of install and set-up, include, outline, or reference trouble-shooting steps, and state where and how knowledge beyond the lesson's scope can be learned.
Inclusivity : Inclusive lessons use open formats, open programming languages and open-source software : Consider implicit bias of algorithms and tools : Identify multilingual external resources and software documentation wherever possible : Are explicit if recommending learning content that is not available in the lesson's native language.
timeline
Section Difficulty matrix
difficulty 1 <br> Beginner : No prior knowledge required : All steps are clearly defined : Specialist or technical terms are defined : Software packages are easy to install (no “known issues”) : Challenges that readers might encounter are anticipated, and clear trouble-shooting steps included : Further Programming Historian lessons (or external resources) for advancing new skills may be referenced.
difficulty 2 Intermediate : Some prior knowledge is required : Existing Programming Historian lessons (or external resources) to empower less experienced readers to gain that knowledge are identified : Key steps are defined, all steps are outlined : Specialist or technical terms established by beginner lessons are used in context, while any new terms are defined : Software install and set-up may be subject to “known issues” : Challenges that readers might encounter are anticipated, and trouble-shooting steps are outlined
difficulty 3 Advanced : Significant prior knowledge and applied experience required : Confident ability to infer intermediate-level steps expected : Specialist or technical terms are used throughout, new concepts are explained : Software and packages may be known for their complexity to install and set-up : Challenges that readers might encounter are anticipated, and trouble-shooting steps are referenced.