אם הואשמת בכתיבת מסמך שאמור להורות למישהו אחר כיצד לעשות משהו, הדרך של היום לעשות זאת פחות או יותר זורקת את השיטות הישנות מהחלון.
1. כותרות בומבסטיות גדולות
תבחין שהכותרות ב- PCMech, כמו זה שממש מעל המשפט הזה, ענקיות. הסיבה לכך היא שקל יותר לראות, לקרוא ולדעת היכן אתה נמצא במסמך.
2. פחות מילים
דרך הלא נכונה:
התיעוד הבא מסביר כיצד להשתמש ולהפעיל את פאני ווקר 2000.
דרך נכונה:
הוראות לשימוש בפאני ווקר 2000
זכרו תמיד את המשפט הזה בעת כתיבת תיעוד: קבלו לנקודה כמה שיותר מהר.
3. דלג על אזכורים חסרי תועלת
אם הפניה לא קשורה להוראות הליבה של מה שאתה מנסה לתאר, כגון:
למידע נוסף על טווידלר הפת של פאני ווקר 2000, עיין במסמך FU, סעיף משנה ID10T.
… אל תעשה את זה.
4. תאריך אותו. תמיד.
התאריך שבו נכתב התיעוד צריך להיות באזור הכותרת התחתונה של כל עמוד. אם זהו מסמך אלקטרוני, התאריך מוצג פעמיים. פעם בהתחלה, פעם בסוף.
אתה יכול לכתוב את זה כ"עדכון אחרון (הכנס תאריך כאן) ".
5. תמיד יש לפרסם אזהרות לפני נקודת האל-חזור
אם יש בתיעוד שלך משהו שעלול לפגוע / להרוס / לבטל משהו אם יבוצע בצורה לא נכונה, יש להציב מידע זה ישירות לאחר ההנחיה האמורה, להיות באופק ברור (כלומר באותו עמוד) ולהביע מבטא.
דוגמא:
שלב 5. ניקוי פאני ווקר 2000
יש לנקות את השמשות של FW2000 בעדינות בעזרת מטלית רכה שאינה שוחקת.
אזהרה: השתמש אך ורק בממס נטול אמוניה בכדי למנוע את התפוצצות FW2000 וכתוצאה מכך למוות שלך בטרם עת.
בנימה סופית, תיעוד טוב לא נובע מלהיות סופר-תיאורי לגבי כל דבר אפשרי שאפשר להעלות על הדעת. קרא את התיעוד ושאל את עצמך, האם זה מורה כמו שצריך? אם התשובה היא כן, השאלה הבאה היא האם היא מורה במהירות ? אם כן, התיעוד טוב.
