דלג לתוכן
AI and agents

איך לעדכן תיעוד עם Claude Code אחרי כל גרסה

עדכון תיעוד עם Claude Code: אחרי כל גרסה הוא קורא מה השתנה, מנסח את רשומת ה-changelog ב-Clevera, מסמן מאמרי עזרה לתיקון, ואתם מפרסמים.

Roozbeh Firoozmand7 דקות קריאה

הקוד משתחרר ביום שלישי. ה-changelog נכתב ביום שישי, אם מישהו זוכר, ומאמר העזרה עבור המסך שהשתנה נשאר שגוי במשך חודש. במקום זאת, אפשר לעדכן תיעוד עם Claude Code: הוא כבר נמצא ב-repo, אז הוא יודע מה השתחרר.

המדריך הזה מחבר את Claude Code לאתר תיעוד של Clevera דרך שרת ה-MCP של Clevera. אחרי כל גרסה, Claude Code קורא את ה-git log, מנסח את רשומת ה-changelog, מוצא את מאמרי העזרה שהגרסה נגעה בהם ומציע עריכות. אדם עובר על הכל ומפרסם. שום דבר לא מגיע לקוראים ללא אישור.

מה צריך קודם

אתר תיעוד של Clevera. אתרי תיעוד הם מרכז העזרה המאוחסן של Clevera, עם changelog ו-RSS feed מובנים. כל תוכנית כוללת אחד כזה.

Pro ומעלה. סוכני AI ו-API זמינים בתוכנית Pro ומעלה. Pro עולה $86.80 לחודש בחיוב שנתי ($124 לחודש) עבור 2 יוצרים, עם 4,000 קרדיטים משותפים בחודש. קריאות API עצמן לא עולות בקרדיטים. ראו תמחור.

Claude Code ב-repo שממנו אתם משחררים גרסאות. הוא צריך להריץ את git log, ואת gh אם אתם רוצים שהוא יקרא כותרות של pull requests.

שלב 1: יצירת אסימון (Token) מסוג Writer

אשף יצירת אסימון API חדש ב-Clevera בשלב ה-Purpose, עם הגדרת Writer שנבחרה עבור אסימון בשם Docs writer (Claude Code)

1. ב-Clevera, פתחו את תפריט ה-workspace ובחרו ב-AI agents & API, לאחר מכן ב-Tokens וב-New token. 2. תנו לו שם ("Docs writer (Claude Code)") ובחרו בהגדרת ה-Writer: "Agents draft; a person reviews and publishes." הוא מחזיק ב-4 הרשאות: קריאת תוכן, כתיבת טיוטות מאמרים, כתיבת טיוטות changelog והעלאת תמונות. 3. ב-Limits, בחרו את אתר התיעוד תחת Doc sites ותאריך תפוגה. אסימונים תמיד פגים, אחרי 7 ימים, 30 יום, 90 יום או שנה. 4. ב-Review, לחצו על Create token והעתיקו אותו. Clevera מציגה אותו פעם אחת. שימו אותו במשתנה סביבה בשם CLEVERA_TOKEN, לעולם לא ב-repo.

למה Writer ולא Publisher? אסימון Writer לא יכול לשנות את מה שהקוראים רואים. הוא לא יכול לפרסם, והוא לא יכול לערוך מאמר שכבר באוויר. המגבלה השנייה הזו מעצבת את כל תהליך העבודה, לכן היא מכוסה בשלב 3.

שלב 2: חיבור Claude Code

תיבת הדו-שיח של יצירת אסימון ב-Clevera עם פקודת הגדרה מוכנה ל-Claude Code (אסימון לדוגמה)

הריצו את זה בטרמינל שלכם:

claude mcp add --transport http clevera https://app.clevera.ai/mcp --header "Authorization: Bearer $CLEVERA_TOKEN"

זה מוסיף את השרת עבורכם, בפרויקט הנוכחי. אם כל הצוות צריך לקבל אותו, הוסיפו אותו ל-.mcp.json בשורש ה-repo במקום. Claude Code מרחיב את ${VAR} בקובץ הזה, כך שהאסימון עצמו נשאר מחוץ ל-git:

{ "mcpServers": { "clevera": { "type": "http", "url": "https://app.clevera.ai/mcp", "headers": { "Authorization": "Bearer ${CLEVERA_TOKEN}" } } } }

