مدیر سند — مستندات با کیفیت، به‌عنوان کد سند

مدیر سند — مستندات با کیفیت، به‌عنوان کد سند

درباره من

یک پروژه جانبی که به تیم‌های کیفیت شرکت‌ها در بخش بهداشت اجازه می‌دهد مستندات تنظیمی خود را از فایل‌های Markdown نسخه‌بندی شده بنویسند، بررسی کنند و منتشر کنند و PDFهایی با سبک مخصوص خود تولید کنند.

مدیر سند — مستندات با کیفیت، به‌عنوان کد سند

در بخش بهداشت، مستندات با کیفیت — فرآیندها، رویه‌ها، دستورالعمل‌ها، مشخصات، الگوها، کنترل تغییر — باید به الزامات سخت‌گیرانه تنظیمی پاسخگو باشند. مدیر سند آن را در Markdown نگه می‌دارد، نسخه‌بندی شده در Git: هر تغییر پیگیری، نسبت داده و قابل برگرداندن است. این ابزار این روش کار را برای تیم‌های کیفیت که شامل غیر توسعه‌دهندگان هستند، قابل استفاده می‌کند: همه چیز در مرورگر اتفاق می‌افتد و تنها چیزی که باید نصب شود Docker است.

این ابزار درخت سند را نمایش می‌دهد، با متن منبع و نمایش PDF آن در کنار هم. هر سند چرخه حیات خود را دنبال می‌کند: پیش‌نویس، بررسی، تأیید و سپس منسوخی. یک نویسنده، یک بازبین و یک تأییدکننده نام برده می‌شوند و هر مرحله به یک کامیت مرتبط است. صادرات یک PDF واحد با رنگ‌های شرکت تولید می‌کند، با مرجع، نسخه، جدول بازنگری، جدول محتویات، جعبه تأیید و حروف ابتدایی. نمودارها به زبان Mermaid نوشته و به‌صورت خودکار ترسیم می‌شوند. مستندات موجود — Word، PowerPoint، Excel، PDF و حتی اسکن شده — بر روی ایستگاه کاری به Markdown تبدیل می‌شوند، بدون سرویس خارجی، و سپس برای بررسی ارسال می‌شوند.

بررسی‌های خودکار به‌طور مداوم تأیید می‌کنند که قوانین نوشتن رعایت می‌شوند: فیلدهای الزامی، بازبین متفاوت از نویسنده، فرمت‌های نسخه و تاریخ، لینک‌های معتبر، نام‌گذاری فایل. عوامل هوش مصنوعی املاء و زبان مستندات را ویرایش می‌کنند و گزارش‌هایی از یافته‌های خود ارائه می‌دهند. این ابزار بر روی پلتفرم Board شرکت Wexample ساخته شده است که پردازش، بررسی‌ها و عوامل را سازماندهی می‌کند.

عکس‌ها