Style & Naming Glossary

מטרות

  • קונסיסטנטיות בשמות, מונחים ועוגנים.

מיפוי מונחים

  • languageprogramming_languagelang

  • updated_at / created_at (UTC, timezone-aware)

  • user_id (מזהה משתמש פנימי) / username (תצוגה)

  • file_id (ObjectId) / file_name (שם ידידותי)

  • tags (מערך מחרוזות) / is_favorite (Boolean)

כללים

  • שמות קבועים ויציבים ב‑API ובמסד נתונים.

  • הימנעו מקיצורים לא שגרתיים; העדיפו שמות מלאים וברורים.

  • שמרו על עקביות בין לקוח, שרת ותיעוד.

עוגני תיעוד

  • השתמשו בעוגנים יציבים לשינויים עתידיים: .. _files-list:, .. _cursor-pagination: וכו«.

  • אל תשברו עוגנים קיימים; אם חייבים – הוסיפו redirect/alias.