כל חבר צוות מגדיר לאחר מכן את CLEVERA_TOKEN לאסימון האישי שלו. Claude Code שואל לפני שהוא משתמש בשרת פרויקט בפעם הראשונה. הקלידו /mcp או הריצו את claude mcp list כדי לבדוק שהוא מחובר. פרטים נמצאים ב-תיעוד ה-MCP של Claude Code, ומדריך האסימונים המלא נמצא במדריך שלנו ל-יצירת סרטון עם Claude מעל MCP.

שלב 3: בקשת תיעוד הגרסה

תייגו את הגרסה, ואז תנו ל-Claude Code הנחיה אחת. הנה דוגמה שתוכלו להתאים:

> "תייגנו את v2.4. קרא את ה-commits וכותרות ה-PR מאז v2.3. באתר התיעוד שלנו ב-Clevera, בדוק את ה-changelog כדי שלא תחזור על רשומה, ואז נסח רשומה אחת עבור v2.4 עם New, Improved ו-Fixed. לאחר מכן חפש באתר מאמרים על כל מה שהשתנה. עדכן את הטיוטות ישירות. עבור מאמרים חיים, שלח כל אחד לסקירה עם השינויים המדויקים. אל תפרסם שום דבר."

הנה מה שהוא עושה עם הכלים של Clevera:

1. קורא מה השתחרר. git log v2.3..v2.4 ועם gh, את ה-pull requests שמוזגו. החלק הזה הוא Claude Code רגיל. 2. מוצא את האתר. list_sites מחזיר את מזהה האתר ואם פרסום אוטומטי פעיל. 3. בודק את ה-changelog. list_changelog מציג רשומות אחרונות, כך שהוא לא מכריז על אותו שינוי פעמיים. 4. מנסח את הרשומה. create_changelog_entry שומר אותה כטיוטה עם כותרת, קטגוריה וגוף Markdown שמקשר למאמרים. 5. מוצא את המאמרים המושפעים. search_content ו-get_site_tree מוצאים דפים שמזכירים את התכונה שהשתנתה. get_page קורא כל אחד מהם. 6. כותב את העריכות. עבור מאמר שעדיין לא חי, update_article כותב את הטקסט החדש. הוא צריך את מזהה הגרסה שהוא קרא, כך שהוא לא יכול לדרוס עריכה של חבר צוות שנעשתה בינתיים. עבור תכונה חדשה ללא מאמר, create_article יוצר טיוטה במקטע הנכון. 7. מבקש סקירה. עבור מאמר חי, העריכה מסורבת ללא הרשאות פרסום. לכן הסוכן קורא ל-submit_for_review עם הערה שאומרת מה צריך להשתנות ולמה. מנהלי האתר מקבלים הודעה לתיבת הדואר הנכנס עם קישור.

דוגמה לאיך רשומת הטיוטה עשויה להיראות (להמחשה, לא הרצה אמיתית):

> חיפוש חשבוניות מהיר יותר ואפליקציית Slack חדשה · Improved, New > חיפוש מוצא כעת חשבוניות לפי לקוח, סכום או מספר תוך כדי הקלדה. חברו את אפליקציית ה-Slack החדשה כדי לפרסם חשבוניות ששולמו לערוץ. Fixed: ייצוא PDF שומר על הלוגו שלכם בכל עמוד. קישורים לשני המאמרים המעודכנים מצורפים.

כל שינוי מופיע בהיסטוריית הדף עם שם הסוכן והאסימון שבו השתמש.

שלב 4: סקירה ופרסום

רשומת changelog באתר תיעוד של Clevera עם גרסה, תאריך שחרור וקטגוריות New, Improved ו-Fixed בלוח ה-Details (נתונים לדוגמה)

פתחו את אתר התיעוד ב-Clevera. רשומת ה-changelog נמצאת תחת Drafts. תקנו את הניסוח, הגדירו את ה-Version, ואז לחצו על Publish entry. פתחו את המאמרים מהודעות הסקירה, החילו או כווננו את השינויים, ופרסמו את האתר. הרשומה עולה לאוויר עם הפרסום הזה.

