Requirements Document
A precise, testable specification of functional and non-functional requirements, each a single verifiable statement with a stable ID, plus acceptance criteria, constraints and scope..
ما هي وثيقة المتطلبات فعليًا
وثيقة المتطلبات هي العقد بين النية والبناء. تُصرّح، بجمل واحدة قابلة للتحقق، بما يجب أن يفعله النظام والخصائص التي يجب أن يستوفيها، بحيث يعمل المصممون والمهندسون وأصحاب المصلحة من تعريف واحد مشترك بدلًا من نقاش عابر.
يحمل كل متطلب معرّفًا ثابتًا وقابلًا للاختبار بمفرده. تتيح هذه البنية ربط معايير القبول بأسطر محددة، وتتيح للمراجعين الاعتماد على قائمة معروفة، وتمنع انحراف النطاق بعد بدء العمل.
عند صياغتها جيدًا، تكون قصيرة القراءة لكنها دقيقة التطبيق. تفصل السلوك الوظيفي عن الخصائص غير الوظيفية مثل الأداء والأمان، وتُسجّل الافتراضات والقيود، وتُسمّي ما هو خارج النطاق عن قصد.
تشريح وثيقة المتطلبات
النظرة العامة والأهداف
وضّح سبب وجود النظام وكيف يبدو النجاح. هذا يؤطر كل متطلب يليه ويمنح المراجعين الهدف الذي يقيَّمون على أساسه.
النطاق والسياق
حدد الحدود والمستخدمين والأنظمة التي يمسّها. الاتفاق على السياق هنا يمنع الجدل لاحقًا حول ما كان مطروحًا أصلًا.
المتطلبات الوظيفية
اسرد ما يجب أن يفعله النظام، كل منها عبارة واحدة قابلة للتحقق بمعرّف ثابت. هذه سلوكيات يمكن للمختبِر تأكيدها أو رفضها دون جدال.
المتطلبات غير الوظيفية
وثّق خصائص مثل الأداء والأمان والموثوقية والتوافر. اكتبها كعتبات قابلة للقياس بحيث يمكن اختبارها لا افتراضها.
معايير القبول
وضّح بالضبط كيف يُتحقق من كل متطلب وما الذي يُعد إنجازًا. هذا هو الخط الفاصل بين ميزة مكتملة ونقاش مستمر.
الافتراضات والقيود
سجّل ما تعتمد عليه المواصفة والحدود التي يجب احترامها، مثل المنصات أو الميزانيات أو المواعيد النهائية. إظهار هذه مبكرًا يمنعها من أن تصبح مفاجآت.
خارج النطاق
سمِّ ما لن يفعله هذا النظام، عن قصد. قائمة الاستثناءات الصريحة هي أرخص دفاع يمكنك كتابته ضد توسع النطاق.
كتابة متطلبات تصمد
Do
- اكتب كل متطلب كعبارة واحدة قابلة للتحقق بمعرّف ثابت بحيث يمكن تتبعه واختباره.
- افصل السلوك الوظيفي عن الخصائص غير الوظيفية مثل الأداء والأمان والموثوقية.
- أرفق معايير قبول بكل متطلب بحيث يتفق الجميع على معنى الإنجاز.
- اذكر الافتراضات والقيود صراحة بحيث تظهر التبعيات قبل البناء لا أثناءه.
- احتفظ بقائمة صريحة لما هو خارج النطاق لإغلاق الباب أمام توسع النطاق قبل بدء العمل.
Avoid
- لا تجمع عدة سلوكيات في متطلب واحد، لأن اختبارًا نصف ناجح لا مكان له.
- لا تكتب أهدافًا غير وظيفية غامضة مثل 'سريع' دون عتبة قابلة للقياس للتحقق منها.
- لا تُعِد استخدام المعرّفات أو تُعيد ترتيبها، فالهدف المتحرك يكسر التتبع والاعتماد.
- لا تترك معايير القبول ضمنية، وإلا أصبح 'الإنجاز' مسألة رأي.
- لا تُغفل قسم ما هو خارج النطاق وتفترض أن الجميع يشاركون الحدود نفسها.
الطريقة القديمة مقابل طريقة waxTable
كيف يُنشئ Waxe وثيقة متطلباتك
- 1
صف النظام
أخبر Waxe بغرض النظام، ومن يستخدمه، والمشكلة التي يحلها. يحوّل Waxe ذلك إلى نظرة عامة وأهداف، محددًا الهدف الذي سيُقيَّم على أساسه كل متطلب.
- 2
حدد الحدود
يصوغ Waxe النطاق والسياق، مسمّيًا المستخدمين والأنظمة المعنية وأين تقع الحدود. كما يكتب قائمة ما هو خارج النطاق بحيث تكون الحدود صريحة قبل أن يبدأ أحد البناء.
- 3
صياغة المتطلبات
يكتب Waxe المتطلبات الوظيفية وغير الوظيفية كعبارات واحدة قابلة للتحقق، كل منها بمعرّف ثابت. يقع السلوك الوظيفي والخصائص مثل الأداء والأمان في أقسامها الخاصة، جاهزة للاختبار.
- 4
إرفاق معايير القبول
لكل متطلب، يصوغ Waxe معايير قبول تحدد بالضبط كيف يُتحقق منه وما الذي يُعد إنجازًا. كما يُسجّل الافتراضات والقيود التي تعتمد عليها المواصفة، بحيث تكون التبعيات موثقة.
- 5
راجع وشارك
تُعدّل أي سطر مباشرة في مساحة العمل، معدّلًا المتطلبات أو المعايير أو النطاق حسب الحاجة. يبقى الترقيم والبنية سليمين، وتشارك وثيقة متطلبات نظيفة ومتوافقة مع هويتك في نحو خمس دقائق بتكلفة بضعة سنتات.
Frequently asked
ما هي وثيقة المتطلبات؟
وثيقة المتطلبات هي مواصفة دقيقة وقابلة للاختبار لما يجب أن يفعله النظام ومدى جودة أدائه. يُكتب كل متطلب وظيفي وغير وظيفي كعبارة واحدة قابلة للتحقق تحمل معرّفًا ثابتًا، بحيث يمكن تتبعه واختباره واعتماده. كما تُوثّق معايير القبول، والافتراضات، والقيود، وقائمة صريحة بما هو خارج النطاق. الهدف ألا يُترك شيء للتأويل بين من يكتب المواصفة ومن يبني وفقها.
ما الذي يتضمنه وثيقة متطلبات قوية؟
تبدأ بنظرة عامة وأهداف، ثم تحدد النطاق والسياق بحيث يتفق الجميع على الحدود. يفصل المتن المتطلبات الوظيفية عن غير الوظيفية مثل الأداء والأمان والموثوقية. تحدد معايير القبول بالضبط كيف يُتحقق من كل متطلب، وتُسجّل الافتراضات والقيود ما تعتمد عليه المواصفة. يُغلق قسم واضح لما هو خارج النطاق الباب أمام توسع النطاق قبل بدء البناء حتى.
لماذا يُعطى كل متطلب معرّفًا ثابتًا؟
المعرّف الثابت يحوّل سطرًا من النص إلى شيء يمكنك الإشارة إليه طوال عمر المشروع. يتيح لاختبار ما الإشارة إلى المتطلب الدقيق الذي يتحقق منه، ويتيح لطلب تغيير تسمية ما يغيره، ويتيح لاعتماد ما تغطية قائمة معروفة. من دون المعرّفات، يتجادل المراجعون حول الجملة التي قصدوها ويصبح القبول تخمينًا. يُخصص waxTable هذه المعرّفات ويحافظ على اتساقها عبر الأقسام الوظيفية وغير الوظيفية بحيث يستمر التتبع من الهدف حتى معيار القبول.
كيف يبني waxTable الوثيقة لمشروعي؟
تُخبر Waxe بغرض النظام ومن يخدم، فيصوغ Waxe وثيقة متطلبات كاملة بنظرة عامة ونطاق ومتطلبات مرقّمة ومعايير قبول. يفصل السلوك الوظيفي عن الخصائص غير الوظيفية ويكتب كل متطلب كعبارة واحدة قابلة للتحقق. تُملأ الافتراضات والقيود وقائمة ما هو خارج النطاق بحيث تكون الحدود صريحة. تستغرق المسودة كاملة نحو خمس دقائق وتكلف بضعة سنتات، ثم تُعدّل أي سطر مباشرة في مساحة العمل.
هل يمكنني تعديل المتطلبات بعد أن يُنشئها Waxe؟
نعم. وثيقة المتطلبات المُنشأة قابلة للتعديل بالكامل داخل مساحة عمل waxTable، وليست ملفًا مُصدَّرًا مقفلًا. يمكنك إعادة كتابة أي متطلب، وإضافة أو حذف معايير قبول، وتعديل حدود النطاق، أو نقل عنصر إلى قسم ما هو خارج النطاق. تحافظ التعديلات على سلامة بنية الوثيقة وتنسيقها، بحيث يبقى الترقيم وترتيب الأقسام نظيفًا. وحين تصبح المواصفة جاهزة، تشاركها كوثيقة منسّقة ومتوافقة مع هويتك.
Skip the writing — generate the whole requirements document
Waxe drafts it on your brand in about five minutes, then you refine it. From two days of work to a few cents.
وثيقة المتطلبات القادم في خمس دقائق
أخبر Waxe بتفاصيل العميل واحصل على وثيقة المتطلبات كامل ومتوافق مع هويتك جاهز للمراجعة — عمل يومين مقابل بضعة سنتات فقط. لا صفحة فارغة تبدأ منها ولا تنسيق يدوي؛ تجيب عن ملخص قصير، وWaxe يتولى الصياغة، وتحتفظ أنت بالتحكم الكامل في المستند النهائي داخل المحرر.