أداة توثيق بالذكاء الاصطناعي للتوثيق الداخلي والخارجي

تُوثّق معظم الفرق سير العمل نفسه مرتين. تُكتب النسخة الداخلية للفريق، وتُكتب النسخة الموجهة للعملاء بشكل منفصل بواسطة شخص آخر، ومع الوقت يتوقف الاثنان عن وصف الشيء نفسه.

Trupeer هي أداة توثيق بالذكاء الاصطناعي للتوثيق الداخلي والخارجي تتيح للفرق تسجيل سير عمل مرة واحدة وإنشاء نسخ لكل من الفرق الداخلية والعملاء. يبدأ الاثنان من نفس الالتقاط، لذلك يغطيان الخطوات نفسها حتى لو اختلفت طريقة قراءتهما.

ما هي أداة التوثيق الداخلي والخارجي؟

برمجيات تأخذ سير عملًا واحدًا تم تسجيله وتساعدك في إنتاج توثيق لجمهورين مختلفين منه، بدلًا من كتابة كل نسخة من الصفر.

المصدر هو تسجيل لعملية يتم تنفيذها. يقوم الذكاء الاصطناعي بإنشاء الخطوات واللقطات من هذا الالتقاط، ما يمنحك مسودة تحتوي بالفعل على كل ما تحتاجه النسختان. ثم تقوم بتكييفها: تحافظ النسخة الداخلية على التفاصيل التقنية وسياق الفريق، بينما تُبسّط النسخة الخارجية إلى لغة موجهة للعملاء مع إزالة أي شيء داخلي. تُنشر النسختان النهائيتان إلى وجهات مختلفة، وغالبًا ما تكون قاعدة معرفة داخلية ومركز مساعدة عام. يستخدم Trupeer تسجيلات الشاشة كمصدر، وينشئ توثيقًا خطوة بخطوة قابلًا للتعديل يمكن بعد ذلك تكييفه للاستخدام الداخلي أو الموجه للعملاء.

التوثيق الداخلي مقابل التوثيق الخارجي

يصفان سير العمل نفسه للقراء الذين يحتاجون إلى أشياء مختلفة جدًا.

الخطوات هي نفسها. لكن الإطار اللغوي والمفردات ومستوى التفاصيل لا تكون كذلك، ولهذا يبدو كتابتها بشكل منفصل ضروريًا، ولهذا تتباعدان بمجرد أن تفعل ذلك.

مصدر واحد، جمهوران

بديل كتابة نسختين هو بدء النسختين من نفس الالتقاط. يتم تسجيل سير العمل مرة واحدة؛ والوثيقتان الداخلية والخارجية هما عرضان مختلفان له.

يبقى المصدر كما هو؛ ويتغير السياق الخاص بالجمهور.

يقلل ذلك من خطر تباعد التوثيق عن المصدر: تبدأ النسختان من نفس الخطوات التي تم رصدها بدلًا من الاعتماد على حسابين منفصلين لدى شخصين مختلفين لنفس العملية.

كيف يعمل التوثيق الداخلي والخارجي

الخطوة 1: سجّل سير العمل مرة واحدة

التقط العملية داخل متصفحك، أو ارفع تسجيلًا لديك بالفعل. يخدم الالتقاط الواحد كلا الجمهورين، لذلك لا توجد جلسة ثانية لجدولتها.

الخطوة 2: أنشئ التوثيق من مصدر واحد

يحوّل الذكاء الاصطناعي الإجراءات المسجلة إلى خطوات منظمة، وينقلك من التقاط سير عمل خام إلى مسودة توثيق قابلة للتعديل. ينتج Trupeer تلك المسودة مع لقطة شاشة لكل إجراء. هذه المسودة الواحدة هي المصدر الذي تنطلق منه النسختان، وتحتوي على كل خطوة يحتاجها أي من الجمهورين.

الخطوة 3: كيّف كل نسخة وانشرها

تبقى المسودة المُنشأة قابلة للتعديل، لذلك تقوم بتكييفها لكل جمهور: احتفظ بالتفاصيل التقنية وملاحظات التصعيد داخليًا، وبسّط الصياغة خارجيًا، وطمّس أو استبدل أي شيء لا ينبغي أن يغادر المبنى. انشر النسخة الداخلية حيث يبحث فريقك، والنسخة الخارجية في مركز المساعدة، أو صدّر أيًا منهما إلى PDF أو Word.

ما الذي يمكنك إنشاؤه باستخدام Trupeer

يتكيف نفس التسجيل إلى كل ما يلي:

• إجراءات تشغيل قياسية داخلية (SOPs): سير العمل الكامل مع أسماء الأنظمة ومسارات التصعيد والسياق الذي يمتلكه فريقك بالفعل

• مقالات مساعدة موجهة للعملاء: نفس الخطوات بلغة العملاء، مع إزالة التفاصيل الداخلية وتنظيف لقطات الشاشة

• جولات المنتج: فيديو مُسرد من نفس الالتقاط، كمخرَج ثانوي إلى جانب النسخ المكتوبة