שתי הגדרות חשובות כאן:

  • Auto-publish. כשהוא פעיל, שינוי לדף חי יוצא כמה דקות אחרי שהעריכה נפסקת. כבו אותו אם אתם רוצים פרסום מכוון אחד לכל גרסה.
  • Languages. באתר עם יותר משפה אחת, פרסום רשומה מתרגם אותה לכל שפה. זה משתמש בקרדיטים.

אם אתם סומכים על הסוכן עם עריכות חיות, אסימון Publisher יכול לערוך מאמרים חיים ולפרסם. רק בעלים, מנהלים ועורכים יכולים להעניק הרשאות פרסום. הכלים עדיין אומרים לסוכנים לפרסם רק כשאתם מבקשים זאת במפורש. רוב הצוותים צריכים להתחיל עם Writer ולהחליט אחרי כמה גרסאות.

אופציונלי: סרטון הדרכה חדש עבור התהליך שהשתנה

מסך שהשתנה בדרך כלל אומר שסרטון ישן הוא גם שגוי, ויש שגרה שלמה ל-עדכון סרטוני הדרכה אחרי שינוי UI. Claude Code יכול ליצור את סרטון ההדרכה החדש מהקלטה שכבר נמצאת בספריית ה-Clevera שלכם. הוא לא יכול להקליט את המסך שלכם, אז הקליטו את התהליך החדש קודם.

זה דורש אסימון שעשוי להוציא קרדיטים, כמו הגדרת ה-Producer, שכוללת גם את כל מה שיש ל-Writer. בקשו הצעת מחיר קודם. סרטון הדרכה מהקלטה של עד 5 דקות עולה בדרך כלל 5 עד 25 קרדיטים. השאירו את Approve automatically below על 0, ברירת המחדל, ובעלים או מנהל יאשרו כל התחלה בתשלום ב-Agent requests. הסרטון יכול אז להיכנס למאמר כבלוק וידאו.

מתי אתם לא צריכים את זה

אם התיעוד שלכם חי כ-Markdown באותו repo כמו הקוד שלכם, Claude Code יכול לערוך את הקבצים האלה ישירות ואתם תסקרו את ה-pull request כמו כל שינוי אחר. אתם לא צריכים שרת MCP בשביל זה. תהליך העבודה הזה מיועד לצוותים שמרכז העזרה וה-changelog שלהם חיים בכלי מאוחסן שגם אנשי תמיכה ומוצר עורכים. משווים אפשרויות מאוחסנות? ראו את הסיכום שלנו ל-שרתי MCP לתיעוד ו-מחוללי ה-changelog מבוססי AI הטובים ביותר.

שאלות נפוצות

האם Claude Code יכול לפרסם את ה-changelog שלי בלעדיי? לא עם אסימון Writer. הוא יכול רק לנסח טיוטה. אסימון Publisher יכול לפרסם, והכלים של Clevera אומרים לסוכן לפרסם רק כשביקשתם ממנו.

מה קורה אם חבר צוות עורך את המאמר באותו זמן? העדכון של הסוכן נכשל עם קונפליקט גרסאות, והכלי אומר לו לקרוא מחדש את המאמר ולהחיל את השינוי שלו על הגרסה החדשה. העריכה של חבר הצוות שלכם לא נדרסת.

האם זה עולה קרדיטים? קריאה, ניסוח, עדכון ובקשות לסקירה אינם עולים קרדיטים. תרגום ערכים או מאמרים ויצירת סרטונים – כן.

איזו תוכנית אני צריך כדי לעדכן תיעוד עם Claude Code? תוכנית Pro ומעלה עבור סוכני AI ו-API. אתר התיעוד ויומן השינויים שלו זמינים בכל תוכנית.

האם זה עובד עם סוכנים אחרים? כן. Codex, Cursor וסקריפטים מתחברים עם אותו סוג אסימון, ו-Claude ו-ChatGPT מתחברים באמצעות התחברות. ראו את כל האינטגרציות של Clevera.

הפכו את זה לחלק מהגרסה

שמרו את ה-prompt במאגר, לצד סקריפט הגרסה, והריצו אותו בכל פעם שאתם מתייגים. ההרצה הראשונה דורשת כמה דקות של הגדרה. לאחר מכן, טיוטת יומן השינויים ורשימת המאמרים המיושנים יחכו לכם עוד לפני שמישהו יספיק לשאול. ראו מה עוד סוכנים יכולים לעשות עם שרת ה-MCP של Clevera →