מנהל מסמכים — תיעוד איכותי, כמסמך-כקוד

מנהל מסמכים — תיעוד איכותי, כמסמך-כקוד

עליי

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

מנהל מסמכים — תיעוד איכותי, כמסמך-כקוד

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

הוא מציג את עץ המסמכים, עם הטקסט המקורי ואת ההדפסה ב-PDF זה לצד זה. כל מסמך עוקב אחר מחזור חיי: טיוטה, סקירה, אישור, ואז התיישנות. נבחרים מחבר, בודק ומאשר, וכל שלב קשור ל-commit. הייצוא מייצר PDF אחד בצבעי החברה, עם הפניה, גרסה, טבלת תיקונים, תוכן עניינים, תיבת אישור וראשי תיבות. דיאגרמות נכתבות ב-Mermaid ומצוירות אוטומטית. מסמכים קיימים — Word, PowerPoint, Excel, PDF, אפילו סרוקים — מומרות ל-Markdown בתחנת העבודה, ללא שירות חיצוני, ולאחר מכן מוגשות לסקירה.

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

תמונות