প্রকল্প সম্পর্কে

বিউটিফুল ডক্স হলো এমন একটি কিউরেটেড রেফারেন্স, যা সফটওয়্যার বা একাধিক ব্যবহারকারীর জন্য তৈরি অন্যান্য প্রকল্পের ডকুমেন্টেশন তৈরিতে সহায়তা করে। এটি নিজে ডকুমেন্টেশন তৈরি করে না; বরং এটি ভালোভাবে স্বীকৃত উদাহরণ এবং সহায়ক সম্পদের লিংক প্রদান করে। ডকুমেন্টেশনের উদাহরণগুলোর মধ্যে রয়েছে ভাষা ও ফ্রেমওয়ার্ক রেফারেন্স, API গাইড, অপারেটিং সিস্টেম ম্যানুয়াল, ডেটাবেস এবং ডেভেলপার সার্ভিস। তালিকায় রয়েছে Redis Commands, GitHub Developer Docs, Django, Ruby on Rails, Stripe, Rust, MongoDB, FastAPI এবং Supabase। কিছু এন্ট্রিতে ইন্টারঅ্যাকটিভ উদাহরণ, ভার্সনিং, সার্চ, সংক্ষিপ্ত লেখা, ডায়াগ্রাম, নেভিগেশন বা ভাষা সমর্থনের মতো বিশেষ বৈশিষ্ট্য তুলে ধরা হয়েছে। দ্বিতীয় বিভাগে টেকনিক্যাল রাইটিং এবং ডকুমেন্টেশন ডিজাইন সংক্রান্ত সম্পদ রয়েছে, যেমন TomDoc, Write the Docs, Google Developer Documentation Style Guide, API Blueprint এবং Diátaxis। শেষ বিভাগে ডকুমেন্টেশন তৈরি, রূপান্তর, প্রকাশ বা রক্ষণাবেক্ষণের টুল তালিকাভুক্ত, যেমন Sphinx, MkDocs, Read the Docs, Slate, Docusaurus, VuePress, VitePress, Docsify, Pandoc এবং Doxygen। রিপোজিটরিটি পুল রিকোয়েস্টের মাধ্যমে রক্ষণাবেক্ষণ করা হয়। অবদানকারীদের বলা হয় যে তারা কেন একটি আইটেম উপযোগী তা ব্যাখ্যা করুন, নিজের বা মূল অবদানকারীর পরিচয় দিন এবং তালিকার সংযোজনের ক্রম বজায় রাখুন।