תיעוד

הגדרה

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

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

רשמו כל החלטה וסיבתה תוך כדי תהליך העבודה. הערת מסירה נוצר מתוך הערות אלו.

פרויקטים

החליטו יחד עם הלקוח:

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

צרו כל פרויקט מתוך פרויקטים. לאחר מכן פתחו את הגדרות הפרויקט: מאגר נתונים עבור הענפים ומצב הפעולה, משתנים סביבתיים, ו ידע → הקשר עבור מה שסוכני ה-AI קוראים. בדקו את פקודות הבנייה והבדיקה שCoRoid זיהה. רשמו מה שסוכני ה-AI חייבים לדעת ב AGENTS.md, בתוך המאגר הנתונים.

ראו צרו את הפרויקט הראשון שלכם, הגדרות מאגר נתונים וענפים, תצורת בנייה ובדיקה ו כתבו AGENTS.md.

בקרת איכות

החליטו יחד עם הלקוח:

  • אילו תנאים כל שינוי חייב לעמוד בהם, ואילו כישלונות חוסמים או רק מספקים המלצה.
  • מהי רמת הבדיקה המקיפה של בקרת האיכות, ואיפה הבדיקות מתבצעות.
  • מה קורה לבקשות המשיכה שאנשים פותחים: בקרת איכות של CoRoid, וסקירה של CoRoid כהמלצה או כחסימה.
  • אילו מקורות רשאים להגיש בקשות, כגון Slack, Telegram או Jira.
  • מה קורה כשמשהו נכשל, כגון משימה או פריסה שנכשלו.

הגדירו זאת ב בקרת איכות. הגדירו את ברירת מחדל של הארגון לבדיקות שהפרויקטים רובם זקוקים להן. הקצו לכל פרויקט תצורה משלו רק כשיש הבדל. ראו מדיניות ואילוצי איכות ו בדיקות אנטי-שגיאות.

רק כשאדם מאשר את המיזוג, CoRoid משלב את ה-pull request. עבור קוד שזקוק לאישור של אדם מסוים, כגון קוד תשלומים, השתמשו בהגנה על ענף במארח ה-Git.

מנדטים

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

החליטו יחד עם הלקוח:

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

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

פרופילי AI

החליטו יחד עם הלקוח:

  • איזה פרופיל הארגון משתמש בו כברירת מחדל.
  • האם שיחות המודל חייבות להישאר באיחוד האירופי. אז השתמשו ב רק באיחוד האירופי.
  • האם לשלם עבור מודלים באמצעות זכויות המודל של CoRoid או באמצעות מפתחות הספק של הלקוח עצמו.
  • אילו ספקים ומודלים סוכני ה-AI אסור להם להשתמש בהם.

הגדירו פרופילים ב הגדרות → AI profile, ומפתחות ב הגדרות → מפתחות ספק. הגבילו ספקים ומודלים ב הגדרות → זיהוי וגישה → מדיניות ארגונית. ראו פרופילי AI, מפתחות ספק ו זכויות מודל.

אוטומציות

החליטו יחד עם הלקוח:

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

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

זרימות עבודה

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

החליטו יחד עם הלקוח:

  • איזה תהליך לכסות ראשון. בחרו תהליך עם מקרים דומים רבים וכללים ברורים.
  • אופן התחלת המקרה: אימייל, טופס באתר של הלקוח, אדם או זרימות עבודה אחרות.
  • השלבים, ומה שכל שלב ממתין לו: כלום, רק כסף, או כל שינוי והודעה.
  • נתיבי הפעולה לכל שלב: לשאול את הלקוח, לעבור לשלב אחר, לפעול לפי טבלת כללים, להעביר את המקרה לאדם או לסגור אותו.
  • טבלאות הכללים, כשורות של "כאשר זה קורה, אז זה".
  • כתובת שממנה מגיעות התשובות, החתימה ושורת הגילוי של AI.

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

סקורו כללים

החליטו יחד עם הלקוח מה על מבקר ה-CoRoid לחפש בקוד של הלקוח, מעבר לכללים של CoRoid עצמו.

כתבו את הכללים בכל מאגר: קובץ REVIEW.md בשורש, וקבצי כללים בתוך תיקייה review-rules .CoRoid קורא אותם מהענף הבסיסי, כך ש-pull request לא יוכל לשנות את הכללים שעל פיהם הוא נבדק. קבעו מה CoRoid Review יפרסם ב בקרת איכות, תחת בקשות משיכה. צפו בקשות משיכה.

