سلام devs! 👋 من اخیراً Dokugen را ساختم-ابزاری با قدرت هوش مصنوعی که پرونده های readme.md را به طور خودکار بر اساس مخزن GitHub شما تولید می کند.
من این را ایجاد کردم زیرا متوجه بسیاری از شیاطین شدم:
وقت زیادی را صرف نوشتن خواندن های دقیق کنید
در پایان با مستندات پروژه ناقص یا مفقود شده
بنابراین من فکر کردم: چرا آن را خودکار نمی کنیم؟
Dokugen چیست؟
Dokugen یک ابزار CLI با منبع باز است که repo github شما را اسکن می کند و فوراً یک readme حرفه ای و حرفه ای برای شما ایجاد می کند. این کد شما را تجزیه و تحلیل می کند و تولید می کند:
✅ توضیحات روشن پروژه
مراحل نصب و راه اندازی
✅ نمونه های استفاده
✅ ویژگی ها و فن آوری های مورد استفاده
✅ دستورالعمل مشارکتی
همه فقط در یک دستور!
چگونه کار می کند
1⃣ نصب سند:
NPM نصب -g dokugen
2⃣ آن را در پوشه پروژه خود اجرا کنید:
npx dokugen تولید می کند
3⃣ رونق! readme.md شما تولید می شود.
چرا این را ساختم
من بسیاری از پروژه های منبع باز و بدون رژیم مناسب را دیده ام-که درک و استفاده آنها را سخت می کند. من می خواستم آن را برطرف کنم.
با Dokugen ، می توانید:
🚀 در نوشتن مستندات وقت صرفه جویی کنید
🔥 پروژه های خود را فوراً حرفه ای جلوه دهید
🤝 مشارکت کنندگان بیشتری در repo خود جذب کنید
🚀 آن را امتحان کنید!
Dokugen رایگان و منبع باز است! می توانید آن را در اینجا بررسی کنید:
🔗 gimub: 
github.com/samueltuoyo15/dokugen
دوست دارم افکار خود را بشنوم! نظر شما چیست؟ از ویژگی هایی که دوست دارید من اضافه کنم؟ بیایید در نظرات بحث کنیم! 😊
