تحتوي هذه الصفحة على تفاصيل مشروع كتابة تقنيّة تم قبوله في موسم المستندات من Google.
ملخص المشروع
- المؤسسة المفتوحة المصدر:
- TheGoodDocsProject
- الكاتب التقني:
- الدقة
- اسم المشروع:
- دليل بنية المعلومات
- مدة المشروع:
- المدة العادية (3 أشهر)
وصف المشروع
خطة دليل بنية المعلومات
يتناول هذا المستند التخطيط لدليل بنية المعلومات لمشروع المستندات الجيدة. وقد تم إعداده كجزء من البيانات التي تم إرسالها بشأن موسم "مستندات Google" لعام 2020 من Google. حيث تحدد حالة الاستخدام للدليل المقترح، وترسم خطة لهيكل هذا الدليل، لأغراض التخطيط.
تتعلق بنية المعلومات (IA) بكيفية تنظيم المحتوى. حيث يتناول بنية المحتوى بدون تحديد النمط أو الكلمات المستخدمة داخل المحتوى نفسه. على سبيل المثال، ستأخذ خطة بنية المعلومات في الاعتبار من هو القارئ وكيف يتعامل مع المحتوى والبيئة التي يقرأ فيها. وسينظر بعد ذلك في بنية مناسبة للمحتوى الذي يخدم متطلبات القراء هذه على أفضل وجه.
في عالم مثالي، يتم تصميم التوثيق من خلال البدء باستراتيجية المحتوى، التي تستخدم أهداف العمل لتحديد أهداف الوثائق. يتم بعد ذلك استخدام استراتيجية المحتوى لإنشاء بنية المعلومات، التي تحدد تخطيط الوثائق وهيكلها. من هناك، يمكن اختيار سلاسل الأدوات، وكتابة المحتوى. حقيقة معظم مشروعات البرامج مفتوحة المصدر هي أن استراتيجية المحتوى بسيطة مثل "كتابة بعض الوثائق حتى يعرف الناس كيفية استخدام هذا المشروع"، ولكن حتى هذه الإستراتيجية البسيطة تكون كافية لتكون قادرًا على تحديد بنية معلومات فعالة.
الهدف من هذا الدليل هو توفير أداة مبسطة للكتاب غير المحترفين لتطوير بنية معلومات كافية لتحديد القوالب التي يجب عليهم استخدامها. يجب أن يكون بسيطًا بما فيه الكفاية ليتم إكماله بواسطة إنسان عادي خلال فترة بعد الظهر، ويجب أن يفضل العمل على التعليم. من الناحية المثالية، سيقدم الكتاب المفاهيم بطريقة موجزة، ويوجه القارئ نحو النظر في هذه المفاهيم فيما يتعلق بمشروعه الخاص، ويستخدم نتيجة ذلك للانتقال إلى المفهوم التالي.
كإجراء أساسي لهذا المشروع، يجب إجراء بعض التحديثات على المشروع README، حتى يفهم القراء كيفية البدء في مشروع المستندات الجيدة، ويكونوا قادرين على استخدام دليل بنية المعلومات بشكل فعال لتوجيه خيارات النماذج الخاصة بهم.
الجمهور الأساسي
جميع الأشخاص الذين يتطلعون إلى استخدام قوالب مشروع المستندات الجيدة لإنشاء وثائق لمشروعهم
حالات الاستخدام: تم تصميم هذا القسم لاستكشاف كيفية تعامل القرّاء مع دليل بنية المعلومات. ويمكن أن يساعدنا ذلك في تحديد بنية الدليل بهدف خدمة هؤلاء القراء على أفضل وجه.
السيناريو:
شخص يعمل في مشروع مفتوح المصدر يحتوي على القليل من الوثائق أو لا يحتوي على وثائق، أو مجموعة وثائق منظمة أو مكتوبة بشكل سيئ. قرر استخدام مشروع المستندات الجيدة لتنظيم وثائقه، لكن ليس متأكدًا من أين يبدأ. تتابع صانعة المحتوى النسخة الجاهزة لفهم كيفية البدء باستخدام النماذج، كما تتابع Information Architecture Guide لوضع استراتيجية المحتوى والتخطيط لشكل مجموعة المستندات.
الاقتراح
تحديث الملف التمهيدي لتوجيه القارئ الجديد بشكل أكثر وضوحًا خلال المشروع، بما في ذلك الخطوات الأولى الواضحة. ستكون إحدى تلك الخطوات الأولى هي قراءة الأسئلة والإجابة عنها في دليل بنية المعلومات الجديد. قد يدعو هذا الدليل القارئ إلى النظر في الجمهور ومخطط المحتوى ومصفوفات المستخدم/المهام وما إلى ذلك، دون وضع عبء كبير على القارئ لتعلم/فهم هذه الأشياء من الناحية الأكاديمية. بمجرد اكتمال هذه المهمة، يكون لدى القارئ فهم للقوالب المطلوبة وكيفية إكمالها بشكل أفضل.
الأبحاث
من أجل دعم ذلك بالبحث، أود الاعتماد بشكل كبير على كتاب Abby Covert (http://www.howtomakesenseofanymess.com/)، ويرجع ذلك جزئيًا إلى درايتي به بدرجة كبيرة والذي شكل أساسًا للكثير من المحتوى الذي كتبته وسأستفيد منه، وأيضًا لأنه من السهل جدًا على الأشخاص الجدد في بنية المعلومات الاطّلاع على مزيد من المعلومات وقراءتها إذا كان لديهم اهتمام كبير بها. إنه جزء من دواء بوابة بنية المعلومات، من هذا المنطلق.
مسودة بنود الخدمة
قراءة:
-- مقدمة عن مشروع المستندات الجيدة |_ من الذي ينبغي له استخدام النماذج |_ كيفية عمل النماذج |_ المساهمة في المشروع -- النماذج |_ قائمة بجميع النماذج الحالية |_ اختيار النماذج المطلوب استخدامها |_ قبل البدء -- قبل البدء في الكتابة |_ من يقرأ المستندات؟ |_ لماذا يقرأون المستندات؟ |_ الكتابة للقرّاء
دليل بنية المعلومات:
-- مقدمة |_ ما هي بنية المعلومات؟ |_ ما أهمية ذلك بالنسبة إليّ؟ -- تحديد الفوضى -- توضيح هدفك -- واجه الواقع -- اختيار الاتجاه -- قياس المسافة -- اللعب بالبنية -- الاستعداد للتعديل