این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.
خلاصه پروژه
- سازمان منبع باز:
- TheGoodDocsProject
- نویسنده فنی:
- لوواسیتی
- نام پروژه:
- راهنمای معماری اطلاعات
- طول پروژه:
- طول استاندارد (3 ماه)
شرح پروژه
طرح راهنمای معماری اطلاعات
این سند برنامه ریزی برای راهنمای معماری اطلاعات برای پروژه Good Docs را پوشش می دهد. این به عنوان بخشی از ارائه شده در فصل Google Docs 2020 آماده شده است. مورد استفاده برای راهنمای پیشنهادی را تشریح می‌کند و طرحی از ساختار چنین راهنما را برای اهداف برنامه‌ریزی ترسیم می‌کند.
معماری اطلاعات (IA) به نحوه سازماندهی محتوا مربوط می شود. ساختار محتوا را بدون تعریف سبک یا کلمات استفاده شده در خود محتوا پوشش می دهد. به عنوان مثال، یک طرح IA در نظر می گیرد که خواننده کیست، چگونه به محتوا نزدیک می شود و محیطی که در آن مطالعه می کند. سپس ساختار مناسبی را برای محتوا در نظر می گیرد که به بهترین وجه این نیازهای خواننده را برآورده می کند.
در دنیایی عالی، مستندسازی با شروع با یک استراتژی محتوا طراحی می‌شود که از اهداف تجاری برای تعریف اهداف مستندسازی استفاده می‌کند. سپس از استراتژی محتوا برای ایجاد یک IA استفاده می شود که طرح و ساختار اسناد را تعریف می کند. از آنجا می توان زنجیره های ابزار را انتخاب کرد و محتوا نوشت. واقعیت بیشتر پروژه‌های منبع باز این است که استراتژی محتوا به سادگی "نوشتن برخی اسناد تا مردم بدانند چگونه از این پروژه استفاده کنند" است، اما حتی همین استراتژی ساده نیز برای تعریف یک IA موثر کافی است.
هدف این راهنما ارائه ابزاری ساده برای نویسندگان غیرحرفه ای است تا یک IA را ایجاد کنند که برای تعیین الگوهایی که باید استفاده کنند کافی باشد. باید آنقدر ساده باشد که توسط یک انسان معمولی در یک بعدازظهر تکمیل شود و باید عمل را به آموزش ترجیح دهد. در حالت ایده‌آل، مفاهیم را به روشی مختصر معرفی می‌کند، خواننده را راهنمایی می‌کند تا آن مفاهیم را در ارتباط با پروژه خود در نظر بگیرد و از نتیجه آن برای رفتن به مفهوم بعدی استفاده کند.
به عنوان داربست برای این پروژه، به‌روزرسانی‌هایی برای پروژه README لازم است، به طوری که خوانندگان بدانند که چگونه با پروژه Good Docs شروع کنند و بتوانند از راهنمای IA به طور مؤثر برای راهنمایی انتخاب‌های الگوی خود استفاده کنند.
مخاطبان اولیه
همه افرادی که به دنبال استفاده از الگوهای پروژه The Good Docs برای ایجاد مستندات برای پروژه خود هستند
موارد استفاده: این بخش برای بررسی نحوه برخورد خوانندگان به راهنمای IA طراحی شده است. این می تواند به ما کمک کند تا مشخص کنیم که چگونه راهنما باید ساختاری داشته باشد تا به بهترین نحو به آن خوانندگان خدمت کند.
سناریو: شخصی در حال کار بر روی یک پروژه متن باز است که مستندات کمی دارد یا اصلاً مستند نیست، یا مجموعه اسنادی که به خوبی سازماندهی یا نوشته شده است. آنها تصمیم می گیرند از The Good Docs Project برای سازماندهی اسناد خود استفاده کنند، اما مطمئن نیستند که از کجا شروع کنند. آنها از README پیروی می کنند تا بفهمند چگونه می توان با الگوها شروع کرد، و Information Architecture Guide دنبال می کنند تا استراتژی محتوای خود را توسعه دهند و برنامه ریزی کنند که مجموعه اسناد آنها چگونه به نظر می رسد.
پیشنهاد
README را به‌روزرسانی کنید تا خواننده جدید را با وضوح بیشتری در پروژه هدایت کنید، از جمله اولین قدم‌های واضح. یکی از اولین گام‌ها خواندن و پاسخ به سؤالات در راهنمای جدید IA است. آن راهنما خواننده را دعوت می‌کند تا مخاطب، طرح محتوا، ماتریس‌های کاربر/وظیفه، و غیره را در نظر بگیرد، بدون اینکه بار زیادی را بر خواننده بگذارد تا یاد بگیرد/ بفهمد آن چیزها در مفهوم آکادمیک چیست. پس از تکمیل این کار، خواننده متوجه می شود که چه الگوهایی مورد نیاز است و چگونه آنها را به بهترین شکل تکمیل کند.
تحقیق کنید
برای اثبات این موضوع با تحقیق، من به شدت به کتاب ابی کاورت (http://www.howtomakesenseofanymess.com/) تکیه می کنم، تا حدی به این دلیل که من با آن بسیار آشنا هستم و اساس بسیاری از کتاب ها را تشکیل داده است. مطالبی را که قبلاً نوشته‌ام و از آنها استفاده خواهم کرد، اما همچنین به این دلیل که افرادی که تازه وارد IA شده‌اند، بسیار آسان است که اگر علاقه بیشتری داشته باشند، آن را انتخاب کرده و بخوانند. از این نظر کمی یک داروی دروازه IA است.
پیش نویس ToC
بخوان:
-- مقدمه ای بر پروژه Good Docs |_ چه کسی باید از الگوها استفاده کند |_ الگوها چگونه کار می کنند |_ مشارکت در پروژه -- الگوها |_ فهرست همه الگوهای فعلی |_ انتخاب الگوهایی برای استفاده |_ قبل از شروع -- قبل از شروع نوشتن |_ چه کسی اسناد را می خواند؟ |_ چرا آنها اسناد را می خوانند؟ |_ نوشتن برای خوانندگان شما
راهنمای IA:
-- مقدمه |_ IA چیست؟ |_ چرا باید اهمیت بدم؟ -- آشفتگی را شناسایی کنید -- قصد خود را بیان کنید -- با واقعیت روبرو شوید -- جهتی را انتخاب کنید -- فاصله را اندازه گیری کنید -- با ساختار بازی کنید -- برای تنظیم آماده شوید