ما هو الحل الجيد لجمع وثائق قواعد العمل؟[مغلق]

Question

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

يمكنني التفكير في بديلين:Sharepoint (أكره ذلك، ميزة البحث فظيعة) أو wiki.

بعض الأشياء التي أود رؤيتها في الحل المثالي:

• قابلة للتحديث بسهولة:لا تجعلني أسحب Word لتحديث المستندات
• عرض الفرق:في بعض الأحيان تحتاج فقط إلى رؤية ما هو جديد
• قابلة للاشتراك:الإخطار بالتغييرات الجديدة على أساس كل صفحة على حدة
• الدور على أساس:يمكن ربط تحرير الصفحات وعرضها بالأدوار
• المرفقات:سهولة تضمين النماذج بالحجم الطبيعي والملفات وما إلى ذلك.
• يبحث:إنه عالم منشور في Google، أريد أن أكون قادرًا على البحث والعثور على الفور - يخسر Sharepoint في هذه الفئة، ما لم يتم تكوين الفئة التي نستخدمها بشكل غير صحيح
• تقييد المرفقات:من الناحية المثالية، لن يسمح الحل بتحميل مجموعة من مستندات Word التي نطلق عليها بعد ذلك وثائقنا.أرغب في أن يكون للوثائق تنسيق ثابت (وبسيط).فرض المرفقات بتنسيق PDF وtxt وما إلى ذلك.

متابعة تعليقي على الويكي يبدو أن هناك ما لا يقل عن 3 ويكي التي تفعل ما أريد (Incentive، SharePoint-Wiki-Plus، ThoughtFarmer).مزارع الفكر، أحب هذا الاسم.

Answer 1

+10⁶ بالنسبة إلى Wiki، إنه أفضل حل وجدته حتى الآن للتوثيق، وخاصة التوثيق الفني.IMO، مزايا محركات Wiki "الجيدة" مقارنة بمستندات Office في VCS هي (لكنك تدرك ذلك بالفعل نظرًا لأن قائمة الميزات هذه قريبة جدًا من متطلباتك):

• إنها أسرع وأسهل في الاستخدام من مستندات Office في VCS (لا حاجة لفتح عميل VCS، والخروج من الإصدار الأحدث، وقفله اختياريًا، وفتح الكلمة، والحفظ، وتسجيل الوصول، وتحرير القفل)
• إنها تعتمد على النص لذا يمكنك إجراء اختلافات (على عكس الكلمة) وهذا أمر لا بد منه
• أنها توفر آليات الإخطار (على سبيل المثال.البريد، RSS) وبالتالي يتم دفع المعلومات إليك (على عكس VCS حيث تحتاج إلى سحب المستند عندما تكون قديمة)
• لا يوجد "مستند مقفل بسبب مشكلة مستخدم أخرى" لأن شخصًا ما نسي تحريره (إذا كنت تستخدم القفل الحصري وهو ما يحدث غالبًا في المستندات التي لا يمكنك دمجها)
• يمكن إعادة هيكلة الصفحات وإعادة تنظيمها وتجميعها في مستندات أكبر بسهولة
• إنهم متعاونون حقًا
• أنها توفر دعمًا أفضل بكثير للتعليمات البرمجية (على سبيل المثال.يمكنك الإشارة مباشرة إلى الكود المصدري في VCS بتنسيق أفضل بكثير من Word)
• يمكنهم فهرسة محتوى الصفحات والمستندات المرفقة (pdf، مستندات Office، إلخ) وجعلها قابلة للبحث

المشكلة الوحيدة التي واجهتها عند استخدام Wiki للتوثيق هي أنه من الصعب إصدار وثائقك في نفس الوقت الذي يتم فيه إصدار التعليمات البرمجية الخاصة بك (على سبيل المثال.قمت بتسليم الإصدار x.y.z وتريد "قفل" وثائق هذا الإصدار).لقد استخدمت الصادرات لحل هذه المشكلة ولكنها ليست مثالية.

لقد عملت بالفعل مع تويكي فوسويكي, التقاء نهرين و XWiki.إنها جميعًا محركات Wiki "جيدة" (كما هو موضح أعلاه) وجميعها تلبي متطلباتك.لذا فإن الاختيار النهائي قد يعتمد فقط على القيود الخاصة بك (الترخيص، والتسعير، والتكنولوجيا) والتفضيلات الشخصية.

اعتبارًا من اليوم، سأختار Confluence إذا كانت الأداة التجارية خيارًا، أو XWiki إذا لم يكن الأمر كذلك.

Answer 2

هناك فكرة أكثر خارج الجدار وهي النظر فيها فيتنس.إنها ويكي، تهدف في المقام الأول إلى وصف قواعد العمل (أو متطلبات القبول) كاختبارات.

Answer 3

أنا أقوم بتطوير واحدة.

