ForHosting KIT · أدوات المطورين

لا تكتب README من الصفر بعد اليوم

أداة توليد README تأخذ وصفًا لمشروعك — الغرض منه، قائمة الملفات الرئيسية، أوامر التثبيت والتشغيل — وتنتج ملف README مرتب بالأقسام المعتادة: مقدمة، تثبيت، استخدام، ترخيص. توفر عليك كتابة المستند من الصفر، وهي حاليًا في مرحلة تجريبية تستحق مراجعة قبل النشر النهائي.

● Betaلكل طلب · لكل مستودع$0.003

تشغيل — $0.003 + $0.0135/مستودع اطّلع على الـAPI

استخدمها من الويبAPIالبريدالتطبيق قريبًاTelegram قريبًا

شغّلها أونلاين

شغّل هذه المهمة على خوادمنا باستخدام حسابك. الأدوات المجانية تعمل داخل متصفحك، أما هذه فتُخصم من رصيدك في KIT حسب السعر الموضّح أعلاه.

ماذا تحتاج الأداة منك

لا تصل الأداة إلى مستودعك ولا تفحصه تلقائيًا؛ تعتمد على ما تصفه أنت: اسم المشروع وغرضه، قائمة مختصرة بالملفات أو المجلدات المهمة، وأوامر التثبيت والتشغيل الأساسية. كلما كان الوصف أدق، جاء الملف الناتج أقرب لما تحتاجه فعلًا دون تعديل كبير لاحقًا. يمكن أيضًا إرفاق نقاط متفرقة غير منظمة وتترك للأداة ترتيبها في أقسام واضحة بدل صياغتها بنفسك من الصفر. هذا يناسب خصوصًا مطوّرًا يعرف مشروعه جيدًا لكنه يكره صياغة التوثيق أكثر من كتابة الكود نفسه.

الأقسام التي ينتجها الملف

ينتج README منظمًا بالأقسام المتوقعة من مطوّر يزور المشروع أول مرة: مقدمة موجزة عن الغرض، خطوات التثبيت، أمثلة استخدام أساسية، وقسم مساهمة إن طلبته. الترتيب يتبع العرف الشائع في مشاريع البرمجيات المفتوحة، فيشعر أي زائر بأنه أمام توثيق مألوف الشكل لا حاجة لتعلّم بنية غريبة لفهمه، وهو ما يرفع فرصة أن يجرب أحدهم المشروع فعلًا بدل مغادرة الصفحة بلا فهم.

السعر لكل مشروع

$0.003 لكل طلب زائد $0.0135 لكل مشروع (repo) يُولَّد له README، أي نحو $0.0165 للمستند الواحد بصرف النظر عن طوله. تحديث README لخمسة مشاريع مختلفة يكلف نحو $0.08 إجمالًا، دون اشتراك شهري ولا حد أدنى للاستخدام. الدفع عبر PayPal، والتواصل المباشر عبر واتساب أو البريد متاح لمن يفضّله. مقارنة بالوقت الذي تستغرقه صياغة README من الصفر يدويًا، خصوصًا لمن يؤجل هذه المهمة أسابيع، السعر الرمزي يستحق التوفير في الوقت والتردد.

راجع قبل النشر

الأداة في مرحلة تجريبية (beta)، والملف الناتج مسودة قوية توفر معظم العمل، لكنها لا تعرف تفاصيل خاصة بمشروعك لم تذكرها في الوصف — مثل رخصة محددة أو رابط توثيق خارجي. راجع الملف كاملًا وأضف ما ينقصه قبل نشره في المستودع الفعلي، خصوصًا أقسام الترخيص والتواصل التي تفضّل غالبًا صياغة دقيقة بلا تخمين. هذه المراجعة لا تستغرق وقتًا طويلًا عادة، لأن البنية العامة والأقسام الأساسية تصل جاهزة؛ ما يبقى غالبًا تفاصيل دقيقة يعرفها صاحب المشروع وحده.

حالات الاستخدام

فتح مصدر أداة داخلية أول مرة

مطوّر في شركة الخليج الرقمية يجهّز أداة داخلية للنشر كمصدر مفتوح، فيولّد README يشرح الغرض وخطوات التثبيت لمن يزور المستودع أول مرة.

مستودع لمراجعة مستثمر تقني

شركة ناشئة في دبي تجهّز مستودعها لمراجعة مستثمر تقني، وتحتاج توثيقًا واضحًا يشرح المشروع دون اجتماع تعريفي طويل.

مشروع تخرج قبل التسليم

طالبة في جامعة الملك سعود تولّد README لمشروع تخرجها البرمجي قبل التسليم، لتشرح خطوات تشغيله لمن يقيّمه لاحقًا.

