این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.
خلاصه پروژه
- سازمان منبع باز:
- CERN-HSF
- نویسنده فنی:
- شانس در باران
- نام پروژه:
- مستندات ریشه: تجزیه و تحلیل، بازسازی و بازنویسی
- طول پروژه:
- دویدن طولانی مدت (5 ماه)
شرح پروژه
این پروژه شامل چهار مرحله است:
1.) تجزیه و تحلیل مستندات ROOT فعلی
سند ROOT کامل (وب‌سایت، راهنمای کاربران، مرجع C++، آموزش‌ها و غیره) بر اساس معیارهای زیر تجزیه و تحلیل و بررسی می‌شود: ساختار، مدولارسازی، استانداردسازی، مکانیسم‌های دسترسی، سازگاری، انواع اطلاعات مورد استفاده، آماده‌سازی خاص گروه هدف و قابل درک بودن هدف ایجاد مفهومی برای مدیریت اطلاعات و ماتریسی برای ساختاردهی و دستورالعملی برای استانداردسازی محتوا است.
2.) تعریف روشی برای ساختار اسناد نرم افزار نوشتن با تیم ROOT
DITA (Darwin Information Typing Architecture)، یک استاندارد OASIS برای اسناد نرم افزاری ( https://www.oasis-open.org/committees/dita/ ) به تیم ROOT ارائه شده است. تمرکز اصلی بر درک چگونگی ساختار محتوای خاص نرم افزار و نحوه استفاده از انواع اطلاعات ابتدایی به عنوان "مفهوم"، "وظیفه" و "مرجع" برای نوشتن اسناد نرم افزار است.
3.) بازسازی و سازماندهی مجدد اسناد ROOT
بر اساس نتایج دو مرحله اول، مستندات ROOT با توجه به گروه‌های هدف، نقش‌ها و موارد استفاده بازسازی و مدولار شده و محتوا به عناصر مربوطه (وب‌سایت، راهنمای کاربران، مرجع C++، آموزش‌ها و غیره) اختصاص داده می‌شود. و انواع محتوا از آنجایی که اطلاعات موجود بسیار گسترده است، همچنین باید یک ساختار مرجع ثابت ایجاد شود. هدف ارائه یک نمای کلی جامع و نشان دادن راه‌های روشن به کاربران است که چگونه می‌توانند از ROOT برای نیازهای خود استفاده کنند. علاوه بر این، یک مقدمه فشرده غیر فیزیک گرا ارائه شده است.
4.) بازنویسی اسناد ROOT
بخش های اصلی مستندات، به ویژه راهنمای کاربران، مطابق با رویکرد DITA بازنویسی شده است. قوانین ساختاربندی و نگارش در یک راهنمای سبک به منظور اطمینان از ثبات در اسناد در آینده ثبت شده است. هدف این است که تیم ROOT بتواند اسناد ROOT را در آینده گسترش دهد و حفظ کند.
برنامه زمانی تخمینی (5 ماه):
فاز 1: تجزیه و تحلیل اسناد ROOT فعلی: 3 هفته.
فاز 2: تعریف روشی برای ساختار اسناد نرم افزار نوشتن با تیم ROOT: 2 هفته.
فاز 3: بازسازی و سازماندهی مجدد اسناد ROOT: 4 هفته.
فاز 4: بازنویسی اسناد ROOT: 11 هفته.