כתיבה טכנית – הבדלי גרסאות

תוכן שנמחק תוכן שנוסף
←‏פתיח: הרחבה
שורה 4:
ניתן להבדיל בין שני סוגי תיעוד עיקריים:
* תיעוד למשתמש הקצה כגון [[מדריך למשתמש|מדריכים למשתמש]] למכשירים ומוצרים שונים, עזרה מקוונת (Online help), [[ספר לבן|ספרים לבנים עסקיים]] ו[[הדרכה|מדריכי]] הרכבה, טיפול ותחזוקה. בתיעוד מן הסוג הזה משמש הכתב הטכני כ"מתרגם" של שפה טכנית לשפת היום-יום, המובנת גם על ידי הצרכנים, שאינם בעלי ידע בפיתוח המוצר אותו רכשו. מדריכי הרכבה, טיפול ותחזוקה משמשים [[טכנאי]]ם בעת טיפול שוטף ותיקון של מכשירים ומערכות.
* תיעוד פנימי בתוך חברה, לרוב נלווה לפיתוח המוצר, כגון מפרטי תכונות בתוכנה ובחומרה. תיעוד מן הסוג הזה משרת [[מהנדס]]ים, טכנאים ו[[מתכנת]]ים מצד אחד בפיתוח המוצר שלהם, כאשר המפרטים מגדירים את מהות המוצר ויכולותיו. מצד שני, משרתים המפרטים את עובדי [[בקרת איכות|בקרת האיכות]], כאשר הם משווים בין המוצר בפועל לבין המוצר כפי שהוגדר בתיעוד.
 
תיעוד מן הסוג הזה משרת [[מהנדס]]ים, טכנאים ו[[מתכנת]]ים מצד אחד בפיתוח המוצר שלהם, כאשר המפרטים מגדירים את מהות המוצר ויכולותיו. מצד שני, משרתים המפרטים את עובדי [[בקרת איכות|בקרת האיכות]], כאשר הם משווים בין המוצר בפועל לבין המוצר כפי שהוגדר בתיעוד.
== תעשיות ==
תיעוד טכני נפוץ בתעשיות שונות, ביניהן: