সফটওয়্যার বিকাশের জন্য ডকুমেন্টগুলি সংরক্ষণ করার জন্য কি উইকিগুলি আসলেই উপযুক্ত? [বন্ধ]


18

সকলেই জানেন যে ভালভাবে নথিভুক্ত সফ্টওয়্যার বিকাশ সাফল্যের দিকে পরিচালিত করে। তবে এটির অর্থ সাধারণত যে কেবল প্লেইন পাঠ্য নয়, বাইনারি সামগ্রীগুলি নথিতে জড়িত থাকবে, যেমন একটি ইউএমএল ডায়াগ্রাম। এবং আমি অনেক লোককে বলতে শুনেছি। সংস্করণ নিয়ন্ত্রণ ব্যবস্থা বাইনারি ফাইলগুলির জন্য উপযুক্ত জায়গা নয়। আমি বিষয়টি পুরোপুরি বুঝতে এবং সম্মত। আমি বেশ কয়েকটি পাকা বিকাশকারীকে জিজ্ঞাসা করেছি যেখানে নথি সংরক্ষণের সর্বোত্তম জায়গাটি হওয়া উচিত এবং আমার কাছে পাওয়া উত্তরটি "উইকি" ছিল। উইকি ভাল তবে আমি আরও একটি সম্ভাব্য বিষয় বিবেচনা করেছি। সংস্করণ নিয়ন্ত্রণ সিস্টেমে সংরক্ষিত সোর্স কোড কীভাবে উইকির সাথে সম্পর্কিত ডকুমেন্টের সাথে সংযুক্ত হতে পারে? আসুন আমরা বলি যে কেউ গিট বা মুরউরিয়াল এর ভাণ্ডার ক্লোন করে। কীভাবে সে সহজে দলিলটি খুঁজে পাবে? নাকি আমি কিছু মিস করেছি?

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


3
অবগতির জন্য: উইকি হয় না একটি আদ্যক্ষরা, এটি একটি হাওয়াইয়ান শব্দ যার অর্থ "দ্রুত" না।
জার্গ ডব্লু মিত্তাগ

ডকুমেন্টেশনে বাইনারি জড়িত তা সত্যই আপনার সংস্করণ নিয়ন্ত্রণ সিস্টেমে এটি সংরক্ষণ করা এড়াতে ভাল কারণ নয়। ভিসিএসগুলি বাইনারি ফাইলগুলি সহজেই মোকাবেলা করতে পারে। এবং যদি আপনি এটি আপনার প্রকল্পের ভিসিএসে সঞ্চয় করেন তবে আপনি যখন আপনার প্রকল্পটি শাখা করবেন তখন আপনার ডকুমেন্টেশনগুলি শাখা করতে সক্ষম হবেন আপনার সুবিধা।
JW01

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

উত্তর:


16

সফটওয়্যার বিকাশের জন্য ডকুমেন্ট সংরক্ষণ করার জন্য কি ডাব্লুআইআইআইআই কি সত্যই উপযুক্ত?

ডকস, পিডিএফ এবং অন্যান্য ধরণের ফাইল লেখার পরিবর্তে, আপনি কেন সহযোগিতার সরঞ্জাম হিসাবে ডাব্লুআইকেআইয়ের সম্পূর্ণ সম্ভাবনা প্রকাশ করবেন না? আপনি সেখানে আপনার নথিগুলি লিখতে পারেন, আপনার ডায়াগ্রামগুলি সংযুক্ত করতে পারেন এবং আরও ভাল: আপনি যদি ফিটনেস ব্যবহার করেন তবে আপনি আপনার উইকি পৃষ্ঠাগুলিকে সত্যিকারের দরকারী এবং জীবন্ত ডকুমেন্টেশনে রূপান্তর করতে পারেন, কারণ সেগুলি কার্যকরকরণযোগ্য স্পেসিফিকেশন হতে পারে।

সকলেই জানেন যে, নথিভুক্ত সফ্টওয়্যার বিকাশ সাফল্যের দিকে নিয়ে যায়

এই এক জন্য দেখুন। দস্তাবেজগুলি সাফল্যের দিকে অগ্রসর হবে না, কারণ তারা ক্রেপ কোডকে একটি ভাল রূপে পরিণত করবে না। তবে নথিগুলি সাফল্যফুল সফ্টওয়্যার যাওয়ার একটি অংশ। তবে কেবল একটি অংশ এবং তারা ভাল অনুশীলন এবং ভাল লোককে প্রতিস্থাপন করবে না।


8

একাধিক উত্তর একটি প্রস্তাব হিসাবে ট্র্যাক নির্দেশ যেহেতু আমি একটি অনুরূপ, কিন্তু ভালো আমার মতে, বিকল্প সুপারিশ চাই: Redmine

