כיצד מתאר טכני מסמכים כתיבה. מסמך כתוב היטב אינו נוצר במקרה. החומר המכוסה בדוח, מסמך ידני או טכני אחר מתוכנן, מאורגן ולאחר מכן נכתב. השלב המתאר של מסמך הוא צעד מפתח, רוב הסיכויים שהמידע לא יוצג בצורה הגיונית אם מתאר לא נוצר. Outlining נותן המחבר הזדמנות לחשוב על המידע שצריך ולא צריך להיכלל.
סיעור מוחות הרעיונות שלך. כתוב את כל הרעיונות שלך מתאר כי אתה חושב צריך להיכלל במסמך הטכני. אל תהיה מודאג עם סדר המידע. זה פשוט משנה כי כל המידע נכלל בתהליך סיעור מוחות.
לקבוע את מטרת המסמך הטכני. שאל את עצמך שאלות כגון מי יהיה לקרוא את המסמך, למה זה יהיה לקרוא ואיך זה יהיה בשימוש.
להחליט איזה סוג של מתאר אתה רוצה ליצור: היסטורי, כרונולוגי, ספציפי בכלל, קטן עד גדול, פשוט מורכבים או כל צורה אחרת המתאימה לתוכן. תחשוב על הקהל ועל המידע שאתה רוצה להציג. ודא כי הדרך שבה המידע מסודר הגיוני ביותר לסוג המידע המוצג ולקהל זה יהיה לקרוא את המסמך הטכני.
סדר את המידע בסדר המתאים. מתאר מתאר את קיבוץ המידע לרצפים לוגיים ולרמות לוגיות. ניתן ליצור נושאים ותת-נושאים עיקריים ותת-נושאים.
סיים את המתאר על ידי סקירת המידע כדי לוודא כי הנושאים מאורגנים בצורה הולמת והגיוני. ודא כי אתה לא חסר כל עובדות מפתח. מחק כל מידע שאינו רלוונטי למסמך הטכני.
