إذا تم تكليفك بكتابة مستند من المفترض أن يعلم شخصًا آخر كيفية القيام بشيء ما ، فإن طريقة القيام بذلك اليوم تقذف بالطرق القديمة أكثر أو أقل من النافذة.
1. رؤوس الرؤوس الكبيرة
ستلاحظ أن الرؤوس على PCMech ، مثل العنوان الموجود أعلى هذه الجملة ، ضخمة. هذا لأنه من الأسهل رؤية وقراءة ومعرفة مكان وجودك في المستند.
2. أقل الكلمات
طريقة خاطئة:
تشرح الوثائق التالية كيفية استخدام Fanny Whacker 2000 وتشغيله.
طريق صحيح:
تعليمات حول كيفية استخدام Fanny Whacker 2000
تذكر دائمًا هذه العبارة عند كتابة الوثائق: الوصول إلى النقطة بأسرع ما يمكن.
3. تخطي المراجع عديمة الفائدة
إذا كانت الإشارة لا علاقة لها بالتعليمات الأساسية لما تحاول وصفه ، مثل:
لمزيد من المعلومات حول Turnip Twaddler لـ Fanny Whacker 2000 ، الرجاء مراجعة المستند FU ، القسم الفرعي ID10T.
لا تفعل ذلك.
4. تاريخه. دائما.
يجب أن يكون تاريخ كتابة الوثائق في منطقة تذييل الصفحة في كل صفحة. إذا كان مستندًا إلكترونيًا ، فسيظهر التاريخ مرتين. مرة واحدة في البداية ، مرة واحدة في النهاية.
يمكنك كتابة هذا كـ "تاريخ آخر مراجعة (أدخل التاريخ هنا)".
5. يجب دائمًا نشر التحذيرات قبل نقطة اللاعودة
إذا كان هناك شيء ما في مستنداتك قد يؤدي إلى إتلاف / تدمير / طمس شيء ما إذا تم تنفيذه بطريقة غير صحيحة ، فيجب وضع هذه المعلومات مباشرة بعد الإرشادات المذكورة ، وتكون في مرأى من الجميع (بمعنى في نفس الصفحة) ويتم تمييزها.
مثال:
الخطوة 5. تنظيف فاني واكر 2000
يجب تنظيف مجاذيف FW2000 بلطف باستخدام قطعة قماش ناعمة غير كاشطة.
تحذير: لا تستخدم سوى المذيبات الخالية من الأمونيا لمنع انفجار FW2000 مما يؤدي إلى وفاتك المبكرة.
في ملاحظة أخيرة ، التوثيق الجيد ليس من كونه وصفيًا فائقًا عن كل شيء ممكن يمكن تخيله. اقرأ مستنداتك واسأل نفسك ، هل هي تعليمات صحيحة؟ إذا كانت الإجابة "نعم" ، فإن السؤال التالي هو ، هل يوجهك بسرعة ؟ إذا كانت الإجابة بنعم ، فإن الوثائق جيدة.
