צ'קליסט עבור תיעוד טכני

אם תוכלו לענות כן לכל השאלות הבאות, המדריך שלכם ישאר עדכני ורענן!

האם המדריך מתאר את התהליכים לאחר עדכון הגרסה?
האם התהליכים עובדים? האם צילומי המסך עודכנו כך שהם מציגים את הגרסה העדכנית ביותר?
האם צילומי המסך עודכנו כך שהם מראים את האופציות החדשות הקיימות, פופ-אפים וחלונות נוספים?
במקרים בהם יש אפשרות לגשת לחלונות ביותר מדרך אחת, האם הן מפורטות במלואן בהתחלה של המדריך או בתהליך עצמו?
האם לכל כותרת 2,1 ו-3 יש משפט פתיח שמציג את הנושא שלהן?
• האם יש לכם שדות, סגנונות או כפתורים מעודכנים שעליכם להעתיק מקבצים אחרים על מנת לעדכן את התבנית?
האם המסמך עבר הגהה לשונית?
כמו כן, על מדריכים טכניים להיבדק כמו שהמוצרים שהם מתארים נבדקים: טעויות תיעוד צריכות להתווסף לדו"ח טעויות של מערכת בקרת האיכות תחת Docs.
על צוותי התיעוד והמוצרים לסקור את המידע, בעוד שעל ה QA יופקד לבחון את הדאטה.