Pengelola Dokumen — dokumentasi berkualitas, sebagai dokumen-sebagai-kode

Pengelola Dokumen — dokumentasi berkualitas, sebagai dokumen-sebagai-kode

Tentang saya

Sebuah proyek sampingan yang memungkinkan tim kualitas perusahaan di sektor kesehatan untuk menulis, memeriksa, dan menerbitkan dokumentasi regulasi mereka dari file Markdown yang terverifikasi, dan menghasilkan PDF dengan gaya rumah mereka sendiri.

Pengelola Dokumen — dokumentasi berkualitas, sebagai dokumen-sebagai-kode

Di sektor kesehatan, dokumentasi kualitas — proses, prosedur, instruksi, spesifikasi, template, kontrol perubahan — harus memenuhi persyaratan regulasi yang ketat. Pengelola Dokumen menyimpannya dalam Markdown, terverifikasi di Git: setiap perubahan dilacak, diatribusi, dan dapat dibatalkan. Alat ini membuat cara kerja ini dapat digunakan oleh tim kualitas yang terdiri dari non-developer: semua terjadi di browser, dengan tidak ada yang perlu diinstal kecuali Docker.

Ini menunjukkan pohon dokumen, dengan teks sumber dan render PDF-nya berdampingan. Setiap dokumen mengikuti siklus hidupnya: draf, tinjauan, persetujuan, kemudian kadaluarsa. Seorang penulis, seorang peninjau, dan seorang pemberi persetujuan ditunjuk, dan setiap langkah terkait dengan sebuah commit. Ekspor menghasilkan satu PDF dengan warna perusahaan, dengan referensi, versi, tabel revisi, daftar isi, kotak persetujuan, dan inisial. Diagram ditulis dalam Mermaid dan digambar secara otomatis. Dokumen yang ada — Word, PowerPoint, Excel, PDF, bahkan yang dipindai — dikonversi ke Markdown di workstation, tanpa layanan luar, kemudian diajukan untuk ditinjau.

Pemeriksaan otomatis terus memverifikasi bahwa aturan penulisan diikuti: bidang yang diperlukan, peninjau yang berbeda dari penulis, format versi dan tanggal, tautan yang valid, penamaan file. Agen AI memeriksa ejaan dan bahasa dokumen dan melaporkan temuan mereka. Alat ini dibangun di atas platform Board milik Wexample, yang mengorkestrasi pemrosesan, pemeriksaan, dan agen.

Gambar