מיומנויות

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

כתבו כל מיומנות במאגר, כ- skills/<name>/SKILL.md. הקובץ מתחיל בפרטי חזית שמכילים name ו- description. הסוכנים קוראים מיומנויות רק מהמאגר הממוזג. צפו מיומנויות מתקדמות ו כתבו AGENTS.md.

מה שניתן לשנות ללא קוד

הלקוחות והממשיכים אינם מקבלים את קוד המקור של CoRoid. כל מה שהלקוח יכול לשנות נמצא בטבלה זו: הגדרה בפורטל או קובץ במאגר של הלקוח עצמו. חלק מהדפים מופיעים רק כאשר CoRoid הפעיל את התכונה, כמו זרימות עבודה.

מההיכן
שם הארגוןהגדרות → כללי
חברים ותפקידיהםהגדרות → חברים
פרופילי AIהגדרות → AI profile
מפתחות ספקהגדרות → מפתחות ספק
חשבונות שירות לקליטת עבודה של APIהגדרות → חשבונות שירות
חיבור לאחסון Gitהגדרות → חיבורים → בקרת קוד מקור
בוטים של Slack ו-Telegramהגדרות → חיבורים → ערוצים
שרתי MCP חיצוניים, והכלים שהסוכנים יכולים לקרוא אליהםהגדרות → חיבורים → MCP חיצוני
אסימוני גישה, אישורים ומדיניות אוטומציה של שרת ה-MCP של CoRoidהגדרות → חיבורים → שרת MCP של CoRoid
SSO, דומיינים מאושרים וסינכרון תיקיותהגדרות → זיהוי וגישה → זיהוי תאגידי
מודלים, ספקים, פקודות וכלים מורשיםהגדרות → זיהוי וגישה → מדיניות ארגונית
מושבים רשומיםהגדרות → זיהוי וגישה → מושבים פעילים
יומן הביקורת והייצוא שלוהגדרות → זיהוי וגישה → יומן ביקורת
תכנון, מקומות סוכנים וזכויות שימוש במודלהגדרות → חיוב ושימוש
אחסון, שמירת נתונים וייצוא ההגדרותהגדרות → נתונים ומשפטי
שם הפרויקט, המאגר, הענפים והמצבהפרויקט של הגדרות → כללי ו מאגר
משתנים סביבתיים של הפרויקטהפרויקט של הגדרות → משתנים סביבתיים
מה שהסוכנים קוראים על פרויקטהפרויקט של הגדרות → ידע → הקשר
סקורו ראיות מכלי הלקוחהפרויקט של הגדרות → אינטגרציות
בדיקות, בקרת איכות, מקורות בקשה, בקשות משיכה ו-„כאשר משהו נכשל“בקרת איכות
כללי אנטי-סלופ וניקוי חובות שבועיבקרת איכות
מנדטיםבקרת איכות → ברירת מחדל ארגונית → אספקה
הגנות אבטחה, מודלי איום ושטח התקיפהאבטחה → פרויקטים
שפות, בדיקות תרגום ותורמיםגלובליזציה
סביבות שחרור, כללי אישור, נתיב פריסה וגרסאותגרסאות → הגדרות שחרור
אוטומציות אירועים ולוחות זמניםמפעל → אוטומציות, נוצר ב עבודה חדשה
דוחות מתוזמניםמפעל → דוחות
זרימות עבודה וטבלאות כלליםזרימות עבודה
הוראות סוכניםAGENTS.md וקבצי הזיכרון האחרים במאגר
סקורו כלליםREVIEW.md ו- review-rules תיקייה במאגר
מיומנויותskills/<name>/SKILL.md בתוך המאגר

ה- שרת MCP של CoRoid הסייען משנה חלק גדול מההגדרות הללו מתוך הכלים הפעילים.

צורך שאין לו מענה בשום מקום

כאשר אף שורה בטבלה אינה תואמת כלל את הכלל, אל תנסו לעקוף את המוצר. שלחו את הצורך ל־CoRoid כבקשה דרך ה־ דף יצירת קשר. נא לכתוב:

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

שינוי ש־CoRoid מבצע מגיע לכל הלקוחות בגרסה.

הושלם כאשר

  • לכל כלל במסמך הגילוי יש הגדרה או בקשה ל־CoRoid.
  • לכל החלטה יש סיבה הרשומה בהערות שלכם.
  • משימה אחת בכל פרויקט מגיעה ל־pull request לאחר עבור הבדיקות.