mirror of
https://github.com/harvard-edge/cs249r_book.git
synced 2026-05-03 00:07:08 -05:00
3625af9cc4
We put all the QMD files under their own directory structure. The directory contains the QMD file and also an images directory, so each chapter is now self-contained As part of this reorg, I updated the links to images etc. to make sure they are all pointing to the right location
69 lines
2.8 KiB
Plaintext
69 lines
2.8 KiB
Plaintext
# Conventions Used in this Book
|
|
|
|
Please follow these conventions as you contribute to this online book:
|
|
|
|
1. **Clear Structure and Organization**:
|
|
|
|
- **Chapter Outlines**: Begin each chapter with an outline that provides an
|
|
overview of the topics covered.
|
|
- **Sequential Numbering**: Utilize sequential numbering for chapters,
|
|
sections, and subsections to facilitate easy reference.
|
|
|
|
2. **Accessible Language**:
|
|
|
|
- **Glossary**: Include a glossary that defines technical terms and jargon.
|
|
- **Consistent Terminology**: Maintain consistent use of terminology
|
|
throughout the book to avoid confusion.
|
|
|
|
3. **Learning Aids**:
|
|
|
|
- **Diagrams and Figures**: Employ diagrams, figures, and tables to visually
|
|
convey complex concepts.
|
|
- **Sidebars**: Use sidebars for additional information, anecdotes, or to
|
|
provide real-world context to the theoretical content.
|
|
|
|
4. **Interactive Elements**:
|
|
|
|
- **Exercises and Projects**: Integrate exercises and projects at the end of
|
|
each chapter to encourage active learning and practical application of
|
|
concepts.
|
|
- **Case Studies**: Incorporate case studies to provide a deeper
|
|
understanding of how principles are applied in real-world situations.
|
|
|
|
5. **References and Further Reading**:
|
|
|
|
- **Bibliography**: Include a bibliography at the end of each chapter for
|
|
readers who wish to delve deeper into specific topics.
|
|
- **Citations**: Maintain a consistent style for citations, adhering to
|
|
recognized academic standards like APA, MLA, or Chicago.
|
|
|
|
6. **Supporting Materials**:
|
|
|
|
- **Supplementary Online Resources**: Provide links to supplementary online
|
|
resources, such as video lectures, webinars, or interactive modules.
|
|
- **Datasets and Code Repositories**: Share datasets and code repositories
|
|
for hands-on practice, particularly for sections dealing with algorithms
|
|
and applications.
|
|
|
|
7. **Feedback and Community Engagement**:
|
|
|
|
- **Forums and Discussion Groups**: Establish forums or discussion groups
|
|
where readers can interact, ask questions, and share knowledge.
|
|
- **Open Review Process**: Implement an open review process, inviting
|
|
feedback from the community to continuously improve the content.
|
|
|
|
8. **Inclusivity and Accessibility**:
|
|
|
|
- **Inclusive Language**: Utilize inclusive language that respects diversity
|
|
and promotes equality.
|
|
- **Accessible Formats**: Ensure the textbook is available in accessible
|
|
formats, including audio and Braille, to cater to readers with
|
|
disabilities.
|
|
|
|
9. **Index**:
|
|
- **Comprehensive Index**: Include a comprehensive index at the end of the
|
|
book to help readers quickly locate specific information.
|
|
|
|
Implementing these conventions can contribute to creating a textbook that is
|
|
comprehensive, accessible, and conducive to effective learning.
|