توثيق البرمجيات: الفرق بين النسختين

[نسخة منشورة][نسخة منشورة]
تم حذف المحتوى تمت إضافة المحتوى
JarBot (نقاش | مساهمات)
JarBot (نقاش | مساهمات)
ط بوت: إزالة التشكيل
سطر 33:
عند الحديث عن نظم [[قواعد البيانات العلائقية|قواعد البيانات المترابطة]]، يجب أن يتضمن التوثيق ما يلي:
<ul>
<li>[[نموذج كائن-علاقة محسن|مخطط كيان-علاقة]] ([[محسّنمحسن]] وتتضمن المعلومات التالية وتعريفات واضحة لكل منها):
<ul>
<li>مجموعة الكائن وخصائصها
سطر 68:
هناك 3 طرق استخدامها لتنظيم وثائق المستخدم النهائي:
 
1. [[برنامج تعليمي|البرنامج التعليمي]] Tutorial: يعتبر البرنامج التعليمي الأسهل والأكثر إفادة للمستخدمين الجدد، حيث يتم إرشادهم من خلال الخطوات التي يشرحها لإنجاز مهمة معينة<ref name=kdp>{{citeمرجع webويب
| lastالأخير = Woelz
| firstالأول = Carlos
| authorlinkوصلة المؤلف =
| المؤلفين المشاركين =
| coauthors =
| titleالعنوان = The KDE Documentation Primer
| workالعمل =
| publisherالناشر =
| dateالتاريخ =
| urlالمسار = http://i18n.kde.org/docs/doc-primer/index.html
| doi =
| accessdateتاريخ الوصول = 15 June 2009 }}</ref>
 
2. المنهجية الموضوعية Thematic: حيث تركز فصول وأقسام الوثيقة على موضوع محدد فقط، ويستخدم هذا النوع للمستخدمين ذوي المستوى المتوسط. يفضل بعض المؤلفين نقل أفكارهم من خلال المقالات القائمة على المعرفة لتيسير تحقيق احتياجات المستخدم. استخدمت هذه المنهجية عادة من قبل المجالات المعرفية الديناميكية ك[[تكنولوجيا المعلومات]]، حيث يُعنى المستخدمون بصورة أكبر باكتشاف أخطاء ومشكلات البرامج والتعامل معها<ref name=kbad>{{citeمرجع webويب
| lastالأخير = [[مايكروسوفت]]
| firstالأول =
| authorlinkوصلة المؤلف =
| المؤلفين المشاركين =
| coauthors =
| titleالعنوان = Knowledge Base Articles for Driver Development
| workالعمل =
| publisherالناشر =
| dateالتاريخ =
| urlالمسار = http://www.microsoft.com/whdc/driver/kernel/kb-drv.mspx
| doi =
| accessdateتاريخ الوصول = 15 June 2009 }}
</ref>