aboutsummaryrefslogtreecommitdiff
path: root/docs/he-il/documentation_best_practices.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/he-il/documentation_best_practices.md')
-rw-r--r--docs/he-il/documentation_best_practices.md67
1 files changed, 67 insertions, 0 deletions
diff --git a/docs/he-il/documentation_best_practices.md b/docs/he-il/documentation_best_practices.md
new file mode 100644
index 000000000..90c4a137a
--- /dev/null
+++ b/docs/he-il/documentation_best_practices.md
@@ -0,0 +1,67 @@
1<div dir="rtl" markdown="1">
2# איך לתעד נכון
3
4עמוד זה קיים כדי לתעד את השיטות הטובות ביותר כאשר כותבים תיעוד עבור QMK. מעקב אחר הוראות אלה יעזור לשמור על סגנון וטון עקביים, אשר בתורם יעזרו לאנשים אחרים להבין טוב יותר את QMK.
5
6# פתיחת עמוד
7
8התיעוד שלך צריך בד״כ להפתח עם כותרת בגודל H1, אחריה פסקה אחת של תיאור של מה המשתמש ימצא בעמוד זה.
9זכור כי כותרת זו והפסקה ימוקמו ליד תוכן העניינים, אז חשוב לשמור על כותרת קצרה ולהמנע ממשפטים ארוכים ללא פיסוק.
10
11לדוגמה:
12
13```
14# הכותרת שלי
15
16עמוד זה מדבר על היכולת הסופר-מגניבה שלי. אתה יכול להשתמש ביכולת זו כדי להכין קפה, לסחוט תפוזים ולקבל משלוח של ביצים ועוגות מהסופר הקרוב באמצעות רחפן.
17```
18
19# כותרות
20
21עמוד התיעוד צריך לאופן כללי לכלול מס׳ כותרות בגודל "H1". רק כותרות מגודל H1 ו- H2 יכללו בתוכן העניינים, אז חשוב לתכנן אותם בהתאם. הכותרות לא להיות רחבות מידי כדי למנוע מתוכן העניינים להפוך להיות רחב מידי
22
23# בלוקי רמיזה מעוצבים
24
25ניתן להוסיף בלוקי רמיזה מעוצבים שמצויירים מסביב לטקסט כדי למשוך תשומת לב אליו.
26
27### חשוב
28
29```
30!> זה חשוב
31```
32
33יתרנדר כ:
34
35!> זה חשוב
36
37### טיפים כלליים
38
39```
40?> זהו טיפ שימושי.
41```
42
43יתרנדר כ:
44
45?> זהו טיפ שימושי.
46
47
48# תיעוד יכולות ופיצ׳ריםDocumenting Features
49
50אם יוצרים יכולת חדשה ב QMK, צרו עמוד תיעוד עבורה. העמוד לא צריך להיות ארוך במיוחד, מספר משפטים המתארים את היכולת (פיצ׳ר) וטבלה המתארת קודי מקשים רלוונטיים זה מספיק. הנה דוגמה בסיסית:
51
52```markdown
53# הפיצ׳ר המגניב שלי
54
55עמוד זה מדבר על היכולת הסופר-מגניבה שלי. אתה יכול להשתמש ביכולת זו כדי להכין קפה, לסחוט תפוזים ולקבל משלוח של ביצים ועוגות מהסופר הקרוב באמצעות רחפן.
56
57## קודי המקשים המגניבים של היכולת שלי
58
59|Long Name|Short Name|Description|
60|---------|----------|-----------|
61|KC_COFFEE||Make Coffee|
62|KC_CREAM||Order Cream|
63|KC_SUGAR||Order Sugar|
64```
65
66מקמו את התיעוד שלכם בתוך `docs/feature_<my_cool_feature>.md`, והוסיפו קישור לקובץ זה במקום המתאים ב `docs/_sidebar.md`. אם הוספתם קודי מקשים נוספים, תקפידו להוסיף אותם ל- `docs/keycodes.md` עם לינק לעמוד היכולת שלכם.
67</div> \ No newline at end of file