-
Notifications
You must be signed in to change notification settings - Fork 228
Defining Difficulty
When assigning lesson difficulty, it is useful to consider: how much prerequisite knowledge is expected; whether and how specialist or technical terms are used and defined; the relative complexity of install and set-up; whether trouble-shooting steps are included, outlined, or referenced; where and how knowledge beyond the lesson's scope can be learned (through existing Programming Historian lessons, other written documentation), or whether applied experience is necessary.
- Prerequisite knowledge
- Handling of specialist/technical terms
- Complexity of install and set-up
- Support for troubleshooting
- Guidance for further learning (towards or beyond the lesson)
difficulty: 1
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 are 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
Whether beginner or advanced, all lessons must be usable, sustainable, accessible and inclusive:
Usability
- Summarise learning outcomes in an opening paragraph
- Structure logically, use section headings for clear and meaningful signposting
- Keep within the word limit: 8,000 words (including code)
Sustainability
- Cite software versions, specify technical dependencies
- Encourage general methodological narratives over screenshots and GUI-specific instructions
- Anticipate challenges, support trouble-shooting
Accessibility
- Caption images concisely, and ensure they are well-described with alt-text
- Provide cut-and-pasteable code, rather than showing it in screenshots
- Keep accessibility in mind when choosing data, case studies, and software
Inclusivity
- Utilise open formats, open programming languages and free software
- Consider implicit bias in algorithms and tools
- Identify multi-lingual external resources and software documentation wherever possible
- Be explicit if recommending learning content that is not available in the lesson's native language
- Copyediting
- Copyedit comments
- Typesetting
- Archival Hyperlinks
- Copyright
- DOI
- Gallery image
- Checklist comment
- Handover comment
- Closing comment
- Opening comment Phase 0
- Phase change comment 1 to 2
- Phase change comment 2 to 3
- Phase change comment 3 to 4
- Opening comment Phase 4
- Phase change comment 4 to 5
- Phase change comment 5 to 6
- Phase change comment 6 to 7
- Tracking lesson phase changes
- Organisational Structure
- Trustee Responsibilities
- Trustee and Staff Roles
- Services to Publications
- Funding
Training
- Onboarding-Process-for-New-Editors
- Leading-a-Shadowing-process
- Board-of-Director---Continuing-Development
The Ombudsperson Role
Technical Guidance
- Making Technical Contributions
- Creating Blog Posts
- Service Integrations
- Brand Guidelines
- French Translation Documentation
- Technical Tutorial on Translation Links
- Technical Tutorial on Setting Up a New Language
- Technical Tutorial on Search
- Twitter Bot
- Achieving-Accessibility-Alt-text-Colour-Contrast
- Achieving-Accessibility:-Training-Options
Editorial Guidance
- Achieving Sustainability: Copyediting, Typesetting, Archival Links, Copyright Agreements
- Achieving Sustainability: Lesson Maintenance Workflow
- Achieving Sustainability-Agreed-terminology-PH-em-português
- Training and Support for Editorial Work
- The-Programming-Historian-Digital-Object-Identifier-Policy-(April-2020)
- How to Request a New DOI
- Service-Agreement-Publisher-and-Publications
- ProgHist-services-to-Publications
- Technical Tutorial on Setting Up a New Language
- Editorial Recruitment
Social Guidance
Finances
- Project Costs
- Spending-Requests-and-Reimbursement
- Funding Opportunities
- Invoice Template
- Donations and Fundraising Policies
Human Resources
- Privileges-and-Responsibilities-of-Membership
- Admin-when-team-members-step-down
- Team-Leader-Selection-Process
- Managing-Editor-Handover
- Checklist-for-Sabbaticals
- New Publications Policy
- Parental-Leave-Policy
Project Management
Project Structure
Board of Trustees