ما هي الأدوات فريقك استخدام الكتابة المستخدم أدلة ؟ [مغلقة]

Question

الأساسية الطلبات هي:

• الإنسان للقراءة / تنسيق النص (لسهولة التحكم في الإصدار)
• على الانترنت (التعاون)
• من السهل تنسيق (تخفيض السعر حسنا, html كثيرا)
• التنسيق صارمة (ذلك الكتاب لا ابتكار أنواع جديدة من الألقاب ، الرصاص.... الخ)
• التصدير إلى PDF, HTML
• من السهل النسخ الاحتياطي و النشر (حتى نتمكن من "نشر" للعملاء الموقع قراءة نسخة فقط)

نحن نفكر باستخدام نوع من ويكي المحرك, ولكن سوف تحتاج إلى استخدام ملفات التخزين أو غيرها من وسائل "النشر" إلى العميل يكون من السهل تثبيت/maintan.أيضا, يجب أن يكون مجانا / رخيصة (التقاء مكلفة)

أي اقتراحات ؟

تحرير:أنا لا أبحث عن أدوات رمز الوثيقة ، يجب أن تغطي باستخدام الرمال.

Answer 1

على الرغم من أنه قد لا يجيب على جميع الطلبات الخاصة بك ، نينو قد يكون من المفيد أن نلقي نظرة على.

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

قد تحتاج إلى تقييم قائمة الميزة لمعرفة ما إذا كان سوف تلبي الاحتياجات الخاصة بك.

كما يبدو أيضا أن تكون جيدة جمع متوافر الإضافات.على الرغم من أنني لم تستخدم نينو أو الإضافات ، يبدو أن هناك الإضافات المتاحة تصدير PDF وكذلك.

Answer 2

اللاتكس

Answer 3

لدينا API, نستخدم Doxygen, التي هي كبيرة.

Answer 4

Pandoc هو أداة رائعة لتحويل بين مختلف العلامات الأشكال.نكتب مستندات في تخفيض السعر و استخدام Pandoc لتحويل صيغ أخرى.

من pandoc الموقع:

إذا كنت بحاجة إلى تحويل الملفات من توصيف شكل إلى آخر ، pandoc هو السويسرية الخاصة بك-سكين الجيش.Pandoc يمكن قراءة تخفيض السعر ، (فرعية) reStructuredText, النسيج, HTML, والمطاط, ويمكن أن كتابة نص عادي ، تخفيض السعر ، reStructuredText, HTML, اللاتكس ، السياق, PDF, RTF, DocBook XML ، OpenDocument XML, ODT, جنو Texinfo, ميدياويكي العلامات, نسيج, جروف الرجل صفحات Emacs org-وضع, EPUB, و S5 و Slidy HTML عروض الشرائح.PDF الإخراج (عبر اللاتكس) كما يدعم مع تضمين markdown2pdf المجمع البرنامج النصي.

Pandoc يحصل على نقاط إضافية كونها مفتوحة المصدر مكتوبة في السبب الذي هاسكل ;)

Answer 5

لا أستطيع أن أقول ما يكفي من الأشياء الجيدة حول Asciidoc.وقد بسيط جدا توصيف لغوي ، يمكن أن تولد كل شيء من pdf إلى roff المحمولة لتنفيذ جدا إدراجها بسهولة في أي ويكي فقط مع بعض التغييرات الطفيفة.

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

إذا كنت الحفاظ على النص تنسيق الملفات في مستودع ، التنقيح تتبع بسيط جدا.

عن وثائق التعليمات البرمجية, أنا استخدم doxygen.

Answer 6

نستخدم مساعدة دليل اليدوي ملف المساعدة.لا يوجد تصدير إتش تي أم ال ، ولكنه يوفر تعليمات html, winhelp pdf و المزيد من الأشكال.

Answer 7

نحن باستخدام الويكي.أوصي MoinMoin لأن

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

نحن لا تستخدم شيئا مثل كلمة:

