كيفية إنشاء وتقديم الوثائق لأدوات تكنولوجيا المعلومات على ويندوز؟ [مغلق
https://stackoverflow.com/questions/1104533
-
12-09-2019 - |
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
Russianسؤال
كيف يمكنني بناء وتقديم الوثائق للحصول على أداة تكنولوجيا المعلومات على ويندوز؟ هناك قيد إضافي لا أريد إنفاق الأموال على أدوات التأليف المساعدة.
هنا على ذلك، نتحدث عن الخوارزميات والتحسينات، واجهات برمجة التطبيقات وأداء الأداء. لكن أحد النواتج من جهود ديف بلدي هو توثيق. ما هي أفضل طريقة لبناءها، وفي أي شكل يجب أن أحققها؟
إذا قمت بتسليم مجموعة من واجهات برمجة التطبيقات .CHM هي آلية معقولة للتسليم. انه سهل الاستخدام shfb. لبناء ملف التعليمات كجزء من Build، وإذا سيتم استخدامه في الغالب على Windows، فإن A.chm يمكن الوصول إليها للغاية. وتحويل .chm إلى .htm يجعل الوثيقة يمكن الوصول إليها على نطاق أوسع.
لكنني أرغب في تقديم الوثيقة لمرشح ISAPI الذي سيتم استخدامه من قبل المطورين في حد ذاته، ولكن بواسطة مسؤولي خادم Windows Web. أحتاج إلى وصف التثبيت والعمليات والتكوين. أعتقد أن المستخدمين النهائيين قد يكون لدى المستخدمين في كثير من الأحيان المطورين وكذلك المهارات الإدارية، ولكن في أي حال، لأغراض بلدي ستغطي الوثائق المهام الإدارية والمسائل التشغيلية.
أعلم أن SHFB يسمح لي بتضمين ملفات HTML العادية في .chm. إذا كنت أعرف بالفعل SHFB، وإذا كنت لا أريد إنفاق الأموال على أداة تأليف المساعدة، هل هذه هي أفضل طريقة للذهاب؟ إن لم يكن، ماذا؟
المحلول 4
في النهاية، قررت استخدام Sandcastle Help File Builder، أداة مجانية متوفرة http://shfb.codeplex.com.. وبعد لقد استخدمت بالفعل Sandcastle لبناء الوثيقة المرجعية لمشروع مختلف، لذلك عرفت شيئا عن الأداة. إنها تنتج ملفات CHX أو .hxs، ومناسبة للاستخدام على Windows. لم أستخدمها أبدا SHFB إلى "تصميم" مفيد من قبل، لكن كان من السهل جدا فهم كيفية القيام بذلك. النتائج جيدة جدا.
نصائح أخرى
texlipse. هو البرنامج المساعد اللاتكس للاستفكاس. كلاهما مجاني. يستخدم العديد من الباحثين من قبل العديد من الباحثين لتوليد أوراقهم ويستخدم حتى العديد من الكتب النصية. إنها أداة مجانية يمكن أن تلبي احتياجاتك.
جرب هذا ASCIIDOC.. وبعد إنه ليس مؤشا، ولكنه ينتج PDF / CHM / HTML لطيف ويمكنك تعليم غير مبرمج لكتابة وثائق لك، وهو مكافأة لطيفة :)
لماذا لا تكتب الوثائق في المكتب المفتوح ثم تصديرها في PDF؟
اللاتكس هو الطريقة المهنية، لكنه لا يمكن الوصول إليه بسرعة.
