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

Question

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

في الوقت الحاضر نكتب مواصفات لدينا في تنسيق XML.تكس من شأنه أيضا أن يكون بديلا, ولكن من الصعب بالنسبة للأشخاص الذين لم يسبق لهم العمل معها.

لذلك اسمحوا لي أن أعرف أي نوع من الأدوات أو صيغ يمكنك استخدام المواصفات.

Answer 1

DocBook تحريرها مع XXE, ترجم إلى pdf مع xslt عند الحاجة ليتم إرسالها إلى العملاء.

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

بالإضافة إلى منظم الوثيقة الاسلوب هو بالفعل هناك ، على عكس كلمة الدموية التي لديك للقتال مع الحصول على العمل.

Answer 2

كنا تكس (MikTeX) وكانت مثالية لأن:

• ظلامة النص - تحرير في همة/المفكرة - فقط في كل مكان
• قوية التنسيق مسبقا باستخدام وحدات الماكرو واحد منا
• onclick جيل إلى PDF

وكانت المشكلة الوحيدة للحصول على الرسوم البيانية (من ArgoUML) في.

في مشروع آخر رأيت باستخدام قوالب Word - من الاشياء الفظيعة موجهة من فوق.

أود أن تنظر في استخدام شيء مثل ويكي/منتدى على الشبكة الداخلية.تخيل استخدام GoogleDocs - يوجد إصدارات منه..ولكن لا ينطبق على التنمية التجارية.

Answer 3

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

أنا لا تزال تبقي على المواصفات التي خربش على بعض دفتر ورقة على الحائط للتذكير.

Answer 4

لقد جئت إلى استخدام Docbook لجميع هذه الأشياء.انها سهلة, مرنة, وسوف تولد html, تكس (وبالتالي pdf) ، الخ.

Answer 5

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

Answer 6

في العمل ونحن استخدام ويكي لأنها كبيرة للتعاون ، ولكن Microsoft Word العمل.

يمكنك فعلا الفرق اثنين من إصدارات مختلفة من مستند Word باستخدام الكلمة نفسها - أنه يستخدم "تعقب التغييرات" ميزة لإظهار الاختلافات.(إذا كنت لا تصدقني ، في محاولة diffing نسختين من مستند Word باستخدام TortoiseSVN.)

لفترة طويلة الوثائق, أنا في الواقع أفضل كلمة على الويكي لأنه مناسب تحرير الوثائق الطويلة والأعمال الناس أكثر راحة مع العمل مع مستندات Word.