• الوثائق تتعفن بسرعة
• البحث عن جميع الوثائق هو الألم
• الربط بين المعلومات بت هو الألم
• لا فرق بين الإصدارات
• بالصيغة الثنائية التي الفضلات أي فكس
• لا العميقة والإشارات المرجعية
• الوثائق تنمو كبيرة جدا ومن ثم تصبح الخرقاء:تقسيم (و لا تبحث بعد الآن) أو الانتظار الأعمار لتحميل.

Answer 8

لا أذكر اللغة/الإطار الذي تستخدمه.حقا أن هناك وثائق جيدة الأدوات هناك, ولكن البعض منهم خاصة ما أنت النامية في.ونحن على C# متجر, لذا جوابي سوف تنطبق فقط على لك إذا كنت تستخدم .صافي.

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

هذا يوفر لنا على حد سواء الداخلية والخارجية الوثائق.منذ ونحن أيضا استخدام "ملقم Foundation فريق" نحن استخدام المدمج في ويكي على فريق المشروع في Sharepoint, ولكن هذا هو أكثر الموجهة نحو التعاون المشروع.

تحرير:ثابت وصلة مكسورة, و أيضا أريد أن أذكر أن هناك أدوات أخرى بالتزامن مع الرمال التي نستخدمها.أشياء مثل Sandcastle ملف المساعدة باني و GhostDoc هي الأدوات المشتركة.أول من تحرير الرمال المشاريع MAML الثانية لتحسين التعليق الجودة في المدونة.

Answer 9

محاولة أبو الهول.كل الثعبان الوثائق باستخدام هذه الأداة http://docs.python.org/

Answer 10

عن "أدلة", Docbook.انها SGML اللهجة مصممة على الوثائق التقنية. http://www.docbook.org/ .قد لا تلبي "من السهل توصيف" المعيار ولكنه بالتأكيد ينتج إخراج لطيفة في اللاتكس (يمكن تحويلها بعد ذلك إلى PDF) وحسن الإخراج HTML إذا كنت طهي الطعام الخاصة بك CSS stylesheet لذلك.ملفات نصية تحفظ في التحكم في الإصدار.جميع البرامج أيضا استخدام المكتبة التي تجمع بين وسيطة سطر الأوامر توزيع مع "مساعدة" الإخراج في اختيار الأشكال (عادي ، صفحة ، docbook).API المرجعية, doxygen بالطبع.

Answer 11

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

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

Answer 12

محاولة Dikiwiki

Answer 13

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

Answer 14

لقد كان نجاحا كبيرا مع DocToHelp.يعمل كبيرة مع Microsoft Word على أساس الوثائق فضلا عن أشكال أخرى ، حتى وصلت إلى ميزات التكامل Visual Studio.

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

Answer 15

بالنسبة doument رمز يمكنني استخدام Doxigen.انا افضل نسخة لينكس, لقد كان لديها مشاكل مع بعض الميزات في نسخة ويندوز

Answer 16

تستخدم الشركة ميدياويكي و TikiWiki معظم الوثائق.لدينا أيضا الرجل الذي يجمع الاشياء في MS Word و PDF للطباعة/أرسل إلى العملاء.أنصح لك تجنب TikiWiki مثل الطاعون.ميدياويكي هو كبيرة ، سواء لأنه هو حقا سهلة الاستخدام و لأن الجميع يعرف كيفية استخدام الأمر بحكم الواقع القياسية ويكي و بجدارة, IMHO.

Answer 17

لبعض الوقت كنا باستخدام DocBook ، ولكن كان من الصعب جدا أن تمتد أكثر تقدما و الميزات الضرورية (تسليط الضوء على بناء الجملة ، تقسيم إلى العديد من الملفات ، multilinguality إدارة.... الخ).بعدها قررنا ان نكتب نظام من الصفر وإطلاق أنها مفتوحة المصدر: وصلة النص.ويستخدم نص عادي الملفات تخفيض السعر مثل بناء الجملة في اللغة, و الآن لدينا كل ما نحتاجه.العيب هو أنه في الوقت الراهن ربما لا يوجد تخفيض السعر محلل أن تنتج شيئا آخر من إخراج HTML.الآن هذا هو ما يكفي, ولكن نحن نفكر تنفيذ PDF الدعم قريبا جدا.

وعلاوة على ذلك, نحن استمراره ميدياويكي كما المجتمعية مساعدة.