سؤال

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

هل كانت مفيدة؟

المحلول

لقد وجدت المساعدة في محرك البناء Hudson لتكون أنيقة جدا ومنفدة.

لديك أيقونة تعليمات، يمكنك النقر فوقه، يتم اكتشاف نص التعليمات مضمنة الصفحة، فلا تنقر مرة أخرى يختفي.

حاول البدء https://hudson.dev.java.net/hudson.jnlp. وانتقل TOHTTP: // localhost: 8080 / تكوين وانقر فوق الأزرار الكثيرة (؟) في الجانب الأيمن.

نصائح أخرى

جافا دوك يمكن استخدامها لاستخراج جميع التعليقات المدمجة داخل ملف رمز Java

ألق نظرة على Javahelp. يحاكي نظام المساعدة الموجود في الإصدارات القديمة من Windows

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

لذلك أوصي باستخدام CMS بسيطة. لا overkill، مجرد تحرير النص مع الروابط. لديك خيار دمجه في WebApp الخاص بك وهناك إمكانية استخراج PDF منه.
هذا هو أنيق لتقديم مساعدة دون اتصال للطباعة الخ

أود فقط استخدام HTML / CSS القديمة الجيدة - سيحافظ هذا على مستخدمي السلوك الذين يعرفون بالفعل في متصفح ويجب أن يكون لديك بالفعل ورقة النمط للتطبيق حتى تتمكن من الحفاظ على صفحات التعليمات المساعدة مع جهد إضافي.

إلقاء نظرة على المساعدة على خرائط جوجل (http://maps.google.co.uk/support/) - لأفكار التخطيط، إلخ.

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

إذا كنت تستخدم PHP، نلقي نظرة على phpdocumentor..

أداة PHPDocumentor هي مستندات تلقائية مستقلة مشابهة ل Javadoc مكتوب في PHP.

إذا كنت تبحث في إنتاج دليل المستخدم توضح ما يفعله كل زر، فقد وجدت استخدام شيء مثل Debugmode Wink. أو Adobe Captivate مفيد لتسجيل تفاعل الشاشة ثم تحويله إلى فيلم فلاش أو PDF.

خصيصا للقارات:http://github.com/darthapo/comatose/tree/master. هي أداة رائعة Little CMS التي يمكنك استخدامها لأنظمة المساعدة Imbedded.

غير ذلك، http://tenderapp.com/ يعمل بشكل جيد كحل مستضاف.

مرخصة بموجب: CC-BY-SA مع الإسناد
لا تنتمي إلى StackOverflow
scroll top