الوثائق الفنية
الوثائق التقنية هي مصطلح عام لفئات المعلومات التي يتم إنشاؤها لوصف ( باللغة التقنية ) استخدام أو وظائف أو بنية منتج أو نظام أو خدمة .
أنواع الوثائق التقنية
قد تشمل أنواع الوثائق التقنية ما يلي:
- براءات الاختراع
- مواصفات المنتج أو المكونات/المواد
- بيانات المنتج أو مكوناته/مواده
- أساليب الاختبار
- معايير التصنيع
- متطلبات النظام
- بنية النظام
- وثائق وبيانات تصميم النظام ، بما في ذلك تلك اللازمة لتطوير النظام واختباره وتصنيعه وتشغيله وصيانته.
توحيد الوثائق الفنية
تاريخيًا، افتقرت معظم أنواع الوثائق التقنية إلى معايير موحدة (معيارية) فيما يتعلق بالتنسيق والمحتوى والبنية. ويجري حاليًا تطوير معايير لمعالجة هذا النقص من خلال هيئات مثل المنظمة الدولية للتوحيد القياسي (ISO)، التي نشرت معايير تتعلق بقواعد إعداد أدلة المستخدم، والكتيبات، ومواصفات المنتجات، وما إلى ذلك، للوثائق التقنية للمنتجات. وتغطي هذه المعايير معيار ICS 01.110. [ 1 ] أما الوثائق التقنية للمنتجات التي لا يغطيها معيار ICS 01.110، فهي مدرجة في القسم الفرعي أدناه.
تخصصي
لائحة الاتحاد الأوروبي للأجهزة الطبية
يُشترط أيضاً وجود وثائق فنية للأجهزة الطبية وفقاً للوائح الاتحاد الأوروبي الخاصة بالأجهزة الطبية . ويصف الملحق الثاني، "الوثائق الفنية"، والملحق الثالث، "الوثائق الفنية المتعلقة بمراقبة ما بعد التسويق"، من هذه اللوائح، محتوى الوثائق الفنية للأجهزة الطبية . ويشمل ذلك، على سبيل المثال، معلومات حول مواصفات الجهاز، والملصقات، والتعليمات، والتصميم والتصنيع، ومتطلبات السلامة والأداء، وإدارة المخاطر، والتحقق من صحة الجهاز، بما في ذلك التقييم السريري؛ بالإضافة إلى معلومات من مراقبة ما بعد التسويق .
تنسيقات بيانات المصدر
بنية التوثيق وأنواعها
تهتم بعض أنظمة التوثيق بالأنواع أو الأشكال العامة للوثائق التي تشكل مجموعة وثائق، وكذلك (أو بدلاً من) كيفية إنتاج الوثائق أو نشرها أو تنسيقها.
على سبيل المثال، يُقدّم إطار عمل Diátaxis (المستخدم في الغالب في مجال توثيق البرمجيات [ 8 ] ) أربعة أشكال توثيق متميزة، تُقابل أربع احتياجات مختلفة للمستخدم: الدروس التعليمية ، وأدلة الاستخدام ، والمراجع ، والشروحات . [ 9 ] في المقابل، يُؤكد DITA على خمسة أنواع مختلفة من "المواضيع": المهمة ، والمفهوم ، والمرجع ، ومدخلات المُعجم ، واستكشاف الأخطاء وإصلاحها ، بينما يستخدم نظام التوثيق المعياري من RedHat ثلاثة "وحدات": المفهوم ، والإجراء ، والمرجع . [ 10 ]
انظر أيضاً
الاقتباسات
- ↑ "01.110: الوثائق الفنية للمنتج" . المنظمة الدولية للتوحيد القياسي . تم الاطلاع عليه بتاريخ 10 يونيو 2009 .
- ↑ "ISO 15787:2001 وثائق المنتج الفنية - الأجزاء الحديدية المعالجة حرارياً - العرض والاستخدامات" . المنظمة الدولية للتوحيد القياسي . تم الاطلاع عليه بتاريخ 10 يونيو 2009 .
- ↑ "ISO 3098-0:1997 وثائق المنتج الفنية - الكتابة - الجزء 0: المتطلبات العامة" . المنظمة الدولية للتوحيد القياسي . تم الاطلاع عليه بتاريخ 10 يونيو 2009 .
- ↑ "ISO 10209-1:1992 وثائق المنتج الفنية - المصطلحات - الجزء 1: المصطلحات المتعلقة بالرسومات الفنية: عامة وأنواع الرسومات" . المنظمة الدولية للتوحيد القياسي . تم الاطلاع عليه بتاريخ 10 يونيو 2009 .
- ↑ "ISO 2162-1:1993 وثائق المنتج التقنية - النوابض - الجزء 1: التمثيل المبسط" . المنظمة الدولية للتوحيد القياسي . تم الاطلاع عليه بتاريخ 10 يونيو 2009 .
- ↑ "ISO 5457:1999 وثائق المنتج الفنية - أحجام وتخطيط أوراق الرسم" . المنظمة الدولية للتوحيد القياسي . تم الاطلاع عليه بتاريخ 10 يونيو 2009 .
- ↑ وثائق المنتج الفنية ISO6433 . مراجع الأجزاء ، المعايير البريطانية BSI، doi : 10.3403/30203812 ، hdl : 20.500.12259/288139 ، تاريخ الاسترجاع : 16 ديسمبر 2020
- ↑ "قائمة جزئية لمجموعات وثائق Diátaxis" . تم الاطلاع عليها بتاريخ 10 أبريل 2021 .
- ↑ "مخطط نماذج توثيق دياتاكسيس" . مؤرشف من الأصل في 16 أبريل 2021. تم الاطلاع عليه في 10 أبريل 2021 .
- ↑ "مصطلحات وتعريفات التوثيق المعياري لـ RedHat" . تم الاطلاع عليه بتاريخ 11 أبريل 2021 .
- وثائق
- الاتصالات التقنية
