Pecan: مخطط التوثيق

robkooper و ashiklom حاولت دمج فكرتين في مخطط تفصيلي. KristinaRiemer و @ bailsofhay سيكون من الجيد الحصول على ملاحظاتك. سنبدأ في تنفيذ هذا قريبًا حتى نتمكن من نقل الصفحات إلى المكان الذي نريده قبل نهاية الشهر.

أعتقد أن هذا يبدو جيدًا حقًا. هذا هو مجرد إعادة ترتيب المواد الموجودة ، وليس إضافة أي شيء؟

عندما تفعل هذا ، يجب أن يذهب الفصل 41 بالفعل قبل 40.

KristinaRiemer نعم ، سأقوم فقط بتحريك الأشياء. في غضون ذلك ، يمكننا تحديد الأشياء المفقودة وإحداث المشاكل. لاحظ أن هذا يسمى مشكلة "Epic" لذا يمكن ربط هذه المشكلات الأخرى ضمن هذا العدد حتى نتمكن من البقاء منظمين.

كنت أبحث فقط في الوثائق عن بعض اللغات لاستخدامها في كتابة سريعة حول ما أفعله. أدركت أن المستند ليس لديه أفضل تفسير لسبب رغبة شخص ما في استخدام البقان (على وجه التحديد يفتقد أي تفسير لتحليل عدم اليقين). قد يكون هذا منطقيًا لوضعه في قسم "نظرة عامة على المشروع" في المستند المتاح حاليًا ، ولست متأكدًا من مكان إضافة هذا للمستند المعاد تنظيمه الذي نعمل عليه.

رابط من infotroph حول التوثيق: https://www.divio.com/blog/documentation/

رابط من infotroph حول التوثيق: https://www.divio.com/blog/documentation/

مزيد من السياق: تقدم هذه المقالة حالة مدعومة بقوة بأن هناك أربعة أنواع متميزة من توثيق البرامج ، وأن جميع المشاريع الموثقة جيدًا تحتاج إلى أن تشتمل على أربعة أقسام منفصلة بشكل صريح:

• البرامج التعليمية ، لتعليم المبتدئين ما تفعله أداتك باستخدام أمثلة خطوة بخطوة مضمونة للعمل تمامًا كما هو موصوف في كل مرة
• How-tos ، قسم كتاب الطبخ حيث يمكن للمستخدمين الانتقال للإجابة على أسئلة النموذج "كيف يمكنني ....؟" ، الذي يحتوي فقط على التفاصيل التي يحتاجون إليها لسؤال معين
• مرجع ، للحصول على تفاصيل صفحة الرجل حول كيفية استدعاء الأشياء ، وما هي البروتوكولات التي يتحدثون بها ، وما هي القيم التي يعودون إليها
• المناقشة ، حيث تشرح سبب عمل الأشياء بالطريقة التي تعمل بها ، وتقديم معلومات أساسية ، وتقديم المشورة بشأن الممارسات الجيدة مقابل الممارسات السيئة ، وإعطاء سياق لا يتناسب مع الأقسام الأخرى.

هذه المشكلة قديمة لأنها كانت مفتوحة 365 يومًا بدون أي نشاط.

على المدى الطويل ، أعتقد أن مفهوم البرنامج التعليمي / الكيفية / المرجع متين وأنه لا يزال بإمكاننا توضيح المستندات من خلال تطبيقه بشكل أكثر اتساقًا. ولكن تم تنفيذ إعادة التسجيل التي تمت مناقشتها هنا بشكل كامل بما يكفي لدرجة أنني سأغلق هذه المشكلة وأشجع سلاسل رسائل جديدة لإجراء أي تنظيف إضافي.