שפר את המדריך הזה¶
המדריך נשמר כ-Markdown בספרייה docs/ ונבנה עם MkDocs.
תצוגה מקדימה מקומית¶
צור סביבה וירטואלית והתקן את תלויות התיעוד:
python3 -m venv .venv
. .venv/bin/activate
pip install --requirement requirements-docs.txt
mkdocs serve
פתח את הכתובת המקומית שהודפסה על ידי MkDocs. התצוגה המקדימה נבנית מחדש כאשר קובץ מקור משתנה.
אימות האתר¶
לפני פתיחת בקשת מיזוג:
הבנייה הקפדנית מדווחת על ערכי ניווט חסרים, קישורים לא חוקיים שזוהו על ידי MkDocs ואזהרות תצורה.
עקרונות כתיבה¶
- כתוב עבור משימה וקהל ספציפיים.
- ציין את גרסת MRBS כאשר ההתנהגות היא ספציפית לגרסה.
- העדיפו דוגמאות בדוקות על פני רשימות ממצות.
- לעולם אל תכלול אישורים אמיתיים או נתוני הזמנה פרטיים.
- קישור משימות קשורות במקום לשכפל חלקים גדולים.
- עדכן את כל התרגומים הזמינים כשמעשיים.
תרגומים¶
אנגלית היא טקסט הייחוס. דפים מתורגמים משתמשים באותו נתיב יחסי ובסיומת שפה:
כאשר חסר תרגום, האתר חוזר לאנגלית. תרגום צריך לשמר קוד, הגדרת שמות, אזהרות וקישורים תוך שימוש בטרמינולוגיה טבעית בשפת היעד.
היקף¶
עץ התיעוד הזה מכוון ל-MRBS 1.12.2. שינויים המתארים מהדורה מאוחרת יותר חייבים לעדכן את היקף הגרסה הגלויה או להיות מפותחים בערכת התיעוד של אותה מהדורה.