محرر لوثائق المستخدم النهائي في تطبيق C# winform

Question

أقوم بتطوير تطبيق Winform في C# 4.0 وأرغب في المساهمة بزملاء الآخرين (غير التطويرين) في كتابة عملية مساعدة مستخدم نهائي حساسة للسياق. أولاً ، اعتقدت أنه يمكنني استخدام "ورشة مساعدة HTML" من Microsoft ، لكن يبدو أنها عفا عليها الزمن (لا يتم دعم Vista و Windows 7). ثم نظرت إلى Sandcastle ، لكن الوثائق غير موجودة وأتساءل عما إذا كان من المناسب للمستخدمين غير التقنيين كتابة وثائق المستخدم النهائي. لذلك قرأت عن Robohelp ، لكنها طريقة باهظة الثمن بالنسبة لي. أضيع في جميع المعلومات المتوفرة حول ملفات المساعدة. هل يمكن لأي شخص أن يساعد في تقديم بعض أفضل الممارسات أو المعلومات حول الأدوات التي يجب استخدامها وشكل الإخراج الذي يجب أن أستهدفه (لا يزال CHM أو غيره).

Answer 1

سؤال عظيم. أحب فكرتك عن غير المطورين الذين يساهمون في وثائق المستخدم النهائي.

قد تحفز هذه الفكرة المستخدمين والمختبرين على تطبيقك للمساهمة بسهولة في الوثائق.

أول ما يتبادر إلى ذهني ، هو استخدام نوع من محرك ويكي. يمكنك إنشاء وظيفة بسيطة في تطبيق WinForm الخاص بك ، والتي تطلق المتصفح وتوجه إلى الويكي. يمكنك استخدام السياق الذي يتم استدعاؤه لإنشاء عنوان URL ؛ على سبيل المثال http://dev-wiki.mycompany.com/LoginForm?action=edit. هنا يتم استخدام اسم النموذج ("loginform") في عنوان URL لصفحة الويكي.

بدلاً من ذلك ، يمكنك ببساطة استخدام المدمج التحكم في متصفح الويب ل winforms للوصول إلى الويكي. هذا سيبدو مثل:

var url = GetWikiUrl(myForm);
browserControl.Navigate(url);

سيكون هذا سهلاً للغاية للتضمين في تطبيقك.

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

Answer 2

لكتابة الوثائق ، أنا أستخدم أبو الهول. يتيح لك التوثيق في نص عادي وله تنسيقات إخراج مختلفة (CHM ، HTML ، PDF إلخ).

يمكن استخدام بعض هذه (CHM ، HTML) كمصادر مساعدة حساسة للسياق.

بغض النظر عن ذلك ، قد لا يكون واجهة مستخدم SPHINX (محرر النصوص وصنع الملف) مناسبًا للمستخدمين غير التقنيين.

Answer 3

أود أن أوصي بالاستخدام مساعدة+دليل لإنشاء وثائق CHM. إنه مشابه لـ MS Word ويمكن لأي مستخدم للكمبيوتر الشخص أن يبدأ في تطوير تطوير DOC بعد التعليم القصير. لكن هذه الأداة ليست مجانية :(