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