פרומפט לכתיבת תיעוד טכני
תיעוד טכני טוב הוא ההבדל בין פרויקט שאנשים מצליחים להשתמש בו לבין פרויקט שכולם נוטשים אחרי חמש דקות. הפרומפט הזה לוקח קוד, פונקציה או תיאור של מערכת והופך אותם לתיעוד מקצועי ומובנה — README שלם, מדריך התקנה צעד-אחר-צעד, או תיעוד API/פונקציה — בעברית ברורה לראש ישראלי, עם מונחים טכניים באנגלית כמקובל בתעשייה. התיעוד תמיד כולל דוגמאות שימוש קונקרטיות (code snippets), מותאם לרמת קהל היעד (מפתחים, מנהלי מוצר, או משתמשים לא-טכניים), ובנוי בסקשנים שאפשר להעתיק ישר ל-GitHub, ל-Notion או ל-Wiki הפנימי. מתאים ליזמים, בעלי עסקים קטנים ויועצים שצריכים לתעד מוצר, כלי פנימי או תהליך — בלי לשכור Technical Writer.
📋 הפרומפט
אתה Technical Writer מנוסה שכותב תיעוד טכני ברור, מדויק ומעשי בעברית (עם מונחים טכניים באנגלית כמקובל בתעשייה). המשימה: לכתוב תיעוד טכני עבור הדבר הבא. מה לתעד: [מה_לתעד] סוג התיעוד הרצוי: [סוג_התיעוד] קהל היעד: [קהל_היעד] רמת היכרות מוקדמת של הקורא: [רמת_הקורא] הקוד או התיאור לתעד: ``` [הקוד_או_התיאור] ``` הקשר נוסף (סטאק טכנולוגי, תלויות, מגבלות): [הקשר_נוסף] כללי כתיבה: - כתוב בעברית ברורה ותכליתית. השאר מונחים טכניים באנגלית (function, endpoint, install, parameter) — אל תתרגם אותם בכוח. - בנה את התיעוד בסקשנים עם כותרות. שמור על מבנה הגיוני שהקורא יכול לסרוק בעיניים. - כל טענה טכנית חייבת להיות מדויקת. אם משהו לא ברור מהקוד/התיאור — סמן זאת במקום להמציא. - כלול תמיד דוגמת שימוש קונקרטית אחת לפחות (code snippet) שאפשר להעתיק ולהריץ. - התאם את העומק והשפה לקהל היעד: למפתחים — טכני ומדויק; ללא-טכניים — צעד-אחר-צעד בלי ז'רגון מיותר. מבנה מומלץ לתיעוד (התאם לפי סוג התיעוד): 1. כותרת ומשפט פתיחה — מה זה ולמה זה קיים, בשורה אחת 2. דרישות מקדימות (Prerequisites) — מה צריך כדי להתחיל 3. התקנה / הגדרה (Installation / Setup) — צעדים ממוספרים 4. שימוש בסיסי (Usage) — דוגמה מינימלית שעובדת 5. תיעוד מפורט — פרמטרים, ערכי החזרה, אופציות (בטבלה כשמתאים) 6. דוגמאות נוספות / מקרי קצה 7. שגיאות נפוצות ופתרונן (Troubleshooting) בסוף, ציין בקצרה אילו הנחות הנחת ואיזה מידע היה חסר כדי שאשלים אותו אם צריך.
🔤 המשתנים שצריך להחליף
| משתנה | מה למלא | דוגמה |
|---|---|---|
| [מה_לתעד] | השם והטיב של מה שאתה מתעד — פרויקט, פונקציה, API, כלי או תהליך * | ספריית JavaScript בשם price-utils לחישובי מחירים |
| [סוג_התיעוד] | איזה סוג מסמך אתה צריך * | README לפרויקט ב-GitHub |
| [קהל_היעד] | מי יקרא את התיעוד — זה קובע את העומק והשפה * | מפתחים שמתממשקים לראשונה לספרייה |
| [רמת_הקורא] | כמה הקורא כבר מכיר את התחום או הסטאק | מכיר JavaScript בסיסי אבל לא את הספרייה |
| [הקוד_או_התיאור] | הדבק את הקוד, חתימת הפונקציה או תיאור המערכת שצריך לתעד * | export function applyDiscount(price, pct) { return Math.round((price - price * pct) * 100) / 100; } |
| [הקשר_נוסף] | סטאק טכנולוגי, תלויות, מגבלות או כל מידע שיעזור לדייק את התיעוד | Node 18+, אין תלויות חיצוניות, מיועד לדפדפן ולשרת כאחד |
📝 איך להשתמש
מלא קודם את ארבעת המשתנים החשובים: מה לתעד, סוג התיעוד (README / מדריך התקנה / תיעוד API), קהל היעד, והדבק את הקוד או התיאור. ככל שתוסיף הקשר על הסטאק והתלויות — התיעוד יהיה מדויק יותר ופחות 'ינחש'. אם אתה מתעד API, הדבק את חתימות ה-endpoints או הפונקציות; אם אתה מתעד פרויקט שלם, תיאור קצר של מה הוא עושה + מבנה התיקיות מספיק. אחרי שתקבל את התיעוד, אפשר לבקש מ-Claude להוסיף badges, תוכן עניינים (Table of Contents) או לתרגם לאנגלית בלחיצה אחת.
💡 דוגמה לפלט
# price-utils
ספריית JavaScript קטנה וחסרת תלויות לחישובי מחירים — הנחות, מע"מ ועיגול — שעובדת גם בדפדפן וגם ב-Node.
## דרישות מקדימות (Prerequisites)
- Node.js גרסה 18 ומעלה (לשימוש בצד שרת), או כל דפדפן מודרני.
- אין תלויות חיצוניות.
## התקנה (Installation)
```bash
npm install price-utils
```
## שימוש בסיסי (Usage)
```js
import { applyDiscount } from "price-utils";
const finalPrice = applyDiscount(100, 0.2);
console.log(finalPrice); // 80
```
## תיעוד הפונקציה
### `applyDiscount(price, pct)`
מחשבת מחיר אחרי הנחה ומעגלת לשתי ספרות אחרי הנקודה.
| פרמטר | סוג | חובה | תיאור |
|---------|----------|------|------------------------------------------------|
| `price` | `number` | כן | המחיר המקורי (לפני הנחה), בערך חיובי. |
| `pct` | `number` | כן | אחוז ההנחה כשבר עשרוני: `0.2` עבור 20% הנחה. |
**ערך מוחזר:** `number` — המחיר אחרי ההנחה, מעוגל לשתי ספרות.
## דוגמאות נוספות
```js
applyDiscount(99.9, 0.1); // 89.91
applyDiscount(250, 0); // 250 (ללא הנחה)
applyDiscount(59.99, 0.333); // 40.01
```
## שגיאות נפוצות (Troubleshooting)
- **קיבלתי מחיר שלילי:** ודא ש-`pct` הוא שבר בין 0 ל-1 ולא אחוז שלם. `applyDiscount(100, 20)` יחזיר `-1900` כי 20 מתפרש כ-2000% הנחה.
- **התוצאה לא מעוגלת כצפוי:** הפונקציה מעגלת לשתי ספרות בלבד. לעיגול אחר, עטוף את הקריאה בלוגיקת עיגול משלך.
---
הנחות שהנחתי: שהפרמטר `pct` מיועד להיות שבר עשרוני (לפי לוגיקת החישוב), ושהמטרה היא חישוב מחיר קמעונאי. מידע חסר: לא צוין האם הספרייה מתמודדת עם מטבעות שונים או עם מע"מ — אם כן, כדאי לתעד גם פונקציות אלה.🔧 וריאציות
תיעוד API / endpoint
מייצר תיעוד מסודר ל-API: endpoints, פרמטרים, גוף בקשה ותגובה ודוגמת curl.
אתה Technical Writer שמתמחה בתיעוד API. כתוב תיעוד ברור ל-API הבא בעברית, עם מונחים טכניים באנגלית. שם ה-API / ה-endpoint: [שם_ה-API] קהל היעד: [קהל_היעד] הגדרת ה-endpoint (route, method, פרמטרים, גוף בקשה ותגובה): ``` [הקוד_או_התיאור] ``` אימות נדרש (אם יש): [שיטת_אימות] עבור כל endpoint, כלול: 1. שורת כותרת: METHOD + הנתיב (למשל `POST /api/orders`) ומשפט שמסביר מה הוא עושה 2. אימות נדרש (headers / token) 3. פרמטרים — Path, Query, ו-Body — בטבלה: שם, סוג, חובה/רשות, תיאור 4. דוגמת בקשה מלאה (curl וגם JSON של הגוף) 5. דוגמת תגובה מוצלחת (עם status code) ודוגמת תגובת שגיאה נפוצה 6. טבלת קודי שגיאה אפשריים ומשמעותם שמור על דיוק. אם פרט חסר בהגדרה — סמן אותו במקום להמציא ערכים.
מדריך משתמש לקהל לא-טכני
הופך מערכת או כלי למדריך שימוש פשוט בצעדים, בלי ז'רגון, למשתמשי קצה.
אתה כותב מדריכי משתמש שמסביר מערכות מורכבות בשפה פשוטה לאנשים לא-טכניים.
הכלי / המערכת: [מה_לתעד]
מי המשתמש: [קהל_היעד]
מה המשתמש מנסה להשיג: [המטרה_של_המשתמש]
תיאור הכלי / התהליך:
```
[הקוד_או_התיאור]
```
כתוב מדריך משתמש בעברית פשוטה לפי הכללים הבאים:
- בלי ז'רגון טכני. אם חייבים מונח טכני — הסבר אותו במילים פשוטות בסוגריים בפעם הראשונה.
- חלק את המדריך לפי משימות שהמשתמש רוצה לבצע ("איך ל...") ולא לפי מבנה המערכת.
- כל משימה: צעדים ממוספרים, קצרים וברורים, מה לוחצים ומה אמורים לראות אחרי כל צעד.
- הוסף סקשן "שאלות נפוצות" עם 3-4 שאלות שמשתמש מתחיל באמת ישאל.
- הוסף טיפ אחד "מה לעשות אם משהו לא עובד".
הטון: ידידותי, מעודד, מניח שהקורא לא טכני בכלל אבל חכם.💎 טיפים מתקדמים
- 1.ציין במפורש את קהל היעד — 'מפתח שמכיר את הסטאק' מול 'מנהל מוצר לא-טכני' מייצרים שני מסמכים שונים לחלוטין.
- 2.הדבק את הקוד האמיתי ולא רק תיאור — Claude יוציא ממנו פרמטרים, ערכי החזרה ומקרי קצה מדויקים יותר.
- 3.בקש במפורש פורמט: "תן לי את זה כ-Markdown מוכן להדבקה ב-GitHub" או "בלי Markdown, טקסט נקי ל-Notion".
- 4.אחרי הטיוטה הראשונה, בקש מ-Claude להוסיף תוכן עניינים (Table of Contents) או סקשן Troubleshooting אם הוא חסר.
- 5.שים לב להנחות ש-Claude מציין בסוף — הן מצביעות בדיוק על המקומות שבהם התיעוד שלך עלול להיות לא מדויק.
אהבת את הפרומפט הזה?
בלעבוד חכם יותר עם Claude תלמד לבנות פרומפטים כאלה בעצמך — מותאמים בדיוק לעבודה ולעסק שלך.
לפרטים על לעבוד חכם יותר עם Claude ←📚 פרומפטים קשורים
פרומפט להסבר קוד והוספת הערות
לוקח קטע קוד ומסביר אותו בעברית פשוטה שורה-שורה, מזהה באגים ובעיות ומציע הערות ושיפורים.
פרומפט לכתיבת נוהל עבודה (SOP)
הופך תהליך עבודה שקיים רק בראש שלך לנוהל מסודר (SOP): מטרה, אחראים, שלבים ברורים לפי סדר, כלים נדרשים ונקודות בקרה — כדי שאפשר יהיה להאציל ולשמר ידע בעסק.
פרומפט לאיתור ותיקון שגיאה בקוד
מדביקים קוד והודעת שגיאה ומקבלים אבחון של הבעיה, הסבר למה היא קורית והתיקון המוצע — בעברית פשוטה. מתאים גם למתחילים.
פרומפט לבניית ביטוי רגולרי (Regex)
מתארים בעברית מה רוצים להתאים או לחלץ, ומקבלים ביטוי רגולרי (Regex) מוכן עם הסבר חלק-חלק ודוגמאות שמתאימות ושלא — בלי שעות של ניסוי וטעייה.
פרומפט לבניית נוסחת אקסל ו-Google Sheets
מתארים בעברית מה רוצים לחשב בגיליון ומקבלים נוסחה מוכנה לאקסל או ל-Google Sheets, עם הסבר איך היא עובדת ואיפה בדיוק להדביק אותה.
פרומפט לבניית דאשבורד ב-Google Sheets
בניית דאשבורד ניהולי ב-Google Sheets — נוסחאות, מבנה גיליונות, גרפים וכפתורי פילטר — בלי להיות מומחה Sheets.