ওপেন সোর্স প্রকল্পের ডকুমেন্টেশন কীভাবে পরিচালনা করবেন? [বন্ধ]


12

আমি ক্রমবর্ধমান ওপেন সোর্স প্রকল্পের নির্মাতা। বর্তমানে, ডকুমেন্টেশন পরিচালনা করার সেরা উপায়টি বের করার চেষ্টা করে আমি হিমশিম খাচ্ছি। আমি বিবেচনা করেছি বিকল্পগুলি এখানে:

  • এইচটিএমএল ওয়েবসাইট
  • একটি গিথুব উইকি
  • মার্কডাউন ফাইলগুলি গিথুব-এ হোস্ট করা হয়েছে
  • সমস্ত ডক্স গিথুব README.md এ স্থাপন করা হচ্ছে

ডকুমেন্টেশনটি ইতিমধ্যে মার্কডাউনে লেখা আছে, আমি কীভাবে এটি উপলব্ধ করতে চাই তা বুঝতে পারি না। আমি সত্যিই গিতের দিকে টানছি যেহেতু আমি ডকুমেন্টেশনটি শাখা এবং ট্যাগ করতে পারি ঠিক যেমন আমি উত্সটি শাখা এবং ট্যাগ করতে পারি।

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

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

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

আমি কি কিছু দুর্দান্ত সমাধান মিস করছি? আমার আর কোন বিকল্প নেই?


1
যদিও আমার কাছে সত্যিই কোনও উত্তর নেই, আমি গিথুব উইকির সাহায্যে ডকুমেন্টেশন পরিচালনা করার জন্য এই ব্লগ পোস্টটি জুড়ে এসেছি। cach.me/blog/2010/12/… আপনি এটি দরকারী খুঁজে পেতে পারেন।
জ্যাকব শোয়ান

উত্তর:


6

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

অন্য কোনও ফাংশন ঠিক করার / যুক্ত করার এবং একই ফাইলের সাথে সাথে সংলগ্ন কিছু মার্কআপ ডকুমেন্টেশন সম্পাদনা / যুক্ত করার সম্ভাবনা কম হতে পারে তবে এটি করার জন্য ভিন্ন ডকুমেন্টের ভাণ্ডারে সম্পূর্ণ আলাদা ফাইল সন্ধানের সুযোগটি কিছুটা কম may শূন্যের চেয়ে কম

আপনার সর্বদা একটি টিউটোরিয়াল হ'তে থাকতে পারে that এতে আপনার চাইলে পাঠ্যের বড় ব্লক রয়েছে - তবে এটি উত্সের অংশ হিসাবে বিবেচনা করুন


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

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

4

যদি আপনার প্রকল্পটি একটি লাইব্রেরি হয় তবে কোডের মধ্যে থাকা মন্তব্য থেকে API সিনট্যাক্সটি নথিভুক্ত করার জন্য জাভাদোক-শৈলীর ডকুমেন্টেশন কিছুই হারায় না।

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

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

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

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


1

উত্স সহ হোস্ট করা মার্কডাউন ফাইলগুলি অত্যন্ত ভাল কাজ করে।

আরএসটি-ভিত্তিক ডকুমেন্টাল সরঞ্জামগুলি উদাহরণস্বরূপ, ডকুমেন্টগুলির একটি সেট থেকে এইচটিএমএল বা ল্যাটেক্স (এবং পিডিএফ) তৈরি করতে পারে।

এটি - কার্যত - আপনার বিকল্প 1 এবং বিকল্প 3 এর সাথে সম্মিলিত।


0

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


1
আপনি এটি কি করে সে সম্পর্কে আরও ব্যাখ্যা করতে আপত্তি করবেন এবং আপনি কেন জিজ্ঞাসিত প্রশ্নের উত্তর হিসাবে এটি সুপারিশ করবেন? "লিঙ্ক কেবল-উত্তর" বেশ স্ট্যাক এক্সচেঞ্জ এ স্বাগত জানাই হয় না
মশা
আমাদের সাইট ব্যবহার করে, আপনি স্বীকার করেছেন যে আপনি আমাদের কুকি নীতি এবং গোপনীয়তা নীতিটি পড়েছেন এবং বুঝতে পেরেছেন ।
Licensed under cc by-sa 3.0 with attribution required.