إنشاء المستندات في البناء الآلي

Question

هل هناك أي طريقة لإنشاء مستندات المشروع أثناء عمليات الإنشاء التلقائية؟

أرغب في الحصول على مجموعة واحدة من الملفات المصدر (HTML؟) مع دليل المستخدم، ومن بينها إنشاء:

• وثيقة PDF
• مساعدة آلية تبادل المعلومات
• نسخة HTML من المساعدة

سيكون المحتوى هو نفسه بشكل أساسي في جميع التنسيقات الثلاثة.

أستخدم حاليًا msbuild وCCNET، لكن يمكنني تغيير ذلك إذا لزم الأمر.

Answer 1

نعم!

• يستخدم قلعة الرمل لإنشاء وثائق CHM/HTM الخاصة بواجهات برمجة التطبيقات.
• يستخدم دوكبوك + فوب وأدوات أخرى لإنتاج أنواع أخرى من الوثائق بصيغة PDF وRTF وHTML وما إلى ذلك...

يمكن دمجها بسهولة مع CruiseControl.NET من خلال نانت.

Answer 2

هل جربت دوكسيجين؟إنه متاح لنظام التشغيل Windows أيضًا ويجب أن يكون من السهل دمجه في أي برنامج نصي/عملية إنشاء.

Answer 3

قد يقطع مشروع Apache Forrest شوطًا طويلًا ليمنحك ما تريد.

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

Answer 4

يمكن أن تقوم التعليمات والدليل بإنشاء ملفات PDF وHTML وCHM ذات نوعية جيدة (وتنسيقات أخرى) من مصدر واحد.كما أن لديها واجهة سطر الأوامر.لدي الإصدار 4 وأعجبني كثيرًا.أستخدم الشروط الشرطية (مثل #ifdefs) لإنشاء إصدارات Windows وMac من وثائقي بتنسيقات مختلفة كجزء من ملف إنشاء .bat/.csh.الإصدار 5 متاح الآن.

http://www.ec-software.com/

Answer 5

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

Answer 6

لقد كانت لي تجربة مع دوكسيجين.إنه أمر جميل وسهل، لكنه يجعلك ترغب في التعليق الزائد على الكود لتسهيل أعمال التوثيق اللاحقة.