قبل بضعة أشهر ، أكملت واحدة من مراحل مسيرتي الاحترافية بصفتي شيفا متعدد الأسلحة في شركة ناشئة لتطوير نظام لإدارة مختبرات الاختبارات غير المدمرة. سوف أخبرك كيف تمكنت من توثيق جزء من التطوير المتعلق بربط وتوليد الوثائق في حجم كافٍ للاستخدام الإضافي الهادئ للنظام الذي تم إنشاؤه لمدة عامين.
سأحاول إعطاء القارئ مادة مفيدة قدر الإمكان ، وفي نفس الوقت أراعي مصالح المشروع ولا أفصح عن الفروق الدقيقة في التنفيذ والاستخدام الداخلي.
معين:
- فريق التطوير بارد وبالطبع مدير المشروع. في وقت بدء المشروع ، عملت كمخرج فني في إحدى استوديوهات تومسك ، ثم انتهيت إلى فريق بدء التشغيل
- البدء بتواريخ ملموسة معززة لحدث معين - بدء التسارع في FRII
- مجموعة أولية من القوالب من أكثر من 15 مستندًا بأحجام مختلفة من صفحة واحدة إلى 100+ صفحة في مستند واحد بظروف اتصال مختلفة
- مشروع طرف ثالث يجب أن يتكامل مع حل مستقبلي
- المصمم (محلل ، مصمم ، مصمم ، مدير فني ، مالك منتج ، مدير منتج كلها مدمجة في واحد)
الهدف:
- إطلاق مشروع في الوقت المحدد
- لا تموت بعد ستة أشهر في حالة من الفوضى عند توصيل وظائف جديدة والمزيد من الوثائق في النظام (في حالة الانتهاء بنجاح من التسارع)
- مع الحد الأدنى لعدد الحروف والجهود المبذولة لتحقيق الوثائق المناسبة
- نقل الوثائق إلى أي فريق / أي موظف ليس في السياق
يجب أن أقول على الفور أن قوالب المستندات التالية صُنعت دون أي منهجية ، وقد استرشدت فقط بخصائص المشروع والحس السليم والحد الزمني الرهيب.
التحليل والتحضير
آمل أن تبدأ أي مهمة غير تافهة عن طريق تحليل المواد ، في حالتي ، كانت المادة عبارة عن قوالب للمستندات ومشروع قائم يلزم التكامل معه. ولكن بعد ذلك نتحدث فقط عن الوثائق. كنت بحاجة لتحديد مدى تكرار استخدام نفس النوع من البيانات داخل نفس المستند وبين المستندات. كان من الضروري أن نفهم ما إذا كان هناك حاجة لنظام ما في الوقت الحالي أو يمكنك القيام بذلك بسرعة على الركبة أولاً ، ثم التعامل مع النتيجة. في ذلك الوقت ، تقرر أن هناك حاجة للنظام ، حيث أن جميع البيانات تقريبًا ، في مجلد أو آخر ، تكررت داخل مستند وفي حزمة كاملة من المستندات - وهذه علامة مؤكدة على الارتباك بالفعل في المستند الثاني أو الثالث عند الاتصال.
والخطوة التالية هي فهم حالة نظافة توصيف الوثائق. ساوضح. والحقيقة هي أنني تلقيت قوالب المستندات المكتملة بالفعل من أخصائي المنهجية - من ، ومتى وكيف لم أكن أعرف هذه الوثائق ، حتى لو كنت أعرف أن هذا لن يعطي الكثير. مستند .docx بداخله يشبه xml للنص وقد لا تكون بعض العناصر مرئية بشكل مرئي في مستند مفتوح ، ولكن تكون موجودة في ترميز المستند. كيف سيكون رد فعل منشئ المستندات والبرامج المختلفة لعرض المستند على عناصر العلامات هذه غير معروف. كان الرهان الرئيسي على Microsoft Word ، ولكن هناك OpenOffice و LibreOffice وكلهم يستطيعون إعطاء نتائج مختلفة. لذلك ، مرت جميع القوالب أولاً بعملية تنظيف النمط - إعادة كاملة لأي تصميم وإعادة تصميم باستخدام أنماط المستند ، في مكان ما مع ضبط بنية المستند. وحتى بعد هذا الإجراء ، قمنا بتجميع المشكلات في محتويات المستندات بعد الإنشاء. في المستقبل ، توصلت إلى استنتاج مفاده أنه إذا كانت الوثيقة صغيرة ، فمن الأفضل إعادة فرزها من نقطة الصفر ، وعدم أخذ القالب الذي يقدمه أخصائي المنهجيات في العمل ، وهذا يوفر الوقت على المستندات حتى 5 صفحات. لا أحد يريد بعد ذلك البحث عن سبب حدوث شيء ما ، عملية تصحيح هذه الحالات شاقة للغاية بالنسبة للفريق. في نفس المرحلة ، إذا كان لديك حزمة من الوثائق ، فإنك تأتي إلى لغة مرئية موحدة.
وحيث أننا أجرينا طقوسًا لتنظيف المستندات ، فقد اقترحت بيضة عيد الفصح في المعلومات الوصفية نفسها ، لأن الناس يحبون مشاركة مستندات جيدة
بعد كل الأعمال المتعلقة بإعداد الوثائق ، انتقلت إلى وضع علامات للوثائق لإنشاء تلقائي.
ترميز الوثائق
في هذه المرحلة ، اطلب من المطورين التنسيق المتغير الذي يدعم منشئ المستندات الذي حدده فريقك حتى لا تضطر إلى إعادته لاحقًا. اضطررت إلى إعادته ، ولكن هذا كان بسبب استبدال المولد. تعذر على المولد الجديد العمل مع المتغيرات في التنسيق السابق ، ولكن تبين أن قدرات المولد الجديد أكثر أهمية بالنسبة لنا وقررنا استبدالها.
تحقق من كفاية المعلومات في النظام ، وحدد مقدار البيانات غير الكافي للمستند. متى من المفترض أن تظهر هذه البيانات على النظام؟ إذا لم تتوفر بيانات كافية لتحقيق الاكتفاء الذاتي للمستند ، فمن الأفضل تأجيله. ما هي وثيقة الاكتفاء الذاتي؟ في حالتي ، كانت هناك وثيقة واحدة أكملناها في 3 مراحل ، لكنها كانت مكتفية ذاتيا على الفور لسيناريو واحد محدد ، لكن لم تغطي بقية السيناريوهات ، لذلك قررنا طرح المستند للإنتاج وترك خلايا فارغة للمستخدم ليملأها للبرامج النصية غير المكتشفة ، وانتهت بعد ذلك من الوثيقة مع ظهور الوظيفة اللازمة.
وثائق متغير واجهة
في بداية الملاحظة ، كتبت أننا اقتصرنا بشكل صارم على حدث معين. علاوة على ذلك ، كان لدي بالفعل عطلة مخططة. عندما كنت غير متوفر ، لكنني كنت بحاجة ماسة إلى إضافة متغير نظام (غير متوفر في واجهة المستخدم النهائي) ، أضاف المطورون السطر مع المتغير بأنفسهم ، ثم أضفت الشروط المفقودة. في هذا الصدد ، لا تتظاهر مواصفات المتغيرات بأنها صحيحة ومثالية ، لكنها وثيقة عمل توسعت وتطورت لاحقًا. لم تتغير علامة التبويب الرئيسية في المستند من الناحية الهيكلية من البداية وفي وقت مغادرتي للمشروع.
قالب "
مواصفات هذه الحقول " ، والتي يمكنك استخدامها واستخدامها في عملك. في المستند ، تركت جزءًا من البيانات كمثال. قد يكون هذا القالب مناسبًا لوثائق الواجهة للتحكم في جودة التطوير. على سبيل المثال ، يعرف مالك المنتج الحد الأدنى من النتائج التي سيحصل عليها ، ويفهم المطور بوضوح الحد الأدنى المطلوب من وصف المهمة + مواصفات هذه الحقول ، وإذا كان هناك شيء مفقود سيخبره به ، فإن مهندس الاختبار يرى بوضوح حالات واضحة. في النهاية ، كل شيء في الأسود.
في البداية ، سوف يستغرق المستند عددًا كبيرًا من الساعات ، ولكنه سيوفر لك وقتًا طويلاً ، وسيستغرق التحديث أحيانًا دقائق حرفيًا.
المحتويات:
- الصفحة هي دليل لشخص خارج سياق المشروع ، حيث أن ننظر فيها. مفيدة لعضو جديد في فريق أو الاستعانة بمصادر خارجية للمشروع.
- اسم الحقل
- نوع الحقل
- حقل إلزامي في المشاريع (أذكرك ، كان لدينا قاعدة بيانات لمشروع آخر) - علامة لمزامنة شرط الربط بين المستند والواجهة. إذا كانت المعلومات الواردة في المستند ملزمة ولا يمكن للنظام استلامها بطريقة أخرى ، فسيكون من الضروري جعل هذا الحقل إلزاميًا في الواجهة
- قناع الحقل - يتم تحديد تنسيق تسجيل المعلومات بوضوح في الوثائق التنظيمية.
- القيمة الافتراضية
- الحد الأقصى لعدد الأحرف في الحقل
- قابلية تطوير الحقل (يعتمد على الدقة) - وصف لسلوك عنصر واجهة اعتمادًا على الدقة
- متطلبات البيانات - ما هو التفاعل المسموح به مع عنصر الواجهة وما يمكن أن يحدث
- عينة ناجحة
- عنصر نائب - تلميح الأدوات للمستخدم داخل عنصر واجهة
- تخصيص الحقل - عناصر واجهة غير قياسية أو مهام منتهية
- معلومات إضافية بجوار الحقل - عندما يتعذر الاستغناء عن العنصر النائب بسبب مقدار النص ، فإننا نستخدم تلميح أداة أو مقبضًا
- نوع التحقق من الصحة
- رسالة التحقق - شروط النظام والاستجابة
- متغير في قوالب المستندات - ما سيتم إدراجه في قالب المستند
- رابط إلى الصفحة - لم تستخدم نتيجة لذلك
- موقع الحقل في الواجهة - لم تستخدم نتيجة لذلك
وثيقة اتصال الوثائق
لاستلام المستند من قبل المستخدم النهائي ، لا يكفي تحريره وترميزه ؛ لا يزال يلزم توصيل المستند بشكل صحيح. من المهم بشكل خاص إذا كان لديك القالب نفسه ، وفقًا للظروف ، يغير محتواه. لهذا ، استخدمت وثيقة منفصلة.
قالب "
اتصال المستند " ، أتمنى أن يكون مفيدًا لشخص ما.
المحتويات:
- الحالة - تشير إلى الحالة الحالية للوثيقة في النظام. قمنا بتوصيل وثيقة واحدة في 3 مراحل ، كانت حالة المستند "وضع اللمسات الأخيرة"
- المستند - اسم المستند داخل الفريق ، وقاعدة المعرفة وضمن نظامنا لإعداد الوثائق والمهام
- نوع
- يتم تنسيق المستند عندما يكون المستند نفسه في قوالب مختلفة وفقًا للوثائق التنظيمية والتقنية التي تتوافق معها هذه الوثيقة
- التكوين - يمكن أن يكون المستند مجرد قالب يتم فيه استبدال المتغيرات أو من قالب مكون من 3 صفحات يمكنك الحصول على أكثر من 100 مستند - وثائق ديناميكية
- التواجد في الحزمة هو ميزة للنظام ، يمكنك الحصول على حزمة من المستندات أو تنزيل المستندات بشكل منفصل
- حالة التواجد - وجود مستند معين في الحزمة
- ميزة الاتصال هي ذلك الجزء من المستند غير الموجود في القالب ويتم تنظيمه بواسطة الكود.
- رابط إلى الملف للاتصال
- تحميل بشكل منفصل
- اسم الملف المراد تنزيله - يمكن استدعاء مستند في النظام بما تريد ، ولكن يجب أن يرى المستخدم النهائي اسمًا محددًا عند التنزيل
في المجموع
نتيجة لذلك ، ملأت 362 سطرًا في كلا الوثيقتين. حجم مثير للإعجاب؟ ولكن في الواقع ، هذا هو أكثر من 30 قالبًا للوثيقة وتم قضاء ما مجموعه 40-60 ساعة من عمل شخص واحد في غضون عامين (1-1.5 أسبوعًا) ، باستثناء تحرير القوالب نفسها وصياغة مهام الاتصال.
اجتاز المشروع بنجاح تسارع IIDF ووصل إلى فريق التطوير الخاص به. بفضل الوثائق الحالية ، لم يكن على أعضاء الفريق الجدد أن يبحثوا لفترة طويلة عما حدث قبلهم فيما يتعلق بتوليد الوثائق. تمكن جميع أعضاء الفريق من الوصول إلى الوضع الحالي للوثائق المتصلة في أي وقت.
المراحل الرئيسية في توثيق عملية إنشاء المستندات:
- تحليل محتوى الوثائق
- وثيقة النظافة
- إصلاح المتغيرات بالتوازي مع ترميز المستند
- إصلاح الفروق الدقيقة في توصيل قوالب المستندات.
شكرا للوصول الى النهاية.