Documentation Standards

Learning Objectives

• Write documentation that students can follow quickly.
• Keep topic pages consistent across the repository.
• Improve clarity using examples and structured sections.

Required Section Pattern

1. Learning Objectives
2. Concept Explanation
3. Algorithm or Steps
4. Examples/Implementation
5. Common Mistakes
6. Practice Questions
7. Summary

Writing Rules

• Use short paragraphs and meaningful headings.
• Explain purpose and reasoning, not only syntax.
• Keep examples runnable and relevant.
• Use consistent terminology across related pages.

Quality Checklist

• Does the page explain "why" and "how"?
• Are inputs/outputs clearly shown?
• Are links to prerequisite and next topics present?
• Is the page free from broken references?

Summary

Consistency and clarity make revision faster for students.