این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.
خلاصه ی پروژه
- سازمان منبع باز:
- HPX
- نویسنده فنی:
- rstobaugh
- نام پروژه:
- ویرایش و ساده سازی اسناد HPX موجود
- طول پروژه:
- طول استاندارد (3 ماه)
شرح پروژه
پیشنهاد من ویرایش و ساده کردن محتوای اسناد HPX موجود است. پیشنهاد من برای یک پروژه استاندارد (سه ماهه) است که بر بازنگری دو فصل از راهنمای گروه STE||AR متمرکز است: ""HPX Build System and Launching"" (1) و ""پیکربندی برنامه های HPX"" (2) .
فصل مربوط به "HPX Build System and Launching"" دارای چندین خطای گرامری است و همچنین حاوی زبان گیج کننده و حروف بزرگ متناقض عباراتی مانند "CMake" است. علاوه بر این، حاوی اطلاعات مکرر است، که من قصد دارم در صورت نیاز آنها را مرتب، تثبیت و اصلاح کنم. در حالی که فصل "پیکربندی برنامه های HPX"" همچنین حاوی چند خطای گرامری است که باید برطرف شوند، نگرانی اصلی من برای این فصل کاربر پسند بودن آن است. این فصل دارای سه موضوع اصلی طراحی است که من قصد دارم به آنها بپردازم:
برخی از سرفصل‌ها در متن مدفون شده‌اند که مرور فصل را سخت می‌کند. در حال حاضر، برای درک هدف هر جدول، کاربر باید کتابچه راهنمای کاربر را به دقت مطالعه کند. اینگونه نیست که بیشتر کاربران با کتابچه های دستورالعمل تعامل دارند، به خصوص اگر قبلاً محتوا را خوانده باشند. در عوض، من قصد دارم مطمئن شوم که هر جدول دارای یک عنوان واضح و متمایز است، که اگر کاربر در متن پیمایش کند، به راحتی قابل مشاهده است.
هنگامی که ویژگی های مختلف را تحت یک عنوان خاص فهرست می کنید، ویژگی ها از ترتیب منطقی پیروی نمی کنند. در حالی که ویژگی ها تحت یک موضوع مشترک با هم گروه بندی می شوند، هیچ زیرگروهی وجود ندارد که باعث می شود اطلاعات پراکنده شوند. به عنوان مثال، یک کاربر ممکن است با چندین ویژگی مواجه شود که به محلی بودن می پردازد، چند ویژگی که با موضوع دیگری سروکار دارد، سپس دیگری که با محلی بودن سروکار دارد. این فقدان ساختار داخلی تحت عنوان، یافتن همه اطلاعات در یک موضوع فرعی خاص را دشوارتر می کند. بنابراین، من قصد دارم چندین نمودار را دوباره سازماندهی کنم تا اطلاعات مشابه را با وضوح بیشتری در زیر هر عنوان گروه بندی کنم.
کاربران مجبورند بین بخش‌ها به جلو و عقب حرکت کنند (یا دفترچه راهنما را در دو برگه جداگانه باز کنند) تا دستورالعمل‌های خاص را به طور کامل درک کنند. نقاطی وجود دارد که در این فصل کاربر را به یک جمله واحد در بخش قبلی هدایت می‌کند، به نحوی که خواننده را مجبور می‌کند تا به بالا پیمایش کند یا پیوندی را دنبال کند تا دستورالعمل دقیق را بفهمد، زیرا کتابچه راهنمای کاربر از زبان مبهم استفاده می‌کند، مانند «این مرحله پس از انجام شده است. مرحله 11 اینچ در بخش قبل. در حالی که این روش تکرار را حذف می‌کند، درک دستورالعمل‌ها را سخت‌تر می‌کند، زیرا اینها وظایفی هستند که باید به ترتیب خاصی انجام شوند. در عوض، من پیشنهاد می‌کنم که عبارت‌های خاص‌تری اضافه شود تا کاربران مجبور نباشند فرآیند خواندن خود را با جابجایی بین بخش‌ها یا اسناد قطع کنند.
اگر این بخش‌ها را قبل از اتمام جدول زمانی استاندارد تکمیل کنم، می‌خواهم «چرا HPX؟» را نیز پاک کنم. (3) صفحه زیر گروه STE||AR's User Documentation. این صفحه حاوی محتوای مقدماتی تکراری است که امیدوارم بتوان آن را ادغام کرد و دارای تناقضاتی در حروف بزرگ (مخصوصاً اصطلاحات تخصصی) و صدا است که به آن حس یکپارچگی می دهد. هدف من ایجاد یک معرفی یکپارچه تر و منسجم تر برای کار گروه STE||AR خواهد بود.