প্রকল্পের ডকুমেন্টেশন, স্পেসিফিকেশন সংগঠিত এবং বজায় রাখতে সফ্টওয়্যার? [বন্ধ]


15

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

প্রয়োজনীয়তা, পছন্দসমূহ:

  • ক্লায়েন্ট সাইডে জিরো ইনস্টল (ডাব্লুইইবি ভিত্তিক)।
  • নথি সংস্করণ নিয়ন্ত্রণ।
  • নথি টীকা
  • দলিল সংযোগ।
  • সম্পূর্ণ অনুসন্ধান (সমস্ত নথিপত্র)।
  • এমএস ওয়ার্ড (* .ডোক) আমদানি \ রফতানি।
  • WYSIWYG পাঠ্য সম্পাদক।

আমি এখনও অবধি সিস্টেমগুলি আবিষ্কার করেছি এবং চেষ্টা করেছি:


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

@ ডকব্রাউন, 95% পাঠ্য, 3-5 জন এটি লিখবেন। আমি সফ্টওয়্যার পণ্য সংস্করণগুলির সাথে সিঙ্ক করছি তবে উত্স কোড সংশোধন নয়।
অ্যালেক্স বার্টসেভ

এক্সউইকি দেখতে একটি দুর্দান্ত সমাধান এটি মুক্ত বলে মনে হচ্ছে এটি দুর্দান্তভাবে এমএস অফিসের সাথে সংহত করে।
অ্যালেক্স বার্টসেভ

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

পিএইচপিকেবির মতো জ্ঞান পরিচালন সফ্টওয়্যার সম্পর্কে কীভাবে ? এটি নিখরচায় নয় তবে মনে হয় আপনার উদ্দেশ্যটি খুব ভালভাবে পরিপূর্ণ হয়।
অনিরুদ্ধ শ্রীবাস্তব

উত্তর:


6

স্পিনক্সের মতো কীভাবে ?

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

দুটি সর্বাধিক বিশিষ্ট স্পিংক্স ব্যবহারকারী (যা আমি জানি) হলেন পাইথন ল্যাঙ্গুয়েজ এবং টরটোইসএইচজি (স্পিনেক্স তৈরি হওয়া ডকুমেন্টেশনের লিঙ্কগুলি দেখুন)।


সম্পাদনা করুন:

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

  1. আপনি সহজেই দস্তাবেজগুলিকে নিয়ন্ত্রণ করতে পারেন (এবং পাঠ্য ফাইলগুলির বিভিন্নতা বাইনারি ফাইলগুলি .doc বা .pdf এর চেয়ে অনেক কম জায়গা নেয়)।
  2. যদি কোনও বিকাশকারী একটি দুর্দান্ত পঠনযোগ্য .ডোক বা .pdf ফাইল চান, তবে তিনি উত্স থেকে স্পিনিক্স দিয়ে এটি তৈরি করতে পারেন।

যদি স্ফিংকস খুব জটিল হয় তবে আরও সহজ উপায় আছে: আপনি মার্কডাউনে আপনার ডকুমেন্টেশন লিখতে পারেন এবং প্যান্ডোক ব্যবহার করতে পারেন (উদাহরণস্বরূপ) .rtf, .doc বা .pdf ফাইল (এটি আরও অনেক কিছু করতে পারে)।
স্প্যানিক্সের চেয়ে পান্ডোক শুরু করা সহজ পেয়েছি তবে প্যানডোক স্পিনক্সের মতো সুন্দর মেনু স্তরক্রম তৈরি করতে পারে না (যেমন আমি পাইথন এবং টরটোইসএইচজি ডকুমেন্টেশনের মতো উপরে লিঙ্ক করেছি)।

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


দেখে মনে হচ্ছে এটি ঠিক এইচটিএমএল জেনারেট করে তারপর আমাকে এটি একটি ওয়েব সার্ভারে প্রকাশ করতে হবে
অ্যালেক্স বার্টসেভ

1
@ অ্যালেক্সবার্টসেভ: আপনি যদি এটি সর্বজনীন হতে চান তবে হ্যাঁ। অন্যদিকে - এখন আপনি ওয়ার্ড। ডক ফাইলগুলি ব্যবহার করছেন, সুতরাং আপনি যদি সর্বজনীন চান তবে আপনাকে এগুলি একটি ওয়েব সার্ভারে রেখে দিতে হবে।
ক্রিশ্চিয়ান স্পেচট

আমি লক্ষ করেছি যে স্পিনিক্সের একটি "পিডিএফ থেকে পিডিএফ" পথ রয়েছে।
রবার্ট হার্ভে

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

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

5

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

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


1
আমাদের ইতিমধ্যে একটি শেয়ারপয়েন্ট সার্ভার রয়েছে তবে বিকাশকারীরা এটি পছন্দ করেন না এবং এটি ব্যবহার করতে চান না (আমি নিজেই বিকাশকারী)। আমরা এমন কিছু চাই যেখানে আমরা সহজেই আমাদের প্রয়োজনীয় তথ্য সন্ধান করতে পারি। শ্রেণিবদ্ধ এবং লিঙ্কযুক্ত তথ্য।
অ্যালেক্স বার্টসেভ

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

আমি বর্তমানে XWiki এর এমএস অফিসের সংহতকরণের জন্য চেষ্টা করছি
অ্যালেক্স বার্টসেভ

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

2

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

  1. ট্র্যাক - বাগ-ট্র্যাকিং সিস্টেম এবং জ্ঞান ইঞ্জিন ব্যবহার করা সহজ। পাইথনে লেখা এবং এক্সটেনসিবল, আপনি কয়েক মিনিটের মধ্যে উঠে পড়বেন running
  2. মঈন মঈন - পূর্ণ-উইকি ইঞ্জিন। আবার পাইথন অনেকগুলি বৈশিষ্ট্য সহ

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


2

আমরা সম্প্রতি আলফ্রেসকো ব্যবহার শুরু করেছি ডিএমএস যার অনেক আকর্ষণীয় বৈশিষ্ট্য রয়েছে:

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

এর কিছু অসুবিধাও রয়েছে:

  • ব্যবহারকারীর ইন্টারফেস সর্বদা স্বজ্ঞাত নয়
  • এটি আসলে উইকি নয়, সুতরাং একটি নথিতে একযোগে সহযোগী কাজ কিছুটা ভঙ্গুর হতে পারে

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


0

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


আমি সফ্টওয়্যার পণ্য ডকুমেন্টেশন (সহায়তা, ম্যানুয়াল) সম্পর্কে কথা বলছি না আমি সফটওয়্যার স্পেসিফিকেশন, ব্যবসায়ের প্রয়োজনীয়তা সম্পর্কে কথা বলছি।
অ্যালেক্স বার্টসেভ

আপনি লটেক্সে সফ্টওয়্যার স্পেসিফিকেশন বা কোনও প্রযুক্তিগত ডকুমেন্ট লিখতে পারেন এবং কয়েকটি চেনাশোনাতে এটি সাধারণ অনুশীলন।
বাসাইল স্টারিনকিভিচ

2
লেটেক্সট কোনওভাবে আমাকে * এনআইএক্সের কথা মনে করিয়ে দেয়, এবং আমাদের বিশ্লেষকরা কখনই এই জাতীয় ওএসের ঝাঁক না রাখেন -), তারা উইন্ডোজ জগতে থাকেন এবং পাঠ্য ইনপুটটির জন্য ওয়ার্ডের চেয়ে শক্ত যে কোনও বিষয়ে সম্মত হন না।
অ্যালেক্স বার্টসেভ

-2

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

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

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