রেডমাইন উইকি, ডকুমেন্ট রিপোজিটরি এবং সংস্করণ নিয়ন্ত্রণ সংহতকরণ সহ একটি প্রকল্প পরিচালনার সমাধান। এটি আমার অভিজ্ঞতাতে রুবি অন রেলস এবং ট্র্যাকের চেয়ে প্রসারিত এবং হ্যাক করার সহজ উপায়তেও লেখা আছে।

এটি ব্যবহার করা সত্যই সহজ এবং এটি ব্যবহার করে দল পাওয়া সহজ।

বৈশিষ্ট্য:

  • একাধিক প্রকল্প সমর্থন
  • নমনীয় ভূমিকা ভিত্তিক অ্যাক্সেস নিয়ন্ত্রণ
  • নমনীয় ইস্যু ট্র্যাকিং সিস্টেম
  • গ্যান্ট চার্ট এবং ক্যালেন্ডার
  • সংবাদ, দস্তাবেজ এবং ফাইল পরিচালনা management
  • ফিড এবং ইমেল বিজ্ঞপ্তি
  • প্রতি প্রকল্প উইকি
  • প্রতি প্রকল্প ফোরাম
  • সময় ট্র্যাকিং
  • সমস্যা, সময়-এন্ট্রি, প্রকল্প এবং ব্যবহারকারীদের জন্য কাস্টম ক্ষেত্র
  • এসসিএম ইন্টিগ্রেশন (এসভিএন, সিভিএস, গিট, মার্কুরিয়াল, বাজার এবং দার্কস)
  • ইমেল মাধ্যমে তৈরি ইস্যু
  • একাধিক LDAP প্রমাণীকরণ সমর্থন
  • ব্যবহারকারীর স্ব-নিবন্ধকরণ সমর্থন
  • বহুভাষা সমর্থন
  • একাধিক ডাটাবেস সমর্থন

আপনার অফলাইন প্রয়োজনের জন্য, ডিজাইনের ডকুমেন্টগুলি সহ বিশৃঙ্খলা সংস্করণ নিয়ন্ত্রণের ধারণাটি আমি পছন্দ করি না। আমি নিশ্চিত যে এটি জিজ্ঞাসার জন্য আপনার কাছে আপনার কারণ রয়েছে তবে সত্যই আপনি কতবার অফলাইনে থাকেন এবং নকশাগুলির নকশাগুলিতে অ্যাক্সেসের প্রয়োজন হয়? সম্ভাবনা এটি সত্যিই একটি কোণার কেস।


+1 আমি কর্মক্ষেত্রে রেডমাইন ব্যবহার করি এবং এটি সত্যই দুর্দান্ত একটি সিস্টেম।
লুইজ দামিম 2'11

5

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

উপরের সেটআপের সাহায্যে উত্সটি টানতে এবং সাবমোডিয়ুলগুলি আপডেট করা ডকুমেন্টেশনের সর্বশেষ অনুলিপিটি টানতে পারে। অফলাইন, আপনি ইচ্ছামতো প্রতিটি সম্পাদনা করতে পারেন। আপনি যখন কোনও নেটওয়ার্কে ফিরে আসেন, উভয়কেই আপনি যে ভাগ করে নেওয়া অবস্থান ব্যবহার করছেন তা ফিরিয়ে দেওয়া যেতে পারে।

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


মজাদার. গিট সংগ্রহস্থলে নথিটি স্থাপন এবং আইকুইকির মাধ্যমে নথিটি সংরক্ষণ করার মধ্যে কি পার্থক্য রয়েছে?
এডিসন চুয়াং

1
@ এডিসন চুয়াং: না, নেই। প্রকৃতপক্ষে, আইকিউইকি রিপোজিটরির এক ক্লোন দেওয়া, আপনি নিজের পছন্দের পাঠ্য সম্পাদক ব্যবহার করে পৃষ্ঠা সম্পাদনা করতে পারেন (আপনাকে ক্রেপি ব্রাউজার-ভিত্তিক পাঠ্য এন্ট্রি বাক্স ব্যবহার করতে হবে না)। এমনকি পুরানো ডকুমেন্টেশন বা যা-ই হোক না কেন, স্ন্যাপশট রাখার জন্য আপনার কাছে উইকের বিভিন্ন শাখা থাকতে পারে।
গ্রেগ হিউগিল 21'50

