العنوان: هل تحافظ على وثائقك بشكل صحيح؟
المؤلف: مايك هايدن
source_url: http://www.articlecity.com/articles/business_and_finance/article_2054.shtml
date_saved: 2007-07-25 12:30:06
التصنيف: business_and_finance
مقالة - سلعة:
كما قلت في العديد من مواقع eZines ، يجب عليك كتابة الأشياء.
في ذلك اليوم ، سأل أحد المحاورين ،
"كم عدد الصفحات التي كتبتها؟"
"تم تسليم حوالي 30000 صفحة في مكان ما ، بدون تضمين آلاف من مسودات الصفحات."
"يجب أن تحب الكتابة!"
"ليس صحيحا."
"ثم ماذا...؟"
"أنا لا أحب الكتابة في حد ذاتها. أنا أحب التطبيقات. أحب النتائج. في الكتابة ، يمكنك إنشاء ، دعنا نقول ، المستوى الأول من الواقع. من خلال الكتابة ، يمكنك البدء في تقديم الأفكار غير الملموسة في الشكل المادي كون.
"هل يمكنك أن تتخيل عدد الأشخاص الذين اكتشفوا سر الحريق ولم يكتبوه؟ كان يجب أن تنتشر الأخبار عن طريق" المعرفة القبلية! "
"كم مرة اختفى السر لأن مبتدئ النار اختنق نفسه وعائلته؟ كم مرة تعتقد أن بعض الفاعلين منعوا النار بسبب أخطارها؟
"ربما استغرق الأمر دهورًا لاكتشاف هذا السر - مرارًا وتكرارًا!
"في النهاية ، على ما أعتقد ، كتب أحدهم السر على جدار كهف أو منديل كوكتيل ..."
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
"التخطيط للكتابة ليس الكتابة. تحديد ... البحث ... التحدث إلى الناس حول ما تفعله ، لا شيء من هذا يكتب. الكتابة هي الكتابة." - إل. دكتورو
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
على أي حال ، عند تدوين الأشياء ، ستحتاج في النهاية إلى تحديثها. (سأتحدث هنا عن المستندات الكبيرة والمهمة - كتيبات التشغيل ، والكتيبات الفنية ، وأدلة المستخدم ، أو ربما سر الحريق وكيفية التحكم فيه.)
"مايك ، ما الذي تعلمته على مر السنين حول الحفاظ على الوثائق؟"
حسنًا ، مشاريع التوثيق الكبيرة لها "دورة حياتها" الخاصة بها. تمتد هذه الدورة من الحمل إلى التقادم.
عند تطوير مستندات كبيرة الحجم ، ستقوم عادةً بالتكرار من خلال ما يلي:
1. المتطلبات.
يتضمن التعريف وبيان الأهداف والتحليل الأولي والمواصفات الوظيفية وقيود التصميم.
2. التصميم.
يتضمن تعريف المخطط التفصيلي ، تعريف التنسيق ، إلخ.
3. التنفيذ.
يتطلب الكتابة والتحرير ودمج المكونات المختلفة والتدقيق.
4. الاختبار.
يشمل التحقق والتقييم مقابل المتطلبات.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
لكن انتظر! هناك مرحلة أخرى أسميها صيانة التوثيق! يبدأ بعد تسليم الوثائق الخاصة بك إلى المستخدم الخاص بك.
يمكنك تقسيم صيانة الوثائق إلى الخطوات التالية:
تحديد الحاجة للتغيير
إرسال طلب التغيير
مراجعة التغييرات المقترحة
تحليل المتطلبات
قبول / رفض طلب التغيير
جدولة المهمة (المهام)
مراجعة وتحليل التصميم
اكتب وتحرير
اختبار
تحقق مقابل المعايير
قبول المستخدم
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
في هذه الخطوات ، أوجز عملية الصيانة ، التي تبدأ عندما يحتاج شخص ما إلى تغيير وتنتهي عندما يقبل المستخدم تغييراتك.
كما يمكنك أن تتخيل ، غالبًا ما يكون تغيير الوثائق معقدًا وقد يشمل العديد من الأشخاص.
على سبيل المثال ، تخيل مهمة تحديث الوثائق للتطبيقات في الإلكترونيات المعقدة ، والفضاء ، والقانون ، والطب ، والتأمين ، وما إلى ذلك. أو ماذا عن تحديث دليل إعداد الرحلة لطائرة تجارية؟
تبدو عملية الصيانة أعلاه خطية. لكن مرة أخرى ، ستخضع للعديد من الخطوات والحلقات التكرارية.
علي سبيل المثال،
قد تحتاج إلى توضيح طلب التغيير. قد تحتاج إلى مزيد من التحليل لمراجعات التصميم. قد تحتاج إلى إعادة كتابة تدقيق المعايير الخاص بك. قد يفشل المستخدمون في قبول النتائج وما إلى ذلك.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
شخص ما ، "المشرف (الصيانة)" يجب أن يقوم بالعمل.
يجب أن يقوم المشرف بإجراء تغييرات في سياق الوثائق الحالية. غالبًا ما يجد العاملون في الصيانة هذه المشكلة الأكثر تحديًا.
كلما كانت الوثائق أقدم ، زادت صعوبة جهود الصيانة واستهلاكها للوقت. لكن في العادة ، تستغرق الصيانة وقتًا أقل من التطوير.
قد تمتد جهود التطوير الخاصة بك إلى عدة أشهر. يمكنك جدولة الصيانة المثالية في دورات من شهر إلى ستة أشهر. ولكن ، قد تحتاج إلى صيانة تصحيحية في غضون ساعات.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
من الناحية الوظيفية ، يمكنك تقسيم أنشطة صيانة الوثائق إلى ثلاث فئات:
مكتمل،
التكيف ، و
تصحيحية.
دعني أوضح...
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
صيانة مثالية
"الصيانة المثالية" هي عندما تقوم بإجراء تغييرات وإدخالات وحذف وتعديلات وإضافات وتحسينات لتحسين إمكانية الفهم أو الصيانة.
عادةً ما تقوم بإجراء صيانة مثالية لأن لديك متطلبات جديدة أو متغيرة ، أو قد تحتاج إلى ضبط الوثائق.
يعد الضبط الدقيق وسيلة ممتازة لتعريف كاتب جديد بوثائقك. سيؤدي هذا إلى تقليل فرصتك في حدوث أخطاء جسيمة لاحقًا.
تتطلب كل من حالات الفشل والنجاح في المستندات الخاصة بك صيانة مثالية. إذا كان المستند الخاص بك