مرحبا يا هبر! أتوجه بهذه المقالة لنفسي أصغر سنا وعديمة الخبرة ، وكذلك لأي شخص يشعر بعدم اليقين بشأن نهج التوثيق الفني. على الرغم من أنها إذا ساعدت شخصًا من البيسون في أعمال التصميم ، فسأكون سعيدًا بشكل مضاعف.
هناك العديد من
المعايير والمواصفات لصياغة
المعارف التقليدية ، ولكن إذا حاولت الاستوديوهات الشابة ، أثناء تطوير متجر بسيط عبر الإنترنت ، الامتثال لها ، فلن يكون لديهم الوقت لتنفيذ مشروعين ، لأنهم سيفلسون ، ويحفرون في مجموعة من المستندات غير المفهومة.
ما كان من قبل
نحن شركة إقليمية صغيرة نشارك في تطوير الويب المخصص ، والذي ، مثل العديد من الشركات الأخرى ، بدأ في البداية مشاريع ، ولا نعرف حقًا كيفية القيام بها. لكن هذا "النمو القسري" كان له تأثير إيجابي للغاية على أعضاء الفريق ، بفضل الرغبة الكبيرة في التطور ، وساعد في ضخ كل من المهارات والرأس. أصبحت التنمية أفضل ، لكن الاختصاصات ظلت عند أدنى مستوى. مثل معظم الاستوديوهات المبتدئين ، استخدمنا النهج الوصفي المعتاد للمعارف التقليدية: أي الصفحات ، وما يجب عرضه ، وبعض النقاط الفنية ، وهذا كل شيء ، ربما.
في العديد من المشاريع ، أدى هذا إلى المشاكل التالية:
- يتم وصف المظهر ، ولكن ليس مبدأ التشغيل. مثال بسيط مع عربة التسوق عبر الإنترنت. في بيان العمل ، تمت كتابة زر "تقديم طلب". ولكن ماذا يجب أن يحدث عندما ينقر المستخدم على هذا الزر؟ ما هي القواعد التي يتكون منها رقم الطلب؟ ما هي الحالة المعينة له؟ إلى أين تذهب إعادة التوجيه؟ وإذا تم بيع إحدى البضاعة أثناء قيام المستخدم بتقديم طلب؟ لم تكن هناك إجابات على هذه الأسئلة والعديد من الأسئلة الأخرى في الاختصاصات ، ولكن هذا عنصر صغير واحد فقط. أدت مثل هذه اللحظات غير الموصوفة إلى نزاعات مع العميل ، وخروج قوي من الميزانية وعواقب أخرى غير سارة.
- عدم وجود كتل قابلة لإعادة الاستخدام. تحتوي العديد من المواقع على نفس الكتل المستخدمة في أماكن مختلفة ، على سبيل المثال ، معاينات المنتج. ولكن تم وصف هذه الكتلة نتيجة لذلك في كل صفحة. هذا سيء للغاية لعدة أسباب. أولاً ، إذا لزم الأمر ، يجب إجراء تغييرات في عدة أماكن في وقت واحد ، قد تفوت شيئًا وسيكون هناك تناقض. ثانيًا ، حتى مع وجود نفس العناصر في المعاينة ، قد يطلب العميل جعلها مختلفة ، مما يستلزم تكاليف إضافية.
- لا يرتبط TK بمهام الفريق. كلما كانت صياغة المشكلة أبعد عن الواقع ، كلما كانت جودة الناتج أقل. هذه مشكلة أخرى أردت حلها.
نهج جديد
بعد تحديد الأهداف ، قمنا بتطوير مفهوم جديد وبسيط إلى حد ما ولكنه فعال.
تتكون المعارف التقليدية من الأقسام التالية:
- مقدمة
- الاستاتيكا
- ديناميات
- المهام
- لوحة الإدارة
- المتطلبات الفنية العامة
من مشروع إلى آخر ، قد يختلف تكوين هذه الأقسام ، ولكن يبقى الهيكل الأساسي. دعونا نلقي نظرة فاحصة.
مقدمة والإعداد للتنفيذ- نحن نصف بإيجاز المشروع ، وأهدافه ، CA ، وترك الروابط لتحليلات ما قبل المشروع.
- نحن نصف عملية تهيئة المشروع: تهيئة البيئة للمطورين ونهج تطوير مفهوم التصميم للمصممين.
- مبادئ التكيف أو النسخ. في الآونة الأخيرة ، في عملنا ، نتمسك بالمبدأ التالي - "تكييف كل شيء يتكيف". وبعبارة أخرى ، في بداية العمل على المعارف التقليدية ، نحن نفهم الوظائف المعقدة التي نحتاجها (أو قد تكون مطلوبة في المستقبل القريب) ، مع المصمم والمطور الأمامي ، نبتكر طرقًا لتكييفها. مع النهج الجديد ، لم تكن هناك نتائج سلبية ، وبالتالي ، لم يكن من الضروري وصف إصدارات منفصلة.
يهدف هذا القسم إلى تحديث الفريق وتهيئة المسرح للتطوير الفوري للمشروع.
الاستاتيكاكما نعلم جميعًا ، يمكن أن تحتوي الصفحات على معلومات ثابتة أو معلومات ديناميكية مرسلة من الخادم. الأقسام الفرعية الثابتة - صفحات المشروع. نقوم بتقسيم كل صفحة إلى كتل. إذا كانت الكتلة ثابتة ، فسنصف جوهرها ونوع محتواها. على سبيل المثال ، قد يبدو وصف أحد الكتل في صفحة حول الشركة بهذا الشكل. "المزايا الرئيسية للشركة. 5-6 أيقونات وصفية. " هذا موجز للغاية ، ولكنه كافٍ لتقييم دقيق ، ووصف الكتلة. عند وصف الإحصائيات ، فإن الهدف الرئيسي هو وضع إطار واضح. لا يعد إنشاء الرموز التكييفية أمرًا صعبًا ، ولكن باستخدام الرسم البياني أو الجدول ، فإن كل شيء ليس بهذه البساطة ولا لبس فيه. ولكن في نفس الوقت ، لا يهم أي نوع من الرموز والتوقيعات سيكون هناك.
إذا كانت الصفحة تحتوي على كتلة يمكن "إخراجها من الأقواس" ، فعندما يتم دمجها ، نكتب "يتم دمج وظيفة NAME ، ويتم وصف الوظيفة نفسها في قسم Dynamics.
بالإضافة إلى الصفحات ، تحتوي Statics على وصف للنوافذ المنبثقة والحروف. في رأيي ، لا معنى لوضعها في قسم كبير منفصل وتضخيم الهيكل.
دينامياتكل ما يتعلق بالديناميكيات التي نسميها وظيفية. ربما سيظهر قسم آخر في وقت لاحق ، لأنه هنا تنتمي أنواع مختلفة من المهام:
- كتلة نحن نصنع الديناميكيات:
- الكتل المستخدمة في أجزاء مختلفة من الموقع.
- الكتل المنطقية للتقييم بشكل منفصل. أولاً ، يبسط عملية التقييم نفسها وفهم العميل لتعقيد عنصر فردي. ثانيًا ، غالبًا ما تندرج هذه الفئات غير الحيوية للمشروع في هذه الفئة ، ومن خلال هذا النهج ، من الأسهل استبعادها من الميزانية.
- العمليات التي تحدث أثناء إجراء مستخدم معين. بادئ ذي بدء ، يشمل هذا الإجراءات التي تحدث عند تقديم الطلب ، والدفع ، والإضافة إلى السلة ، وما إلى ذلك. غالبًا ما يتم الانتهاء من هذه الوظيفة أثناء تطوير المشروع ، وبالتالي فإن هذه التحسينات أكثر ملاءمة لوصفها.
- تكامل خدمات الطرف الثالث. اعتمادًا على مدى تعقيد التكامل ، يمكن وصفه بأنه واحد فعال ، أو العكس مقسم إلى العديد من العوامل المختلفة لوصف الاستعلامات الفردية.
المهاميستخدم هذا القسم للأعمال التي لا يمكن نسبها إلى أي من الأقسام الأخرى: رسم بانر ، وضبط عداد قياس ، وتحليل البضائع ، وما إلى ذلك.
لوحة الإدارةهنا نصف الهيكل والنماذج والمجالات. يتم تقسيم التقسيم إلى أقسام ، على سبيل المثال ، "المنتجات" و "الكتالوج" و "الطلبات" وما إلى ذلك. نحن نصف أن أدوار المستخدم المختلفة يمكنها عرض ما يمكن تحريره.
المتطلبات الفنية العامةيتضمن عددًا قليلاً من الأقسام الفرعية ، ليست جميعها متطلبات فنية حقًا ، ولكن مرة أخرى لم يكن من المنطقي فصلها:
- متطلبات علامة تحسين محركات البحث والعلامات الدقيقة
- قواعد التحويل الصوتي
- الاختبار اليدوي والآلي
- المتصفحات المدعومة
- ...
إصدارات جديدة
عند وصف الإصدارات الجديدة ، من الضروري إجراء تغييرات على العناصر الموجودة. لقد أخذنا في الاعتبار الطرق التالية لوصف التحسينات: في بداية كل قسم (Statics و Dynamics و AP) اكتب "تحسين وظيفة" NAME أو أنشئ قسمًا منفصلاً "تحسينات" يتم فيها التخلص من جميع المهام المتغيرة مرة واحدة. لقد استقرنا حتى الآن على الخيار الثاني ، ولكن هذا يرتبط بالراحة في مشاريع محددة. في ظروف أخرى ، الطريقة الأولى أفضل.
بعد كتابة المواصفات الفنية للنسخة الجديدة ، نقوم بدمجها في نسخة واحدة بحيث يمكن كتابة النسخة التالية على أساس مستند واحد.
مثال
من أجل الوضوح ، دعونا نحلل هيكل المعارف التقليدية على أساس صفحة مبسطة في قسم الكتالوج.
الاستاتيكا
صفحة قسم الدليلتُستخدم لعرض السلع التي تنتمي إلى قسم الكتالوج بأي مستوى باستثناء الجذر.
تم دمج الوظائف التالية:
- "فتات الخبز"
- "شجرة الدليل"
- "التصفية. أحكام عامة "
- "التصفية. نص "
- "التصفية. النص والصورة "
- "التصفية. النطاق "
- "فرز. افتراضيًا "
- "فرز. تصاعدي الأسعار "
- "فرز. سعر تنازلي "
- "معاينة المنتج. بلاط "
- "ترقيم الصفحات. الصفحة "
- "كتلة نص". يدمج ككتلة لنص تحسين محركات البحث أمام القبو
URL: / c / 1745-name ، حيث يكون 1745 هو معرف فئة الدليل الحالي ، والاسم هو الاسم المترجم لهذه الفئة.
ديناميات
نظرًا لأن الصفحة تحتوي على الكثير من عمليات الدمج ، فسأعطي أمثلة لأهمها.
وظائف "التصفية. أحكام عامة "خارجياً ، التصفية هي سلسلة (أو عدة صفوف) من الأزرار باسم المرشح. عند النقر فوق الزر ، تفتح قائمة منسدلة تحتوي على مربعات اختيار مع قيم التصفية (قيم خصائص المنتج المقابلة). يعتمد عرض القائمة المنسدلة على الحد الأقصى لطول القيمة في هذه القائمة. في المنطقة المرئية من القائمة المنسدلة ، لا يتم عرض أكثر من 10 عناصر. إذا كان هناك المزيد من قيم التصفية ، يظهر شريط التمرير. أسفل قيم التصفية يوجد الزر تطبيق. إذا تم تحديد قيمة واحدة على الأقل ونقر المستخدم فوق الزر تطبيق ، خارج منطقة التصفية أو الزر الذي يحمل اسم الفلتر ، فحينئذٍ:
- يتم إغلاق القائمة المنسدلة ويتم تطبيق عامل التصفية. فقط المنتجات المطابقة للمرشحات النشطة الحالية تبقى في القسم الحالي
- يأخذ اسم زر الفلتر الشكل: "اسم الفلتر: K" ، حيث K هو عدد قيم الفلتر المحددة ، إذا كان هناك 2 أو أكثر ، أو "اسم الفلتر: القيمة" إذا تم تحديد قيمة واحدة.
- يتغير لون زر الفلتر إلى نوع الفلتر المستخدم
- في قيم المرشحات الأخرى ، تبقى فقط الخيارات التي ترضي المرشحات النشطة حاليًا. إذا بقيت قيمة واحدة في أحد الفلاتر غير النشطة ، فسيصبح زرها غير نشط ، ويتم عرض الاسم بتنسيق "اسم الفلتر: القيمة"
- لجميع الفلاتر النشطة ، تتم إضافة علامة متقاطعة بعد الاسم ، عند النقر عليها ، تتم إعادة تعيين هذا الفلتر فقط
- يتم إعادة تعيين ترقيم الصفحات
إذا كان هناك فلتر واحد على الأقل نشطًا ، فبعد كل الأزرار التي تحتوي على فلاتر ، يظهر زر "إعادة تعيين الفلاتر" ، عند النقر عليه ، تتم إعادة تعيين قيمة جميع الفلاتر.
عند التبديل من الفئة الحالية إلى أي فئة أخرى ، يتم التحقق من مصادفة المرشحات النشطة والقيم المحددة فيها مع المرشحات المقابلة وقيم الفئة التي تم الانتقال إليها. في الفئة المختارة حديثًا ، تظل تلك الفلاتر والقيم المحددة فيها هي نفسها نشطة.
يمكن دمج التصفية بطريقتين: ديناميكيًا وثابتًا. يتيح لك التكامل الديناميكي تعيين الخاصية التي يتم من خلالها إجراء التصفية في اللوحة الإدارية. يشار إلى عمليات التكامل هذه بدون معلمات إضافية. يتم تطبيق التكامل الثابت على الصفحة بشكل افتراضي. عند وصف التكامل ، يتم الإشارة إلى معلمة إضافية - الخاصية التي يتم بها إجراء التصفية.
تتم إضافة عوامل التصفية المحددة إلى URL من خلال معلمات الاستعلام.
وظائف "معاينة المنتج. بلاط "هو عبارة عن مربع (مستطيل) مع أهم معلومات المنتج للمستخدم. في إصدار التجانب ، تكون المعلومات الأساسية هي صورة المنتج. تحتوي المعاينة على:
- السعر (عدد صحيح بالروبل الروسي)
- اسم المنتج
- تسمية "في المتجر" أو "من النافذة"
- صورة
- الحجم
- زر "إلى سلة التسوق" (تكامل وظيفة "إضافة إلى سلة التسوق")
- زر "إضافة إلى المفضلة" (تكامل الوظائف "إضافة إلى المفضلة")
عندما تنقر على أي منطقة من المعاينة ، بالإضافة إلى زر "إضافة إلى السلة" ، سيتم نقلك إلى صفحة المنتج.
على خط واحد يجب وضع 3-4 بلاط مع معاينات المنتج.
كما ترى ، تم دمج وظيفة أخرى في هذه الوظيفة ، والتي تسمح لك بعمل أقسام مريحة للغاية. على سبيل المثال ، يتم استخدام "إضافة إلى عربة التسوق" و "إضافة إلى المفضلة" أيضًا في خريطة المنتج.
لوحة الإدارة
تتطلب صفحة واحدة عددًا كبيرًا من أقسام AP ، سأصف أحدها.
المنتجقائمة بجميع المنتجات مع التصفية. عند تحرير / إضافة عنصر ، تتوفر الحقول التالية:
- العنوان (النص)
- العلامة التجارية (راديو)
- صور
- السعر (عدد صحيح)
- الوصف (كتلة نصية)
- النوع (متجر / عرض ، راديو)
- الشرط. يتضمن المعنى العنوان (النص) والتفسير (النص).
- الحالة الخيارات هي:
- للبيع
- على الاعتدال
- تحت المراجعة
- رفض
- بيعت
- الاختيار فشل
- ألغى البائع
- حجم العلامة (اختياري). حقل النص دون التحقق من الصحة
- ...
هناك أكثر من 30 حقلاً ، وحتى لا نضخم المقالة ، نحذفها.
الاستنتاجات
مزايا النهج الجديد:- الاكتمال . تسمح لك هذه المعارف التقليدية بوصف المتطلبات بوضوح ، وهي المعلمة الرئيسية والضرورية لأي المعارف التقليدية.
- الوضوح . ما يقرب من نصف عملائنا ليس لديهم أخصائي تقني إلى جانبهم ويواجهون التطوير لأول مرة. ولذلك ، كان من المهم للغاية جعل المعارف التقليدية واضحة ومقروءة قدر الإمكان. وفعلنا ذلك! حتى العملاء المحنكين غير التقنيين يفهمون كيف يعمل ، يمكنهم بسهولة قراءته وتقديم ملاحظات ممتازة.
- الجزيئية تتوافق المعارف التقليدية تمامًا مع متطلباتنا للتقسيم إلى عناصر فردية ، مما يبسط ويحل المشاكل الموضحة أعلاه بشكل كبير. تتوافق Block TK بشكل مباشر مع المهام التي يقوم بها المطورون ، والتي قوبلت بانفجار. تتوافق TK أيضًا بشكل مثالي مع نظام التصميم (سيتم نشر مقال عنها في الأسبوع المقبل).
- سهولة تقدير التكلفة والتكوين . أصبحت المهام الموصوفة جيدًا والمكسورة بسيطة وممتعة للتقييم. إذا فهمنا أثناء التقييم أن المتطلبات غير مكتملة ، فإننا نضيفها. لكل مشروع (مرحلة) ، نقوم بعمل جدول Google حيث يمكن للعميل تجربة تكوينات مختلفة للمشروع وتحديد الخيار الأنسب لنفسه حسب السعر / الوظيفة.
- ارتفع تفاعل العملاء إلى مستوى جديد . تتيح لك التغييرات التي تم إجراؤها تحديد حدود المشروع بوضوح. إذا كانت هناك حاجة لتغييرات فيما يتعلق بالمعارف التقليدية ، يتم تقييم ذلك على أنه مهمة جديدة ، على الرغم من أن النهج القديم تسبب في الكثير من الجدل.
- الربحية . لأن هذا هو في المقام الأول عمل ، وهذا المؤشر ، إلى جانب المؤشر السابق ، هو واحد من أهم المؤشرات. سمحت دراسة مفصلة لتقليل عدد المهام سيئة التقييم. ولم يكن لأي من المشاريع المنفذة بموجب النهج الجديد فائض في الميزانية.
السلبيات:- عمل التحسينات . في أحد المشاريع كان من الضروري إدخال حالة السلع. ونتيجة لذلك ، ظهر عدد كبير من التحسينات من 2-3 خطوط. هذا لا يمكن أن يسمى ناقص واضح ، لأنه يعتبر اكتمال المتطلبات أولوية ، ولكن لا يمكن استدعاء نهج البيانات المثالي.
- تعقيد الإدراك في أتمتة العمليات التجارية . إذا كنت تأخذ العمليات التجارية لبعض الشركات من لحظة البيع إلى استلام البضاعة من قبل المشتري ، فليس هناك دائمًا إمكانية (أو حاجة في المراحل الأولى) لتغطية العملية بأكملها على حساب Statics و Dynamics و AP ، لأن يتم تنفيذ العديد من المهام يدويًا ، وتتم مناقشتها مع العملاء عبر الهاتف ، وما إلى ذلك. وهذا يعقد بشكل طفيف إدراك المعارف التقليدية بشكلها النقي ، ويتطلب وصفا إضافيا للعمليات.
- التكلفة ووقت التطوير . أصبح بيع المعارف التقليدية ، بالطبع ، أكثر صعوبة ، لأنه ليس كل شخص في أول اتصال مع التطوير على استعداد لدفع 10-20 ٪ من المشروع مقابل ذلك ، في حين أن العديد من منافسينا يتقاضون 10-20 ألف مقابل ذلك. لكن هذا العمل يؤتي ثماره بالكامل أثناء التنفيذ ، مما يقلل مخاطر المشروع وتحسين الجودة.
كان لمزايا النهج الجديد تأثير إيجابي للغاية على جميع جوانب عملنا وساعدت في تحديد نقاط الضعف التي لم ننتبه إليها من قبل. السلبيات ، على الرغم من وجودها ، غير ذات أهمية ، خاصة بالمقارنة مع الإيجابيات.
كل مشروع يجلب شيئًا جديدًا ، يصقل الزوايا ويسمح لك بتغييره للأفضل.
نحن سعداء للغاية بالنتيجة التي قررنا التخلي عنها لمسؤولي المهام القياسية لصالح إنهاء مستندات Google للعمل بشكل كامل مع المهام القائمة على المعارف التقليدية. إذا نجحت التجربة ، فسنكتب مقالة منفصلة عنها. في غضون ذلك ، نحن في انتظار انتقادات ونصائح موضوعية منك ، على أمل أن تساعد هذه المقالة شخصًا ما).