منذ حوالي عام، بحثت عن برامج إدارة المتطلبات على الشبكة ووجدت ما لا يقل عن 30 منها، في ثلاث فئات تقريبًا:

• لا تقدر بثمن (وتسويقها على سبيل المثال.في شركات الطيران)

• باهظة الثمن (على سبيل المثال.1000 دولار لكل مقعد)، وهو الأمر الذي لم يختار أصحاب العمل استخدامه مطلقًا

• رخيصة أو مجانية، ولكن الميزات المفقودة التي تبدو لي مهمة

هناك أيضًا أدوات للأغراض العامة (على سبيل المثال.Wiki، أو رسائل البريد الإلكتروني ومستندات Word و/أو جداول البيانات)، والتي تفتقد أيضًا إلى الميزات التي تبدو مهمة بالنسبة لي.

---

أعتقد أنه يجب عليك توضيح ما يلي:"تفتقد الميزات التي تبدو لي مهمة".

هناك أشياء أنت يستطيع افعل مع Wiki للأغراض العامة:

• إنشاء قائمة من الميزات
• وصف كل ميزة (ربما صفحة/قسم منفصل لكل ميزة)
• القيام بذلك بشكل تعاوني (التحكم في الإصدار، إشعارات التحديث، صفحات المناقشة)

لكن، هناك بعض الأشياء التي أعتقد أنه لا يمكنك فعلها باستخدام ويكي للأغراض العامة، حتى الأشياء الأساسية:

• تحديد السمات المخصصة (على سبيل المثال."تاريخ البدء"، "التكلفة المقدرة"، وما إلى ذلك)؛ربط قيم السمات هذه بميزاتك؛سرد الميزات (في جدول أو شبكة) مع سماتها (بحيث يمكن فرزها، على سبيل المثال.مرتبة حسب "الأهمية" أو حسب "الصعوبة")

• المساعدة في إمكانية التتبع (إمكانية التتبع ليست صعبة للغاية عندما يكون هناك مرحلتين فقط، على سبيل المثال."المتطلبات" و"التنفيذ"؛ولكن يكون الأمر أكثر صعوبة عندما يكون هناك عدة مراحل، على سبيل المثال."حالات الاستخدام"، و"المواصفات الوظيفية"، و"الهندسة المعمارية"، و"تفاصيل التنفيذ"، و"حالات الاختبار"، و"نتائج الاختبار"، و"تقارير الأخطاء")

• دعم المعلومات المنظمة، أي.الأقسام الفرعية وليس فقط أقسام المستوى الأعلى.

حتى مجرد التحرير ليس بالأمر الجميل كما ينبغي.قد يفضل رجال الأعمال استخدام واجهة مستخدم MS Word للتحرير:لكن برنامج MS Word ينتج مستندات، على سبيل المثال."صوامع المعلومات"؛ولكن إذا كنت لا تستخدم MS Word، فأنت تستخدم ماذا؟محرر WYSIWYG داخل المتصفح؟أو بناء الجملة تخفيض السعر؟

Answer 4

أحب استخدام ميزة Wiki المضمنة في FogBugz لهذا الغرض، على افتراض أنك تستخدمها بالفعل لتتبع الميزات/الأخطاء.من السهل الحصول على هذه المعلومات في نفس الأداة.

Answer 5

دروبال يلبي متطلباتك المدرجة، وهو قابل للتوسعة بدرجة كبيرة مع الكثير من الوحدات (انظر بعضها أدناه) وهو متاح تحت رخصة GPL.

• محرر ويسيويغ
• عرض الفرق
• الاشتراكات
• إدارة وصول المستخدم
• إدارة المرفقات
• يمكن تهيئتها باستخدام وظيفة Wiki

Answer 6

لقد استخدمنا JIRA في مشروع سابق لتخزين حوالي 750 قاعدة عمل مختلفة.JIRA هي في الغالب أداة لتتبع الأخطاء، ولكنها قوية جدًا وقابلة للتخصيص بحيث يمكنك استخدامها لجميع أنواع مواقف سير العمل/العملية/قاعدة المعرفة. (راجع للشغل - أنا لا أعمل في الشركة التي تنتجه).

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

بعض النصائح إذا قررت السير في هذا الطريق..

• استفد من معرفات JIRA القابلة للتخصيص في مكان آخر للإشارة إلى القاعدة، على سبيل المثال.ميبرج-334
• احصل على إرشادات واضحة حول ما تعنيه الحالات التي تخطط لاستخدامها، والمقترحة، والموافقة عليها، والمنفذة، والتحقق منها، والسقطة.
• التعريف الوحيد للقاعدة موجود في الوصف - جميع التعليقات هي مجرد تعليقات
• يمكنك ربط القاعدة بحالات الاستخدام والمكونات مهما كانت

إنه نهج رائع وأوصي به حقًا.