টেকনিক্যাল ডকুমেন্টেশন অটো জেনারেশন
কোড কমেন্ট থেকে API ডকুমেন্টেশন থেকে আর্কিটেকচার ডায়াগ্রাম—কোড লেখা শেষ হলেই ডকুমেন্টেশন তৈরি
ডকুমেন্টেশন এই পিট, যে খুঁড়ে সে জানে
কোড বিশ বার বদল হয়েছে, README এখনো তিন মাস আগের। নতুন কর্মচারী ডকুমেন্টেশন পড়ে একবার রান করে, সব এরর। পরে জিজ্ঞাসা করলেই শোনে "সেই ডকুমেন্টেশন পুরানো"।
কোনো ডকুমেন্টেশন লেখার ইচ্ছে নেই। ডেভেলপার বলে "কোডটাই ডকুমেন্ট", প্রোডাক্ট বলে "তুমি লেখো আমি দেখব", শেষে কেউ লেখে না, মুখোমুখি বলাবলি করে।
কঠিনে করে API ডকুমেন্টেশন লিখেছেন, লাইভ হওয়ার পর দুটো ফিল্ড বদল হয়েছে সিঙ্ক করতে ভুলেছেন, ফ্রন্টএন্ড গাইস পুরানো ডকুমেন্টেশন দেখে অর্ধদিন বসে, এসে আপনার কাছে হিসাব চায়।
OpenClaw কে ডকুমেন্টেশনের কাজ সামলাতে দিন
OpenClaw সরাসরি আপনার সোর্স কোড পড়ে—ফাংশন সিগনেচার, প্যারামিটার টাইপ, রিটার্ন ভ্যালু, কমেন্ট, কল রিলেশন, সব কিছু বিশ্লেষণ করে, তারপর স্ট্রাকচার্ড ডকুমেন্টেশন জেনারেট করে।
সেই ধরনের "এই ফাংশন একটা প্যারামিটার নেয়" আবর্জনা ডকুমেন্ট না। প্রতিটি ইন্টারফেসের পারপাস, প্যারামিটার এক্সপ্লেনেশন, রিটার্ন এক্সাম্পল, এরর কোড লিখবে, যা দরকার সব আছে।
কোড বদল হয়েছে? আবার একবার Prompt চালান, ডকুমেন্টেশন আপনা আপনা আপডেট হয়ে যায়। আর কখনো ডকুমেন্টেশন এবং কোড ডিসকানেক্ট হওয়ার চিন্তা নেই।
ডকুমেন্টেশন জেনারেশন Prompt, সরাসরি ব্যবহার করুন
README থেকে API ডকুমেন্টেশন থেকে আর্কিটেকচার ডায়াগ্রাম, তিনটা Prompt দিয়ে সব সেরে যায়।
এই প্রজেক্টের সম্পূর্ণ কোড স্ট্রাকচার বিশ্লেষণ করুন, একটা প্রফেশনাল README.md জেনারেট করুন।
এই চ্যাপ্টারগুলো অন্তর্ভুক্ত করুন:
1. প্রজেক্ট ইন্ট্রোডাকশন: এক দুই লাইনে এই প্রজেক্ট কী করে
2. ফিচার: bullet points দিয়ে কোর ফাংশনালিটি
3. কুইক স্টার্ট: ইনস্টল, কনফিগ, রান এর স্টেপস (কপি পেস্ট যাবে)
4. প্রজেক্ট স্ট্রাকচার: ডিরেক্টরি ট্রি + প্রতিটা ডিরেক্টরির ছোট এক্সপ্লেনেশন
5. কনফিগারেশন এক্সপ্লেনেশন: এনভায়রনমেন্ট ভেরিয়েবল, কনফিগ ফাইল এক্সপ্লেনেশন
6. API ছোট এক্সপ্লেনেশন (থাকলে)
7. সাধারণ প্রশ্ন
স্টাইল রিকোয়ারমেন্ট: সংক্ষিপ্ত এবং পরিষ্কার, আবর্জনা লেখবেন না। এক্সাম্পল কোড সম্পূর্ণ এবং চালানোর যোগ্য হতে হবে।প্রজেক্টের সব API রুট/কন্ট্রোলার ফাইল পড়ুন।
প্রতিটা ইন্টারফেসের জন্য স্ট্যান্ডার্ড API ডকুমেন্টেশন (Markdown ফরম্যাট) জেনারেট করুন, এই জিনিসগুলো নিয়ে:
1. ইন্টারফেস পাথ এবং রিকোয়েস্ট মেথড (GET/POST/PUT/DELETE)
2. ফাংশনালিটি ডেসক্রিপশন: এই ইন্টারফেস কী কাজ করে
3. রিকোয়েস্ট প্যারামিটার: প্যারামিটার নাম, টাইপ, প্রয়োজনীয় কি না, এক্সপ্লেনেশন, এক্সাম্পল ভ্যালু
4. রিকোয়েস্ট বডি এক্সাম্পল (JSON ফরম্যাট)
5. রেসপন্স এক্সাম্পল: সফল এবং ব্যর্থ রিটার্ন ভ্যালু
6. এরর কোড এক্সপ্লেনেশন
7. অথেনটিকেশন রিকোয়ারমেন্ট (token দরকার হলে)
মডিউল অনুযায়ী গ্রুপ করুন, নেভিগেশন মেনু যোগ করুন।এই প্রজেক্টের সম্পূর্ণ কোড স্ট্রাকচার এবং মডিউল ডিপেন্ডেন্সি রিলেশন বিশ্লেষণ করুন।
নিম্নলিখিত Mermaid ডায়াগ্রাম জেনারেট করুন:
1. সিস্টেম আর্কিটেকচার ডায়াগ্রাম (flowchart):
- মূল মডিউল এবং তাদের ইন্টারঅ্যাকশন রিলেশন দেখান
- ডেটা ফ্লো ডিরেকশন মার্ক করুন
- ফ্রন্টএন্ড, ব্যাকএন্ড, ডাটাবেস, থার্ড-পার্টি সার্ভিস আলাদা করুন
2. মডিউল ডিপেন্ডেন্সি ডায়াগ্রাম (flowchart):
- কোড মডিউলের মধ্যে import/ডিপেন্ডেন্সি রিলেশন দেখান
- কোর মডিউল এবং ইউটিলিটি মডিউল মার্ক করুন
3. ডেটা ফ্লো ডায়াগ্রাম (sequenceDiagram):
- একটা কোর বিজনেস লজিকের সম্পূর্ণ রিকোয়েস্ট চেইন দেখান
- ইউজার অপারেশন থেকে ডাটাবেস থেকে রিটার্ন
প্রতিটা ডায়াগ্রাম টেক্সট এক্সপ্লেনেশন সহ, কী ডিজাইন সিদ্ধান্ত সেখানে বুঝান।ডকুমেন্টেশন জেনারেশন: OpenClaw vs ChatGPT
দুটোই ডকুমেন্টেশন জেনারেট করতে পারে, কিন্তু পদ্ধতি সম্পূর্ণ আলাদা।
- সরাসরি প্রজেক্ট সোর্স কোড পড়ুন, ডকুমেন্টেশন রিয়েল কোড ভিত্তিতে
- ফাইল রেফারেন্স রিলেশন বুঝুন, API ডকুমেন্টেশন সঠিক এবং সম্পূর্ণ
- কোড আপডেট করার পর রি-জেনারেট করুন, ডকুমেন্টেশন আপনা আপনা সিঙ্ক
- Mermaid আর্কিটেকচার ডায়াগ্রাম, সিকোয়েন্স ডায়াগ্রাম জেনারেশন সাপোর্ট
- ম্যানুয়ালি কোড কপি পেস্ট করতে হয়, কন্টেক্সট লিমিটেড
- সম্পূর্ণ প্রজেক্ট স্ট্রাকচার দেখতে পাবে না, ইন্টারফেস মিস করতে পারেন
- জেনারেট করা ডকুমেন্টেশন ওয়ান-টাইম, কোড বদল হলে আবার নতুন করে
- বড় প্রজেক্ট কোড token লিমিট ছাড়িয়ে যায়, একবারে প্রসেস করতে পারে না