מבנה תיעוד טכני ב-1C-Bitrix

נצברו 200 מאמרים, אבל אי אפשר למצוא את זה שצריך — אין חיפוש טקסט מלא, מאמרים לא מקוטלגים. משתמשים הולכים ל-Yandex בלי למצוא תשובה. אנחנו פותרים את הבעיה הזו על ידי יצירת בסיס ידע מובנה ב-1C-Bitrix עם אינפובלוק מוגדר, חיפוש וייבוא אוטומטי. הניסיון שלנו — 7 שנות פיתוח, מעל 50 פרויקטים מוצלחים.

למה בלוג רגיל לא מתאים לתיעוד טכני?

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

ארכיטקטורת אינפובלוק למאמרים

אינפובלוק נפרד נוצר עבור סעיף המאמרים. מבנה הסעיפים (b_iblock_section) תואם להיררכיית הנושאים — עד 3 רמות קינון. קינון עמוק יותר ב-Bitrix אפשרי טכנית, אבל מחמיר את הניווט ואת ה-SEO (URL ארוך, משקל מדולל).

מאפייני אינפובלוק חובה:

• DIFFICULTY — רמת מורכבות החומר (רשימה: "מתחיל", "מתקדם", "מומחה")
• READING_TIME — זמן קריאה בדקות
• LAST_UPDATED — תאריך העדכון האחרון של המאמר (חשוב לחומרים טכניים)
• RELATED_LINKS — מאפיין מרובה מסוג "מחרוזת" למקורות חיצוניים
• VIDEO_EMBED — קוד הטמעה של הוראת וידאו

תאריך הפרסום (ACTIVE_FROM) ותאריך העדכון (LAST_UPDATED) הם שדות שונים. בתבנית דף הפרטים אנו מציגים: "עודכן לאחרונה: לאחרונה."

איך להגדיר חיפוש רק בתוך סעיף המאמרים?

החיפוש הסטנדרטי של Bitrix (bitrix:search.page) עובד על כל האתר. עבור סעיף המאמרים, לעתים קרובות אנו צריכים חיפוש רק בתוך האינפובלוק. זה נפתר בשתי דרכים.

דרך מודול החיפוש הסטנדרטי עם פילטר. אינדוקס האינפובלוק למאמרים מוגדר דרך CSearch::Index(). חיפוש מוגבל על ידי פרמטר IBLOCK_ID:

$obSearch = new CSearch();
$obSearch->Search([
    'QUERY' => $searchQuery,
    'MODULE_ID' => 'iblock',
    'PARAM2' => IBLOCK_ARTICLES_ID,
]);

דרך Elasticsearch לסעיפים גדולים (1000+ מאמרים). חיפוש טקסט מלא סטנדרטי של MySQL איטי לשאילתות מורכבות. מנוע חיפוש חיצוני מחובר דרך רכיב מותאם אישית; נתונים מסונכרנים דרך סוכן Bitrix. עבור 3000 מאמרים, הפרש המהירות הוא פי עשרה: 4 שניות לעומת 0.1 שניות.

קישורים פנימיים וניווט

הניווט בתוך סעיף המאמרים הוא קריטי. המשתמש הגיע לתשובה, מצא מאמר, וצריך לנווט בקלות לנושאים קשורים.

פירורי לחם — רכיב bitrix:breadcrumb סטנדרטי, עובד אוטומטית עם מבנה סעיפי אינפובלוק נכון.

תפריט קטגוריות צדדי — רכיב bitrix:menu עם פרמטר MENU_TYPE או רכיב מותאם אישית המשתמש ב-CIBlockSection::GetList():

$sections = CIBlockSection::GetList(
    ['SORT' => 'ASC'],
    ['IBLOCK_ID' => IBLOCK_ARTICLES_ID, 'DEPTH_LEVEL' => 1, 'ACTIVE' => 'Y'],
    false,
    ['ID', 'NAME', 'CODE', 'SECTION_PAGE_URL']
);

בלוק מאמרים קשורים — לפי התאמת סעיף או תגיות:

$related = CIBlockElement::GetList(
    ['RAND' => 'ASC'],
    [
        'IBLOCK_ID' => IBLOCK_ARTICLES_ID,
        'SECTION_ID' => $arResult['IBLOCK_SECTION_ID'],
        '!ID' => $arResult['ID'],
        'ACTIVE' => 'Y'
    ],
    false,
    ['nTopCount' => 4],
    ['ID', 'NAME', 'PREVIEW_PICTURE', 'PREVIEW_TEXT', 'DETAIL_PAGE_URL']
);

