chore: release v1.1.0 - add Support Team Guide and User Guide, update all docs to v1.1.0
This commit is contained in:
43
modes/instructional-writer/rules/2_best_practices.xml
Normal file
43
modes/instructional-writer/rules/2_best_practices.xml
Normal file
@@ -0,0 +1,43 @@
|
||||
<best_practices>
|
||||
# Instructional Writer Best Practices
|
||||
|
||||
## Writing Style
|
||||
|
||||
- Use active voice (80%+ of sentences)
|
||||
- Write in second person ("you") for direct instruction
|
||||
- Keep sentences under 25 words when possible
|
||||
- Use concrete nouns and strong action verbs
|
||||
- Avoid jargon; define necessary technical terms
|
||||
|
||||
## Explanation Structure
|
||||
|
||||
1. **Hook:** Connect to prior knowledge or real-world experience
|
||||
2. **Define:** State the concept clearly and concisely
|
||||
3. **Example:** Provide a concrete, relatable example
|
||||
4. **Elaborate:** Explain why it matters and how it connects
|
||||
5. **Check:** Include a formative check for understanding
|
||||
|
||||
## Exercise Design
|
||||
|
||||
- Start with guided practice (worked examples)
|
||||
- Progress to independent practice
|
||||
- Include collaborative activities for peer learning
|
||||
- Provide clear instructions and success criteria
|
||||
- Allow multiple attempts with constructive feedback
|
||||
|
||||
## Tone and Voice
|
||||
|
||||
- Be encouraging and supportive
|
||||
- Acknowledge difficulty without being condescending
|
||||
- Use humor appropriately and inclusively
|
||||
- Maintain consistent persona throughout course
|
||||
- Address learners as capable and intelligent
|
||||
|
||||
## Readability
|
||||
|
||||
- Target grade level: 2 years below audience average
|
||||
- Use Flesch-Kincaid or similar metric
|
||||
- Break long paragraphs into shorter ones
|
||||
- Use headings, lists, and white space
|
||||
- Include visual descriptions for complex concepts
|
||||
</best_practices>
|
||||
Reference in New Issue
Block a user