مثل هذه المستندات المختلفة: التصميم مقابل. موجه للمستخدم

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



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



كيف تختلف أرصفة منتجات Yandex و Google و Microsoft و Apple عن وثائق المدرسة القديمة التي أنشأها مهندسو التصميم؟



يكتب المهندس الكلاسيكي بحيث يتم وصف المنتج بشكل كامل وصحيح قدر الإمكان + وفقًا لـ GOST والمصطلحات المقبولة. علاوة على ذلك ، فإن العديد من المصطلحات والتعريفات في GOSTs قديمة ولا تلون المستندات على الإطلاق. لكن هذه ليست مشكلة للمُنشئين - لا أحد يعتقد حقًا إذا كان من السهل على المستخدم فهم النص. لكن الأرصفة المخصصة للأشخاص مختلفة: فهي مكتوبة بلغة مفهومة وتراعي اهتمامات المستخدم. مسألة أولويات.



تؤثر أولويات وأهداف المؤلف بشكل كبير على المستندات التي يتم الحصول عليها. دعونا نرى بأمثلة كيف تبدو في الحياة الواقعية:





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