كتابة توثيق فعال لـ Discourse

حتى يكون لدينا طريقة أصلية للتعامل مع المستندات المحلية، أعتقد أن إضافة العلامات في بداية العنوان هي الطريقة الأكثر عملية للقيام بذلك، وهي استثناء معقول لهذا الدليل.

أعتقد أن هذا النوع من الأشياء له آراء وتفضيلات مختلفة في كلا الاتجاهين، ولكن بالنسبة لدليل الأسلوب هذا، فإننا نتبع المعايير الصناعية المقبولة. مرة أخرى، تتفق كل من أدلة Google و Microsoft على أن الاختصارات الشائعة أفضل استخدامًا.

ومع ذلك، فقد قرأت بعض المشاركات التي تقترح أن استخدام الاختصارات السلبية (مثل “can’t”) قد يجعل الفهم أكثر صعوبة للمتحدثين غير الإنجليز. سنتعمق في هذا الأمر أكثر، وإذا لزم الأمر، سنقوم بتحديث دليل الأسلوب وفقًا لذلك.

لقد قمت بإزالة هذا المثال! :smile:

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

هذه نقطة رائعة - سأضيفها إلى دليل الأسلوب!

شكرًا على هذه الملاحظات! قدم @maiki بعض النقاط الجيدة أعلاه، وأنا أتفق مع ما يقوله هناك. لإضافة إلى ذلك، سأقول إن أحد الأسباب التي جعلتنا نحول المستندات الرسمية ليكون @Discourse هو المؤلف هو منحها إحساسًا أكبر بالسلطة للقراء، وخاصة الأشخاص الذين يزورون المستندات لأول مرة. هذا هو الدافع وراء دليل الأسلوب بأكمله في المقام الأول.

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

كل هذه الملاحظات محل تقدير كبير :slight_smile:

إعجابَين (2)