الأسئلة الشائعة

هل تصل الأداة إلى مستودعي مباشرة؟

لا، تعتمد فقط على الوصف الذي تكتبه: اسم المشروع والملفات المهمة وأوامر التشغيل؛ لا اتصال بمستودعك الفعلي.

هل تُحفظ المعلومات التي أرسلها عن مشروعي؟

لا، تُستخدم لإنتاج الملف فقط ولا تُحفظ بعد اكتمال الطلب.

لماذا الأداة في مرحلة تجريبية؟

لأن جودة الناتج تعتمد كثيرًا على دقة الوصف المُرفق؛ ننصح بمراجعة الملف كاملًا قبل نشره.

بأي لغة يُكتب README؟

تحدّد اللغة عند الطلب؛ يمكن توليده بالعربية أو الإنجليزية حسب جمهور مشروعك.

كم سعر توليد ملف واحد؟

نحو $0.0165 للمشروع الواحد: $0.003 للطلب زائد $0.0135 للمستودع.

هل يشمل الملف قسم الترخيص؟

إذا ذكرت الترخيص في وصفك يُضاف كقسم منظم؛ الأداة لا تختار ترخيصًا نيابة عنك.

للمطوّرين — الوصول عبر API

كل ما في هذه الصفحة متاح برمجيًا. هذا القسم موجّه للفرق التقنية التي تريد ربط الأداة بأنظمتها الخاصة؛ بقية المستخدمين يمكنهم استخدام الأداة أعلاه مباشرة دون الحاجة لقراءة ما يلي.

الـEndpoint

POSThttps://api.kit.forhosting.com/dev/readme

صادِق على طلبك بترويسة Bearer، وأرسل طلب POST واحدًا لتدخل مهمتك قائمة التنفيذ فورًا؛ ثم تستلم النتيجة عبر webhook أو رابط موقّع.

استدعِ الخدمة من بيئتك

curl -X POST https://api.kit.forhosting.com/dev/readme \
  -H "Authorization: Bearer $KIT_KEY" \
  -H "Content-Type: application/json" \
  -d &#39;{"input":"…"}'

const res = await fetch("https://api.kit.forhosting.com/dev/readme", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.KIT_KEY}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "input": "…"
  })
});
const { task_id } = await res.json();

import os, requests

res = requests.post(
    "https://api.kit.forhosting.com/dev/readme",
    headers={"Authorization": f"Bearer {os.environ[&#39;KIT_KEY']}"},
    json={
    "input": "…"
},
)
task_id = res.json()["task_id"]

<?php
$res = file_get_contents("https://api.kit.forhosting.com/dev/readme", false, stream_context_create([
  "http" => [
    "method"  => "POST",
    "header"  => "Authorization: Bearer " . getenv("KIT_KEY") . "\r\nContent-Type: application/json",
    "content" => &#39;{"input":"…"}',
  ],
]));
$task = json_decode($res, true);

body := bytes.NewBufferString(`{"input":"…"}`)
req, _ := http.NewRequest("POST", "https://api.kit.forhosting.com/dev/readme", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("KIT_KEY"))
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)

مثال على الطلب

{
  "input": "…"
}

مثال على الاستجابة

{
  "task_id": "tsk_a1b2c3d4e5f6a1b2c3d4e5f6",
  "type": "dev.readme",
  "status": "queued",
  "_links": {
    "result": "/tasks/tsk_…/result"
  }
}

الواجهة غير متزامنة: تستلم task_id فور الإرسال، ويمكنك الاستعلام عن الحالة بمعدل طلب واحد في الثانية.

الأسعار

لكل طلب$0.003

لكل مستودع$0.0135

السعر معلن كما تراه: لا tokens ولا نظام نقاط؛ وإن فشلت المهمة فلن تُحاسَب عليها.

الأخطاء

HTTP	الرمز	المعنى
`401`	`unauthorized`	مفتاح الوصول مفقود أو غير صالح؛ تحقق من ترويسة Bearer في طلبك.
`402`	`insufficient_balance`	رصيدك لا يكفي لتنفيذ هذه المهمة؛ أعد شحن الرصيد ثم أعد المحاولة.
`404`	`unknown_type`	نوع المهمة المطلوب غير موجود في الكتالوج — راجع الاسم المرسل في الطلب.
`429`	`rate_limited`	تجاوزت الحد المسموح من الطلبات؛ انتظر قليلًا ثم أعد المحاولة.
`422`	`task_failed`	لم تنجح معالجة المهمة، ولن تُحتسب عليك؛ أعد المحاولة أو راسلنا مباشرة.

اطّلع على توثيق KIT الكامل ←