আপনি কোন ধরনের অনলাইন প্রযুক্তিগত ডকুমেন্টেশন সিস্টেমের সুপারিশ করবেন? [বন্ধ]


11

লক্ষ্যটি হ'ল এই বড় প্রয়োজনীয়তা সহ একটি অনলাইন ডকুমেন্টেশন সিস্টেম থাকা:

  • আমাদের সমস্ত অ্যাপ্লিকেশনের চূড়ান্ত প্রযুক্তিগত ডক্সের জন্য প্রধানত একটি মধ্যবর্তী পর্যায় হিসাবে ব্যবহৃত হবে (যা সম্ভবত যদিও শেষ হবে না:])। এটি সাধারণত হিসাবে ব্যবহৃত হবে: কারও সমস্যা আছে, আমি এটি সংশোধন করি এবং খুব তাড়াতাড়ি ফিক্সটি লিখি। এখন যা ঘটে তা নিয়ন্ত্রণহীন হয়ে উঠছে: কারও সমস্যা আছে, আমি এটি ঠিক করেছি, আমি এবং কেউ দুজনেই খুশি তবে 2 মাস পরে অন্য কারও একই সমস্যা রয়েছে এবং ঠিক কী ছিল তা কেউ মনে রাখে না।
  • আমাদের অ্যাপাচি সার্ভারের পিছনে ছুটে যাওয়া সর্বত্র থেকে অ্যাক্সেসযোগ্য
  • ব্যবহারকারী / গ্রুপ ম্যানেজমেন্ট, কেবলমাত্র পঠনযোগ্য / পঠন / লেখার / অ্যাডমিনের অ্যাক্সেসের অনুমতি দেয়
  • ফর্ম্যাটটি খুব গুরুত্বপূর্ণ নয়: প্লেইন পাঠ্যটি করবে, উইকি-স্টাইলটি আরও সুন্দর হবে
  • সস্তা বা বিনামূল্যে

আমার কিছু ধারণা:

  • কেবল একটি ফাইল শেয়ারে বা এসএসএসের মাধ্যমে ফাইল পরিবেশন করুন (উইন্ডোজ, ফায়ার: সরল, যে কোনও ফাইলের ধরণের হতে পারে) এর সাথে খুব বেশি কল্পনাযোগ্য নয়)
  • এটি একটি এসসিএম (এসএনএন / গিট, উপরে হিসাবে আদর্শ হিসাবে কিন্তু অ্যাক্সেস এবং নিয়ন্ত্রণ অ্যাক্সেস) সহজ রাখুন
  • সঙ্গম: আমরা জিরাকে ইতিমধ্যে ব্যবহার করি, সংগম কি এর মূল্যবান? কীভাবে এটি জিরার সাথে সংহত হয়?
  • অন্যকিছু?

দয়া করে এ সম্পর্কে মন্তব্য করতে দ্বিধা করবেন না বা অন্য সিস্টেমগুলির সাথে আপনার অভিজ্ঞতা ভাগ করুন।


ডকুমেন্টেশনটি কোড (যেমন জাভাদোকস) থেকে উত্পন্ন হচ্ছে বা এটি কোনও স্ক্র্যাচ থেকে, একজন ব্যবহারকারী গাইড হিসাবে, বা দুটির কোনও সংমিশ্রণে লেখা হয়েছে?
হতাশ

এটি প্রধানত একটি ইউজার গাইড, না কোড নথিপত্রের আরো (ভাল, আমরা যে পাশাপাশি, doxygen দ্বারা উত্পন্ন, আমরা এটা অন্তর্ভুক্ত হতে পারে, কিন্তু এটা সুদের প্রথম বিন্দু নয়)
stijn

আমি কিছু নগদ স্পলস্কির হাতে দেব।
কাজ

উত্তর:


11

আমি একটি উইকি পরামর্শ দিতে যাচ্ছি

সঙ্গম একটি উইকি হিসাবে আমি মনে করি এটি আপনার জিরার সাথে ব্যবহার করা একটি দুর্দান্ত ধারণা। আপনারা সরাসরি JIRA ইস্যুগুলিতে সরাসরি টাই করতে সক্ষম হবেন এবং এর ফলে আসল কোড / ডক / যা কিছু পরিবর্তন হয়েছে ইত্যাদি have

এর মতো যে কোনও কোড ডক রেপোর চাবি হ'ল নেভিগেশন দিক। আপনি যে পৃষ্ঠাগুলি সংযোগ বিচ্ছিন্ন, খুঁজে পাওয়া শক্ত তা চান না etc. কোনও ওয়েবসাইটের জন্য আপনার পছন্দ মতো 'সাইটের লেআউট'-এ ভাবেন না।


সঙ্গম স্পষ্টতই বিভিন্ন ফ্ল্যাট ফর্ম্যাটে রফতানি করতে পারে। সহজে সম্পাদনযোগ্য থেকে শেষের উত্পাদনের পক্ষে পৌঁছানোর সবচেয়ে সহজ উপায়গুলির মতো শোনায়

2
আমি যেখানে কাজ করি সেখানে আমাদের সংগম রয়েছে — আমরা মিডিয়াউইকি থেকে স্থানান্তরিত হয়েছি — এবং এটি বেশ কয়েকটি ফরম্যাটে আউটপুট করে দেওয়ার ভাল কাজ করে (শব্দটি সর্বাধিক জনপ্রিয়)। তবে সতর্ক হতে হবে এর ডাব্লুওয়াইএসআইওয়াইওয়াইজি সম্পাদনা সরঞ্জামগুলি অবিশ্বাস্যভাবে বগী এবং ট্যাগিং সিস্টেমটি কমপক্ষে আমাদের ইনস্টল করার জন্য, পছন্দসই হওয়ার জন্য অনেক কিছু ছেড়ে দেয়।
ফিলিপ রেগান

উইকির জন্য +1, আমি ট্র্যাকটিকে সে ক্ষেত্রে খুব দরকারী বলে মনে করেছি কারণ এটি এসভিএন পাশাপাশি ফাইল ভাগ করে নেওয়ার অনুমতি দেয়।

আমরা একটি সংঘবদ্ধতা পরীক্ষা করে দেখেছি এবং এটি সমাধান হতে চলেছে। আমাদের প্রয়োজনের চেয়ে আরও বেশি কিছু করতে সক্ষম বলে মনে হচ্ছে তবে এটির সাথে কাজ করা বেশ সহজ। আমি ট্র্যাক বছর দুয়েক আগে চেষ্টা এবং এটি একটি বিট খুব, আমার স্বাদ অগোছালো বিশেষত যখন এটি এসেছিলেন প্লাগিন ইত্যাদি
stijn
আমাদের সাইট ব্যবহার করে, আপনি স্বীকার করেছেন যে আপনি আমাদের কুকি নীতি এবং গোপনীয়তা নীতিটি পড়েছেন এবং বুঝতে পেরেছেন ।
Licensed under cc by-sa 3.0 with attribution required.