MODULE_README_STYLE.md

Module README Style (All Languages)

Use this structure for every concept module under:

• languages/cpp/01-foundations, 02-core, 03-advanced, 04-expert
• languages/csharp/01-foundations and newer implemented levels
• languages/go/01-foundations and newer implemented levels
• languages/python/01-foundations and newer implemented levels

This structure is required for all implemented concept modules.

Required Sections

1. ## Quick Run
2. ## Topics Covered
3. ## Common Pitfalls
4. ## Exercise Focus
5. ### Exercise Specs
6. ## Checkpoint

Section Rules

• Learning Metadata (required): include Difficulty, Estimated Time, Prerequisites, and Cross-Language Lens before Quick Run.
• Quick Run: include one runnable command for example/main.* (or equivalent entry project).
• Topics Covered: concise bullets of concepts practiced in the module.
• Common Pitfalls: practical mistakes beginners frequently make.
• Cross-Language Notes (recommended): place after Common Pitfalls and before Exercise Focus; keep it to 3-5 concrete bullets.
• Exercise Focus: one bullet per exercise with a clear task summary.
• Exercise Specs: for each exercise define input, output, and at least two edge cases.
• Checkpoint: 3-5 measurable outcomes as checkboxes.

Writing Guidelines

• Keep explanations practical and short.
• Align language with beginner readability.
• Keep content in English.
• Use folder names exactly as they appear in paths.
• Hand-written files under example/ should use medium-density, intent-first comments: one short header comment plus comments before meaningful logic or validation blocks.
• Comments should explain concepts, tradeoffs, or observable behavior, not narrate syntax line by line.