נתונים מובנים (Schema.org)

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

// в template.php детальной страницы
$schema = [
    '@context' => 'https://schema.org',
    '@type' => 'Article',
    'headline' => $arResult['NAME'],
    'datePublished' => $arResult['ACTIVE_FROM'],
    'dateModified' => $arResult['PROPERTIES']['LAST_UPDATED']['VALUE'],
    'author' => [
        '@type' => 'Organization',
        'name' => 'Название компании',
    ],
];
echo '<script type="application/ld+json">' . json_encode($schema, JSON_UNESCAPED_UNICODE) . '</script>';

איך עובד ייבוא תוכן?

1. הכנת מקורות. אנו אוספים את כל הקבצים (Word, PDF, Excel) לתיקייה אחת. אנו בודקים את המבנה.
2. המרה. עבור DOCX אנו משתמשים ב-PHPWord, עבור PDF — pdftohtml. אנו מקבלים HTML.
3. ניקוי. אנו מסירים סגנונות מיותרים, מיישרים כותרות, מתקנים קידוד.
4. טעינה. סקריפט עובר על כל קובץ, יוצר אלמנט אינפובלוק דרך CIBlockElement::Add().
5. קיטלוג. אנו מקצים סעיפים לפי שם הקובץ או מפה נפרדת.
6. בדיקה. אנו בודקים ויזואלית 10% מהמאמרים. אנו מתקנים שגיאות.

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

מילוי תוכן המוני וייבוא

סעיף מאמרים גדול מתמלא לעתים קרובות ממקורות חיצוניים: מסמכי Word, הוראות PDF, Google Docs. הזנה ידנית של כל מאמר בעורך החזותי של Bitrix אינה יעילה.

ייבוא מ-Excel. הכלי הסטנדרטי של Bitrix מאפשר ייבוא אלמנטים של אינפובלוק מ-CSV. עמודות: NAME, PREVIEW_TEXT, DETAIL_TEXT, SECTION_ID, מאפיינים. אבל סימון HTML ב-CSV הוא בעייתי: מרכאות ושורות חדשות שוברות את הפורמט. פתרון — סקריפט PHP מותאם אישית עם CIBlockElement::Add().

המרה מ-Word/PDF. ספריית PHPWord (דרך Composer) קוראת DOCX וממירה ל-HTML. PDF מומר דרך pdftohtml (כלי מערכת) או דרך API חיצוני (Adobe PDF Services). התוצאה מנוקה עם ביטויים רגולריים ונשמרת ב-DETAIL_TEXT.

גרסאות תוכן. לתיעוד טכני, חשוב לעקוב אחר שינויים. ל-Bitrix אין גרסאות מובנות לתוכן מאמרים (רק לדפי אתר דרך מודול הנחיתה). פתרון מותאם אישית: לפני עדכון מאמר, הגרסה הישנה של DETAIL_TEXT נשמרת בטבלה נפרדת b_custom_article_versions עם שדות ELEMENT_ID, VERSION_DATE, CONTENT, USER_ID. במשך שנה, מערכת כזו מאפשרת שחזור של עד 15 עריכות.

עדכון אוטומטי של מאמרים מיושנים

מאמרים טכניים מתיישנים. יש צורך במערכת התראות: 6–12 חודשים אחרי הפרסום, מנהל התוכן מקבל תזכורת לבדוק רלוונטיות. יישום דרך סוכן Bitrix (CAgent::Add()) שבודק את תאריך העדכון האחרון פעם בחודש ושולח דוא"ל דרך CEvent::Send().

מה כלול בעבודה

בהזמנת מילוי סעיף מאמרים, אנו מספקים:

• עיצוב האינפובלוק והמאפיינים
• הגדרת חיפוש (סטנדרטי או Elasticsearch)
• ייבוא תוכן ממקורות חיצוניים (Word, PDF, Excel)
• פיתוח תבניות לדף פרטים ולרשימה
• הגדרת קישורים פנימיים וניווט
• חיבור נתונים מובנים
• הגדרת סוכן לעדכון מאמרים מיושנים
• הדרכת מנהלי תוכן

אנו מעריכים את הפרויקט ביום אחד. אחריות על כל העבודה — 12 חודשים. קבלו ייעוץ: כתבו לנו ואנו נעריך את הפרויקט שלכם.

לוחות זמנים ונפחים

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

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