תיעוד טכני, כתיבה טכנית

תיעוד וכתיבה טכנית מהווים כיום כ- 40% מהיקף פעילותינו כחברה. אנו מומחים במתן שירותי תיעוד וכתיבה טכנית למערכות, מוצרים וטכנולוגיות. 

מחלקת התיעוד והכתיבה הטכנית שלנו עוסקת בפיתוח של מגוון פתרונות בתחום התיעוד הטכני והכתיבה הטכנית:

  • ספרות אלקטרונית, עזרה מקוונות (eDcos, Online Help)
  • ספרי מערכת (System Manuals)
  • ספרי אחזקה (Maintenance Manuals)
  • ספרי תפעול (Operation Manuals)
  • ספרי משתמש (User Guides)
  • תיעוד תוכנה, API's, SDK's
  • כתיבה שיווקית (Marcom)
tiud-techni
ספרות אלקטרונית
15%
ספרי מערכת (System Manuals)
10%
ספרי אחזקה (Maintenance Manuals)
30%
ספרי תפעול (Operation Manuals)
30%
ספרי משתמש (User Guides)
15%

ספרות אלקטרונית, עזרה מקוונות (IETM, eDcos, Online Help)

Single Source Authoring   איכותי ואפקטיבי. חליפת ה- XML הייחודית של גלילי מאפשרת לייצר ספרות אלקטרונית מקצועית, חכמה ונקייה, כולל: אתרי תוכן ב HTML5, EPUB3, EBOOKS  וכמובן IETM & Online Help בפורמטים שונים כגון WebHelp, WebHelp Plus, HTML Help, DOTNet Help, DITA ו- WebHelp Mobile. כל הפתרונות מותאמים להצגה ONLINE, במחשבים שולחניים (Desktop) ובכל ציוד נייד – כולל iPads ומכשירי Android.

ספרי מערכת (System Manuals)
כוללים תיאור מפורט ומלא של המערכת בהיבטים שונים וכן תיאור מפורט ומלא של החומרה והתוכנה של המערכת ועקרונות הפעולה, הממשקים והרכיבים הפנימיים. לרוב נכתבת הספרות בשיתוף מלא עם מהנדסי החומרה והתוכנה של המערכת עבור מהנדסים של לקוח הקצה.

ספרי אחזקה (Maintenance Manuals)
ביצועי המערכת לאורך זמן וזמינותה נקבעים במידה רבה ע”י מקצועיות המאחזקים, זו נגזרת מאיכות הספרות הטכנית שמדריכה בביצוע המטלות וכן בהכשרה המקצועית המבוססת על ספרים אלו. ספרות האחזקה מותאמת לדרגים השונים המאחזקים את המערכת ומכוונים לתרחיש הביצוע של כל מאחזק על המערכת. הספרות נכתבת בדרך כלל למספר דרגי אחזקה שונים:
דרג מפעיל-  אחזקה קלה בשדה ע”י מפעילי המערכת.
דרג א-  אחזקה בשדה ,על גבי המערכת הפרוסה להחלפת מכלולי מדף, ביצוע כיולים שונים, בדיקות מערכת.
דרג ב-  אחזקה במעבדה, על גבי מכלולים, ביצוע כיולים שונים, בדיקות והחלפת רכיבים.
דרג ג-  אחזקה ע”י היצרן או אנשי אחזקה בדרג ג ‘ במעבדות, עד לרמת רכיב בכרטיס.

ספרי תפעול (Operation Manuals)
ביצועי המערכת נקבעים ע”י מפעילים מיומנים ומקצועיים. ספרות ההפעלה מכילה תיאור רלוונטי של המערכת בהיבט תפעולי של המפעיל ומובילה את המפעיל צעד-אחר-צעד במכלול הפעולות הנדרשות לביצוע בליווי תמונות, תרשימים ואיורים להבנה טובה יותר של החומר.

ספרי משתמש (User Guides)
ספרות צריכה לעיתים לשקף מאפיינים בולטים של מערכת, כגון פשטות תפעולית. ספרי המשתמש בנויים בדומה לספרי התפעול המקיפים, אך עם תיאורים קצרים, פשוטים ומוטי ביצוע. לגלילי ניסיון רב ומוכח בפיתוח ייחודי של ספרי משתמש לתחום התוכנה, Cyber ומערכות שליטה ובקרה.

ספרי התקנה (Installation Guides)
ספרות ההתקנה מיועדת למתקין המערכת / תוכנה וכוללת את כלל המידע הנדרש לתהליך ייעודי זה, כגון – התקנת תוכנה, עדכונים, הגדרות לינוקס, פריסה בארכיטקטורות רשת שונות, שחזור מערכת וכדומה. סגנון הכתיבה ייחודי ומותאמים למאפייני המשתמש, שלרוב הינו מומחה בתחום (לדוגמא System Administrator).

תיעוד תוכנה, API's, SDK's 
תיעוד של תוכנת המערכת, החל מתיעוד תוכנה עבור משתמש קצה ועד לתיעוד תוכנה לצוותי הפיתוח והתוכניתנים:
תיעוד תוכנה לרמת המשתמש – לצורך תפעול התוכנה המותקנת, בדרך כלל מפותח כמוכוון ביצוע וכולל תיאור של ממשקי המשתמש וכן תיאור תהליכי העבודה. בדרך כלל מומרת ספרות זו לספרות אלקטרונית.
SDK – תיעוד תוכנה המוכוון לצוותי פיתוח, כולל תיאור והסברים כיצד להשתמש בפונקציות, ברכיבי הקישור, במהדרים, בתוכנת התמיכה ובספריות השונים על מנת לתמוך בפיתוח מיטבי.
API – תיעוד תוכנה המוכוון לצוותי פיתוח, כולל תיאור והסברים כיצד לעשות שימוש בפונקציות השונות (המתוארות ב- SDK) לצורך בניית היישום הנדרש.

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