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