إذا تم تكليفك بكتابة مستند من المفترض أن يرشد شخصًا آخر لكيفية القيام بشيء ما ، فإن طريقة اليوم للقيام بذلك أكثر أو أقل تطرح الطرق القديمة خارج النافذة.

1. رؤوس المتفجرات الكبيرة

ستلاحظ أن الرؤوس على PCMech ، مثل تلك الموجودة فوق هذه الجملة ، ضخمة. هذا لأنه يسهل عليك رؤية وقراءة ومعرفة مكانك في المستند.

2. كلمات أقل

طريقة خاطئة:

توضح الوثائق التالية كيفية استخدام وتشغيل Fanny Whacker 2000.

طريق صحيح:

إرشادات حول كيفية استخدام Fanny Whacker 2000

تذكر دائمًا هذه العبارة عند كتابة التوثيق: انتقل إلى النقطة بأسرع ما يمكن.

3. تخطي المراجع عديمة الفائدة

إذا كان المرجع لا علاقة له بالتعليمات الأساسية لما تحاول وصفه ، مثل:

لمزيد من المعلومات حول Turnip Twaddler من Fanny Whacker 2000 ، يرجى الاطلاع على الوثيقة FU ، القسم الفرعي ID10T.

... لا تفعل ذلك.

4. تاريخه. دائما.

يجب أن يكون تاريخ كتابة الوثائق في منطقة التذييل لكل صفحة. إذا كان مستندًا إلكترونيًا ، فسيتم عرض التاريخ مرتين. مرة في البداية ، مرة في النهاية.

يمكنك كتابة هذا كـ "آخر مراجعة (أدخل التاريخ هنا)".

5. يجب دائمًا نشر التحذيرات قبل نقطة اللاعودة

إذا كان هناك شيء ما في وثائقك يمكن أن يؤدي إلى إتلاف / تدمير / طمس شيء ما إذا تم تنفيذه بشكل غير صحيح ، فيجب وضع هذه المعلومات مباشرة بعد التعليمات المذكورة ، وأن تكون في مرأى من الجميع (بمعنى في نفس الصفحة) وتكون معلمة.

مثال:

الخطوة 5. تنظيف Fanny Whacker 2000 يجب تنظيف المجاذيف في FW2000 برفق باستخدام قطعة قماش ناعمة غير كاشطة. تحذير: استخدم فقط مذيبًا خالٍ من الأمونيا لمنع FW2000 من الانفجار مما يؤدي إلى موتك المفاجئ.

في ملاحظة أخيرة ، لا يعد التوثيق الجيد من الوصف الفائق لكل شيء ممكن يمكن تخيله. اقرأ وثائقك واسأل نفسك ، هل هي تعليمات بشكل صحيح؟ إذا كان الجواب نعم ، فإن السؤال التالي هو ، هل يوجه بسرعة؟ إذا كانت الإجابة بنعم ، فإن الوثائق جيدة.