বাইনারি ফাইল সত্ত্বেও ডকুমেন্টটি কোনও সমস্যা ছাড়াই সংস্করণ নিয়ন্ত্রণ সিস্টেমে সংরক্ষণ করা যেতে পারে বলে মনে হচ্ছে। বিকাশকারী উইকি পৃষ্ঠাগুলিকে চাহিদা অনুসারে এইচটিএমএল পৃষ্ঠায় রূপান্তর করতে কেবল আইকিউইকের মতো সরঞ্জাম ব্যবহার করতে পারেন।
এডিসন চুয়াং

ইকুইকি উইকি ইঞ্জিনের জন্য +1; Hatta উইকি ইঞ্জিন Mercurial ভান্ডার জন্য একটি অনুরূপ ধারণা।
ডেভিড কেরি

আইআরটিএস ফিটনেসও এর উইকি পৃষ্ঠাগুলিকে পাঠ্য ফাইল হিসাবে সঞ্চয় করে, তাই আপনিও যদি চান তবে সেগুলি আপনার সংস্করণ নিয়ন্ত্রণ সিস্টেমে রাখা যেতে পারে। যদিও এর প্রাথমিক উদ্দেশ্যগুলি পরীক্ষা করা হচ্ছে, আপনার ডকুমেন্টেশনের জন্য এটি সাধারণ-উদ্দেশ্য উইকি সিস্টেম হিসাবে ব্যবহার না করার কোনও কারণ নেই।
জুলে

4

সোর্স কোডের মতো একই সংগ্রহস্থলে ডকুমেন্টেশনগুলি সংরক্ষণ করা অর্থবোধ করে। স্পিংক্স আমার কাছে একটি ভাল বিকল্প বলে মনে হচ্ছে।

  • এটি ইনপুট হিসাবে পুনর্গঠিত পাঠ্য ফাইল নেয় , যা সম্পাদনা করা এবং পৃথক করা সহজ
  • এটি হাইপারলিঙ্কযুক্ত আউটপুট উত্পন্ন করে (এইচটিএমএল, পিডিএফ, ...)
  • আপনি আপনার উত্স কোডটি উল্লেখ করতে পারেন (পাইথন, সি, সি ++, জাভাস্ক্রিপ্ট)

2

ট্র্যাক সাবভার্সিয়নে একটি ইন্টারফেস, একটি সংহত উইকি এবং সুবিধাজনক প্রতিবেদনের সুবিধা সরবরাহ করে। http://trac.edgewall.org/
তবে আমি আপনার ইনস্টল করা স্ট্যাক সম্পর্কে জানি না।


এবং মার্কুরিয়ালের একটি দুর্দান্ত ইন্টারফেস। এবং এটি বিশিষ্টভাবে হ্যাকযোগ্য।
ফ্র্যাঙ্ক শায়ারার

0

আমি অফলাইন কাজের সাথে সামঞ্জস্য করার চেষ্টা করব না। আমি সেই সংস্থানটি ব্যবহার করব যা সবার সাথে কাজ করা সহজ করে তোলে its উদাহরণস্বরূপ, যদি আপনি পিএইচপি কোড লিখছেন, আমি ইনলাইন ডকুমেন্টেশন যে দ্বারা উত্পন্ন করা যেতে পারে ব্যবহার সুপারিশ করবে PHPDocumentor । এটি যে কোনও জায়গায় তৈরি করা যায় এবং ট্র্যাকের জন্য একটি প্লাগইন রয়েছে । অনলাইনে বা বন্ধ হয়ে গেলে, আপনার ডকুমেন্টেশন অ্যাক্সেস করতে হবে, প্রায় খুব দ্রুত।

কীটি ব্যবহারযোগ্যতার বিষয়ে। এটি বজায় রাখা যদি অসুবিধা হয় তবে এটি ক্ষতিগ্রস্থ হতে শুরু করবে। এটি যখন ভুগতে শুরু করে, ডকুমেন্টেশনের মান হ্রাস পায়। যখন এটি ঘটে, লোকেরা অভিযোগ করতে শুরু করে এবং তারপরে সবকিছু উতরাই হয়ে যায়।


-1

ডকুমেন্টেশন সংরক্ষণ করার জন্য একটি উইকি ব্যবহার করে আমার কাছে অনেক কিছু বোঝা যায়।

সত্যতা একটি DVCS যে উইকি বিষয়বস্তু এবং উত্স কোডের কঠিন ইন্টিগ্রেশন অনুমতি দেয় একটি উদাহরণ।

আমাদের সাইট ব্যবহার করে, আপনি স্বীকার করেছেন যে আপনি আমাদের কুকি নীতি এবং গোপনীয়তা নীতিটি পড়েছেন এবং বুঝতে পেরেছেন ।
Licensed under cc by-sa 3.0 with attribution required.