בדף הזה מפורטים פרטי פרויקט של כתיבה טכנית שאושר להשתתפות בתוכנית Google Season of Docs.
סיכום הפרויקט
- ארגון קוד פתוח:
- TheGoodDocsProject
- כותבים טכניים:
- Loquacity
- שם הפרויקט:
- מדריך לארכיטקטורת מידע
- אורך הפרויקט:
- אורך סטנדרטי (3 חודשים)
תיאור הפרויקט
תוכנית למדריך בנושא ארכיטקטורת מידע
במסמך הזה מוסבר תכנון של מדריך לארכיטקטורת מידע לפרויקט Good Docs. הוא נוצר כחלק מהגשה של Google Season of Docs 2020. הוא מתאר את תרחיש לדוגמה של המדריך המוצע, ומציג תוכנית של המבנה של מדריך כזה, למטרות תכנון.
ארכיטקטורת מידע (IA) היא האופן שבו התוכן מאורגן. הוא מכסה את מבנה התוכן בלי להגדיר את הסגנון או המילים שבתוכן עצמו. לדוגמה, תוכנית UI תכלול מידע על הקוראים, על האופן שבו הם מתקרבים לתוכן ועל הסביבה שבה הם קוראים. לאחר מכן, המערכת תבחן מבנה מתאים לתוכן שיציג בצורה הטובה ביותר את הדרישות האלה של הקוראים.
בעולם מושלם, מסמכי התיעוד מתחילים מאסטרטגיית תוכן, שמבוססת על יעדים עסקיים כדי להגדיר את מטרות התיעוד. לאחר מכן אסטרטגיית התוכן משמשת ליצירת IA, שמגדירה את הפריסה והמבנה של התיעוד. לאחר מכן אפשר לבחור כלי פיתוח ולכתוב תוכן. במציאות, ברוב הפרויקטים בקוד פתוח אסטרטגיית התוכן פשוטה מאוד: "כותבים קצת תיעוד כדי שאנשים ידעו איך להשתמש בפרויקט". אבל גם אסטרטגיה פשוטה כזו מספיקה כדי להגדיר ממשק משתמש יעיל.
מטרת המדריך הזה היא לספק כלי פשוט לכותבים לא מקצועיים, שיאפשר להם לפתח AI שיעזור להם לקבוע באילו תבניות כדאי להם להשתמש. הוא צריך להיות פשוט מספיק כדי שאדם רגיל יוכל להשלים אותו ביום אחד, ועדיף שיתמקד בפעולה ולא בהדרכה. באופן אידיאלי, הוא יציג מושגים בצורה תמציתית, ינחה את הקורא לבחון את המושגים האלה ביחס לפרויקט שלו, וישתמש בתוצאה של כך כדי לעבור למושג הבא.
כחלק מהתשתיות של הפרויקט, נדרשים כמה עדכונים לקובץ README של הפרויקט כדי שהקוראים יבינו איך להתחיל לעבוד עם פרויקט Good Docs, ויוכלו להשתמש במדריך ל-IA בצורה יעילה כדי להנחות אותם בבחירת התבניות.
קהל ראשי
כל מי שרוצה להשתמש בתבניות של The Good Docs Project כדי ליצור מסמכי עזרה לפרויקט שלו
תרחישים לדוגמה: הקטע הזה נועד לבחון את האופן שבו הקוראים מתייחסים למדריך לעיצוב ממשק משתמש. זה יכול לעזור לנו להבין איך כדאי לבנות את המדריך כדי לשרת את הקוראים בצורה הטובה ביותר.
תרחיש: משתמש עובד על פרויקט בקוד פתוח שיש לו מעט מאוד תיעוד או שאין לו תיעוד בכלל, או על חבילת תיעוד שמאורגנת או שכתובה בצורה גרועה. הם מחליטים להשתמש בפרויקט Good Docs כדי לארגן את המסמכים שלהם, אבל לא בטוחים מאיפה להתחיל. הם קוראים את קובץ ה-README כדי להבין איך להתחיל להשתמש בתבניות, ומשתמשים ב-Information Architecture Guide כדי לפתח את אסטרטגיית התוכן שלהם ולתכנן את המראה של חבילת המסמכים.
הצעה
מעדכנים את קובץ ה-README כדי להנחות בצורה ברורה יותר את הקורא החדש בפרויקט, כולל שלבים ראשונים ברורים. אחד מהשלבים הראשונים הוא לקרוא את השאלות במדריך החדש בנושא AI ולענות עליהן. המדריך הזה יזמין את הקוראים להתייחס לקהל, לסכימת התוכן, למטריצות של משתמשים/משימות וכו', בלי להעמיס על הקורא ללמוד/להבין מהם הדברים האלה מבחינה אקדמית. בסיום המשימה הזו, הקורא יבין אילו תבניות נדרשות ואיך למלא אותן בצורה הטובה ביותר.
מחקר
כדי לתמוך בטענה הזו במחקר, אשתמש במידה רבה בספר של Abby Covert (http://www.howtomakesenseofanymess.com/). הסיבה העיקרית לכך היא שהספר מוכר לי מאוד והוא היווה את הבסיס של הרבה תוכן שכבר כתבתי ואשתמש בו, אבל גם כי קל מאוד לאנשים חדשים בתחום תכנון הממשק לקרוא אותו אם הם רוצים להרחיב את הידע שלהם. במובן הזה, זהו סוג של סם מעבר ל-AI.
טיוטת תוכן
README:
-- מבוא לפרויקט 'מסמכים טובים' |_ למי כדאי להשתמש בתבניות |_ איך התבניות פועלות |_ תרומה לפרויקט -- התבניות |_ רשימה של כל התבניות הנוכחיות |_ בחירת התבניות שבהן רוצים להשתמש |_ לפני שמתחילים -- לפני שמתחילים לכתוב |_ מי קורא את המסמכים? |_ למה הם קוראים את המסמכים? |_ כתיבה לקוראים
מדריך UI:
-- מבוא |_ מה זה IA? |_ למה זה חשוב לי? -- זיהוי הבלגן -- הצהרת הכוונה -- התמודדות עם המציאות -- בחירת כיוון -- מדידת המרחק -- התעסקות במבנה -- הכנה לשינויים