• توثيق الدعم: استكشاف أخطاء داخلي مع مسار التصعيد، ودليل الحل العام دون ذلك

• التدريب الداخلي: مواد تمكينية لفريقي الدعم والمبيعات من نفس سير العمل الذي سيتبعه العملاء

• أدلة الإعداد للعملاء: عملية الإعداد كما ينفذها العميل، بدءًا من الالتقاط الذي أنجزه فريقك بالفعل

لماذا تستخدم Trupeer للتوثيق الداخلي والخارجي؟

• تسجيل واحد بدلًا من جلسات توثيق منفصلة لكل جمهور

• لقطات شاشة يتم إنشاؤها من سير العمل الفعلي بدلًا من التقاطها مرتين يدويًا

• مخرجات قابلة للتعديل، لذلك تحدث التغييرات الخاصة بكل جمهور داخل المسودة بدلًا من إعادة الكتابة

• توثيق مكتوب وفيديو من نفس الالتقاط، مع اعتبار الفيديو مخرَجًا ثانويًا

قبل وبعد

قبل: شركة SaaS تُطلق سير عمل جديد للفوترة. يقوم المنتج بكتابة إجراء تشغيل قياسي داخلي (SOP). يقوم الدعم بشكل منفصل بكتابة مقال مركز المساعدة. يقوم شخصان بتوثيق سير عمل واحد، وبعد ذلك قد تتباعد النسختان.

بعد: ينتج تسجيل شاشة واحد النسختين معًا. تحمل النسخة الداخلية سير العمل التقني وسياق الفريق وتفاصيل التصعيد. تحمل النسخة الخارجية تعليمات مبسطة للعملاء مع لقطات الشاشة وصياغة مناسبة للعملاء. عندما تتغير شاشة الفوترة، أعد تسجيل سير العمل المتأثر وحدّث كلا النسختين منه.

أين ينطبق ذلك

• إصدارات المنتج: تسليم داخلي للدعم والمبيعات، ومقال مساعدة للعميل، من نفس جولة ميزة المنتج

• توثيق الدعم: استكشاف أخطاء داخلي مع مسارات التصعيد، ودليل حل عام دونها

• إعداد البرمجيات: تدريب داخلي للفريق، وإعداد العملاء للحسابات الجديدة

• تغييرات العمليات: إجراء تشغيل قياسي داخلي يصف ما يفعله الفريق، وإشعار خارجي يصف ما يتغير بالنسبة للعميل

• توثيق الميزات: سياق المنتج والهندسة داخليًا، وتعليمات المهمة خارجيًا

ما الذي يتغير بين النسختين

• المصطلحات: أسماء الأنظمة والأسماء الداخلية تصبح الكلمات التي يستخدمها العملاء

• المعرفة المفترضة: لا يمكن للنسخة الخارجية أن تفترض دراية بشاشات الإدارة أو نموذج البيانات لديك

• التصعيد والاختصارات: مسارات مخصصة للداخل فقط تظهر في النسخة الخارجية

• لقطات الشاشة: الأدوات الداخلية ومعرّفات الحساب وأي شيء حساس يتم طمسه أو استبداله

• النطاق: غالبًا ما تغطي النسخة الداخلية حالات الحافة التي تستبعدها النسخة الخارجية عمدًا

• الوجهة: واحدة تذهب إلى قاعدة المعرفة الداخلية، والأخرى إلى مركز المساعدة

الحفاظ على توافق النسختين

السبب في تباعد التوثيق الداخلي والخارجي هو أنهما تتم صيانتهما بشكل منفصل. يقوم شخص ما بتحديث إجراء التشغيل القياسي الداخلي بعد حدوث تغيير ولا يخبر أحد الشخص المسؤول عن مقال مركز المساعدة.

العمل من خلال سير عمل مسجل واحد يضيّق هذه الفجوة: عندما تتغير العملية، أعد تسجيل الجزء المتأثر وحدّث كلا النسختين من نفس المصدر، بدلًا من تذكر المستندات التابعة التي تعتمد عليه. ليس ذلك تلقائيًا، ولا يزال يتعين على شخص ما ملاحظة أن العملية قد تغيرت.

ما الذي لا يفعله هذا

لا يقرر ما يجب أن يراه العملاء وما لا يجب أن يروه، ولا يعيد كتابة اللغة الداخلية إلى لغة موجهة للعملاء دون مراجعة، ولا يحافظ على تزامن النسختين من تلقاء نفسه. الحكم بشأن ما يغادر المبنى هو قرار شخص، في كل مرة.

للاطلاع على كيفية مراجعة مسودة مُنشأة قبل النشر، راجع AI documentation accuracy. وللتعرف على توثيق ميزات المنتج تحديدًا، راجع the AI product documentation tool.

أنشئ النسختين من تسجيل واحد

أنشئ توثيقًا داخليًا وتوثيقًا موجهًا للعملاء من نفس تسجيل سير العمل باستخدام Trupeer. جرّب Trupeer مجانًا.