راهنمای نهایی در مورد نحوه ایجاد یک فایل Readme.txt

اگر شما یک برنامه نویس تازه کار افزونه وردپرس هستید، حتما این اصطلاح را شنیده اید readme.txt مطمئنا. این یک فایل متنی است که با قالب بندی نحوی علامت گذاری شده است. این سند شامل اطلاعات مقدماتی به همراه سایر مشخصات فنی یک افزونه است.

بیش از 60 هزار افزونه در مخزن وردپرس موجود است. اما، تنها تعداد انگشت شماری از آنها دارای یک فایل readme.txt خوش نوشته هستند. عدم وجود متن readme مناسب SEO بر حضور آنلاین افزونه شما تأثیر می گذارد.

در عین حال کاربران را از دسترسی به اطلاعات محروم می کند. بنابراین، شما باید یک فایل readme کامل شامل کلمات کلیدی، توضیحات، ویژگی ها، شماره نسخه، تغییرات و موارد دیگر بنویسید.

نوشتن یک سند readme آسان تر است، اما باید چند نکته فنی را نیز در نظر داشته باشید. در این مقاله، ما به شما نشان می دهیم که چگونه یک فایل readme.txt برای پلاگین های بعدی خود ایجاد کنید.

با کلیک بر روی لینک های زیر به سرعت به بخش ها بروید:

آنچه در واقع Readme.txt است

یک فایل readme به کاربران درباره یک پروژه/نرم افزار با توضیحات مفصلی که شامل اطلاعات اولیه، دستورالعمل‌های نحوه انجام، پرسش‌های متداول، اطلاعیه ارتقا و موارد دیگر است، اطلاع می‌دهد.

همه افزونه های وردپرس باید فایل PHP اصلی را به همراه فایل readme.txt داشته باشند. readme.txt معمولاً با استفاده از یک زیرمجموعه به خوبی تعریف شده از markdown نوشته می شود. شما اطلاعات مورد نیاز را با فرمت صحیح اضافه می کنید و مخزن وردپرس آن را با استفاده از زبان علامت گذاری تجزیه می کند.

اطلاعات را از فایل readme.txt می کشد و در مخزن عمومی قرار می دهد. سپس اطلاعات در بخش های مختلف صفحه پلاگین خاص ظاهر می شود و همه کاربران می توانند آنها را ببینند.

میکا اپستاین، یک نماینده تیم بررسی افزونه وردپرس، به درستی گفت:

در قلب آن، فایل Readme.txt بسیار ابتدایی است. شما اطلاعات را وارد می کنید، یک صفحه وردپرس ایجاد می کند. البته، این همه جادوی ساده نیست و چیزهای عجیبی وجود دارد که باید از آنها آگاه بود.

شما نمی توانید آنطور که برای افزونه خود مناسب می دانید متن ساده بنویسید. وردپرس از یک رویه جهانی پیروی می کند تا همه چیز را هماهنگ نگه دارد. دسترسی به مخاطبان هدف خود با یک فایل readme ضعیف دشوار است. بنابراین، در بخش بعدی این وبلاگ درباره نحوه ایجاد یک فایل Readme.txt برای وردپرس بحث کرده ایم. برای یادگیری بیشتر خواندن را ادامه دهید.

چرا فایل‌های Readme.txt برای پلاگین‌های شما اهمیت دارند؟

یک readme.txt نامرغوب به این معنی نیست که شما یک محصول غیر استاندارد دارید. اما، مطمئناً نشان می دهد که توجه کمتری به جزئیات دارید. برعکس، یک فایل readme عالی ممکن است در ابتدا مخاطبان شما را تحت تاثیر قرار دهد، حتی اگر محصول شما در حد استاندارد نباشد.

در اینجا لیستی از مزایای نوشتن یک فایل readme.txt عالی آورده شده است.

• یک readme.txt که به خوبی نوشته شده است به رتبه بندی افزونه شما کمک می کند
• این به شما امکان می دهد افزونه خود را به تمام دنیا معرفی کنید
• شما می توانید ویژگی های شگفت انگیز محصول خود را خم کنید
• این به کاربران بالقوه در مورد فرآیند نصب آموزش می دهد
• به رایج ترین سوالاتی که ممکن است یک کاربر داشته باشد پاسخ می دهد
• یک readme.txt می‌تواند به وب‌سایت شما و سایر محصولات پیوند دهد
• شما می توانید محصولات و خدمات خود را به صورت ماهرانه بفروشید

اکنون، فواید آن را می دانید. بیایید یاد بگیریم که چگونه یک فایل readme.txt عالی بنویسیم.

چگونه یک فایل Readme.txt برای افزونه وردپرس خود بسازیم

یک فایل readme.txt معمولاً حاوی اطلاعات سرصفحه، توضیحات، پرسش‌های متداول، اسکرین‌شات‌ها و اطلاعات دیگر است. بخش زیر دستورالعمل های دقیق و مختصری در مورد نحوه نوشتن کامل هر بخش دارد. به خواندن ادامه دهید تا هنر نوشتن فایل‌های readme.txt برای افزونه وردپرس خود را بیاموزید.

1. درک نحو Markdown چیست

هنگام نوشتن readme.txt باید از دستور markdown پیروی کنید. Markdown به یک سیستم قالب بندی متن ساده اشاره دارد که متن ساده را به HTML تبدیل می کند. می‌توانید از پروژه Daring Fireball که توسط John Gruber توسعه یافته است، در مورد Markdown Syntax بیشتر بدانید.

بیایید نگاهی بیندازیم که چگونه markdown متن را از مثال‌های زیر به HTML ترجمه می‌کند.

متن علامت گذاری:

A First Level Header
====================

A Second Level Header
---------------------

Now is the time for all good men to come to
the aid of their country. This is just a
regular paragraph.

The quick brown fox jumped over the lazy
dog's back.

### Header 3

> This is a blockquote.
> 
> This is the second paragraph in the blockquote.
>
> ## This is an H2 in a blockquote

خروجی در HTML:

<h1>A First Level Header</h1>

<h2>A Second Level Header</h2>

<p>Now is the time for all good men to come to
the aid of their country. This is just a
regular paragraph.</p>

<p>The quick brown fox jumped over the lazy
dog's back.</p>

<h3>Header 3</h3>

<blockquote>
    <p>This is a blockquote.</p>

    <p>This is the second paragraph in the blockquote.</p>

    <h2>This is an H2 in a blockquote</h2>
</blockquote>

دانستن استفاده از markdown اولین قدم برای یادگیری نحوه ایجاد یک فایل readme.txt است. این منبع را برای آشنایی با اصول ساختاربندی MARKDOWN’S FORMATTING SYNTAX دنبال کنید.

2. شامل همه اطلاعات مورد نیاز سرصفحه Readme

شما باید اطلاعات زیر را به هدر افزونه readme اضافه کنید.

نام افزونه: به سادگی نام منحصر به فرد افزونه خود را بنویسید. اطمینان حاصل کنید که نام داده شده شما با هیچ نام موجود موجود در مخزن وردپرس همپوشانی نداشته باشد. نام های مشابه در آینده باعث ایجاد درگیری خواهد شد.

مشارکت کنندگان: به افرادی که به شما در توسعه محصول کمک کردند اعتبار بدهید. این باید لیستی از نام های کاربری WordPress.org باشد. هر چیز دیگری غیر از نام کاربری وردپرس به عنوان پیوند پروفایل بدون گراواتار ظاهر می شود. هر نام را با کاما از هم جدا کنید.

توجه داشته باشید: برخی از افراد ممکن است بخواهند نام آنها از فایل readme.txt شما حذف شود. به تصمیمات آنها احترام بگذارید و نام آنها را حذف کنید.

لینک اهدا: این قسمت اختیاری است می توانید پیوندهایی به نمایه شخصی خود یا هر منبعی که در نهایت به گزینه پرداخت منجر می شود اضافه کنید.

برچسب ها: کلمات کلیدی خود را به عنوان برچسب نگه دارید. هر تگ را با کاما از دیگری جدا کنید. حداکثر می توانید 12 تگ قرار دهید. هر چیزی فراتر از آن به سئوی شما آسیب می رساند. توصیه می شود 5 تگ را نگه دارید زیرا فقط پنج برچسب اول در صفحه ایجاد شده ظاهر می شوند.

تست شده تا: وردپرس اغلب نسخه بهبود یافته خود را منتشر می کند. شماره نسخه هایی که محصول شما با آنها آزمایش شده است را در این قسمت وارد کنید. این فیلد فقط باید شامل اعداد باشد. به عنوان مثال، شما باید به جای نوشتن وردپرس 6.3 فقط «6.3» بنویسید.

نیاز به PHP: این بخش اختیاری است. شما باید حداقل نسخه PHP سازگار با افزونه خود را اضافه کنید. مانند قسمت بالا، فقط باید شماره نسخه را در اینجا بنویسید.

برچسب پایدار: شماره نسخه پایدار افزونه خود را اینجا بنویسید. این عدد را با نسخه PHP یا وردپرس اشتباه نگیرید، این فقط مختص افزونه شماست. می توانید سیستم قالب بندی SemVer را بررسی کنید تا یاد بگیرید که چگونه باید برچسب های پایدار بنویسید.

مجوز: همه افزونه های وردپرس به طور خودکار با شرایط و ضوابط مجوز عمومی عمومی گنو مطابقت دارند. شما باید این اطلاعات را در اینجا اضافه کنید.

URL مجوز: این یک فیلد اختیاری دیگر است. پیوندی به منبعی که حاوی جزئیات مربوط به مجوز شما است قرار دهید. اگر افزونه شما از مجوز کمتر آشنا استفاده می کند، باید این بخش را اضافه کنید.

هنگامی که اطلاعات هدر را تمام کردید، می توانید به مراحل بعدی بروید – یک توضیح کوتاه و طولانی.

3. یک توضیح کوتاه مختصر و دقیق بنویسید

بعد از بخش هدر، یک بخش اختصاصی برای توضیح کوتاهی از افزونه شما وجود دارد. در این بخش نمی توانید از نشانه گذاری استفاده کنید. توضیحات کوتاه را در حد نکته و خود توضیحی نگه دارید. محدودیت کاراکتر 150 است. هر چیزی که بیشتر از این حد باشد قطع خواهد شد.

4. شرح طولانی را مرتبط نگه دارید

اینجاست که شما این اختیار را دارید که توضیح دهید پلاگین شما چه کاری می تواند انجام دهد، چرا مردم باید از آن استفاده کنند و سایر جزئیات فنی و مشخصات افزونه شما.

فراموش نکنید که ویژگی های کلیدی و نقاط فروش منحصر به فرد را برای جذب مشتریان بالقوه درج کنید. در اینجا چند نکته برای نوشتن یک شرح طولانی موثر وجود دارد:

1. از علامت گذاری برای افزودن شکل های مختلف استفاده کنید
2. به ویژگی های کلیدی کمک کنید تا از متون دیگر متمایز شوند
3. پیوندهایی را به منابعی که محصول شما در آنها برجسته شده است اضافه کنید
4. به اسناد و وبلاگ های مهم پیوند اضافه کنید
5. در صورت داشتن ویدیو، ویدیوهای خود را معرفی کنید
6. کاربران را در مورد ویژگی های آینده آگاه کنید
7. می توانید پیوندهایی به رسانه های اجتماعی یا وب سایت خود اضافه کنید

این نمونه از Dokan Multivendor را بررسی کنید تا یک نمایش واقعی از توضیحات طولانی عالی را ببینید.

5. دستورالعمل های فرآیند نصب را اضافه کنید

بنویسید که چگونه افراد می توانند افزونه شما را هم به صورت دستی و هم از نتایج جستجوی مخزن وردپرس نصب کنند. اگر افزونه شما از روند نصب منظم وردپرس پیروی می کند، می توانید از این کار صرف نظر کنید. اما، اگر افزونه شما دارای تنظیمات نصب سفارشی باشد، این بخش ضروری است.

6. شامل بخش پرسش و پاسخ

خود را جای کاربران خود قرار دهید. سعی کنید نکات دردناک آنها و سوالاتی که ممکن است در مورد محصولات شما داشته باشند را درک کنید. آنها تمام این سؤالات را در این بخش سؤالات متداول جمع آوری می کنند. شما باید تمام سوالات رایج را در اینجا بگنجانید.

به هر حال، فقط سؤالات متداول نمی توانند به همه مشکلات منحصر به فرد پاسخ دهند. بنابراین، بهتر است هم از طریق انجمن پشتیبانی وردپرس و هم از طریق سیستم فروش بلیط شخصی خود، پشتیبانی ارائه دهید.

7. تصاویر صفحه را به کمک کاربران اضافه کنید

اسکرین شات ها به عنوان آستانه اولیه افزونه شما کار می کنند. شما باید تصاویر واقعی را اضافه کنید تا به کاربران کمک کنید بفهمند پلاگین شما در هنگام کار چگونه به نظر می رسد. این تصاویر به کاربران بالقوه نکاتی در مورد UI و UX نیز می دهد. بنابراین، اضافه کردن اسکرین شات برای جذب کاربران ضروری است.

8. در صورت نیاز اطلاعات اضافی را ارائه دهید

شما باید Changelog، Upgrade Notice و سایر اطلاعات اضافی را در این بخش قرار دهید. دستورالعمل های نحو علامت گذاری را دنبال کنید تا تمام اطلاعات به درستی ارائه شود. اطلاعاتی را که واقعاً ضروری نیستند اضافه نکنید. کاربران ممکن است به دلیل اطلاعات بسیار زیاد، حواسشان پرت شود و اطلاعات مهم را از دست بدهند.

نمونه ای از یک فایل استاندارد Readme.txt برای پلاگین وردپرس

WordPress.org یک نمونه فایل readme را ارائه می دهد تا به همه کمک کند یک سند Readme به خوبی نوشته شده تولید کنند. به نمونه زیر نگاهی بیندازید:

=== Plugin Name ===
Contributors: (this should be a list of wordpress.org userid's)
Donate link: https://example.com/
Tags: tag1, tag2
Requires at least: 4.7
Tested up to: 5.4
Stable tag: 4.3
Requires PHP: 7.0
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html

Here is a short description of the plugin.  This should be no more than 150 characters.  No markup here.

== Description ==

This is the long description.  No limit, and you can use Markdown (as well as in the following sections).

For backwards compatibility, if this section is missing, the full length of the short description will be used, and
Markdown parsed.

A few notes about the sections above:

* "Contributors" is a comma separated list of wordpress.org usernames
* "Tags" is a comma separated list of tags that apply to the plugin
* "Requires at least" is the lowest version that the plugin will work on
* "Tested up to" is the highest version that you've *successfully used to test the plugin*
* Stable tag must indicate the Subversion "tag" of the latest stable version

Note that the `readme.txt` value of stable tag is the one that is the defining one for the plugin.  If the `/trunk/readme.txt` file says that the stable tag is `4.3`, then it is `/tags/4.3/readme.txt` that'll be used for displaying information about the plugin.

If you develop in trunk, you can update the trunk `readme.txt` to reflect changes in your in-development version, without having that information incorrectly disclosed about the current stable version that lacks those changes -- as long as the trunk's `readme.txt` points to the correct stable tag.

If no stable tag is provided, your users may not get the correct version of your code.

== Frequently Asked Questions ==

= A question that someone might have =

An answer to that question.

= What about foo bar? =

Answer to foo bar dilemma.

== Screenshots ==

1. This screen shot description corresponds to screenshot-1.(png|jpg|jpeg|gif). Screenshots are stored in the /assets directory.
2. This is the second screen shot

== Changelog ==

= 1.0 =
* A change since the previous version.
* Another change.

= 0.5 =
* List versions from most recent at top to oldest at bottom.

== Upgrade Notice ==

= 1.0 =
Upgrade notices describe the reason a user should upgrade.  No more than 300 characters.

= 0.5 =
This version fixes a security related bug.  Upgrade immediately.

== A brief Markdown Example ==

Markdown is what the parser uses to process much of the readme file.

[markdown syntax]: https://daringfireball.net/projects/markdown/syntax

Ordered list:

1. Some feature
1. Another feature
1. Something else about the plugin

Unordered list:

* something
* something else
* third thing

Links require brackets and parenthesis:

Here's a link to [WordPress](https://wordpress.org/ "Your favorite software") and one to [Markdown's Syntax Documentation][markdown syntax]. Link titles are optional, naturally.

Blockquotes are email style:

> Asterisks for *emphasis*. Double it up  for **strong**.

And Backticks for code:

`<?php code(); ?>`

از آنجایی که این نمونه readme.txt توسط WordPress.org توصیه شده است، می توانید آن را با دقت دنبال کنید. اگر بتوانید نمونه را به خوبی تقلید کنید، تیم بررسی افزونه، افزونه شما را تایید می کند.

یاد بگیرید چگونه افزونه خود را در مخزن وردپرس آپلود کنید

برای جلوگیری از دردسر از ابزار وردپرس Readme Generator استفاده کنید

لذت کار با وردپرس این است که می توانید تقریباً همه چیز را با کمک یک ابزار انجام دهید. تقریباً برای همه چیز ابزار دارد. مورد برای readme.txt نیز تفاوتی ندارد. ابزارهای مفید زیادی برای تولید readme وجود دارد. می توانید از WP Readme Generator توسط weDevs برای ایجاد یک فایل readme.txt برای افزونه خود استفاده کنید.

استفاده از ابزار بسیار آسان است. از نوار کناری سمت چپ گزینه را انتخاب کنید. هر گزینه فیلدهای ورودی خاصی را برای شما گسترش می دهد. سپس مطالب خود را در آنجا بنویسید. خروجی بلادرنگ را روی صفحه نمایش خواهید دید. برای نمونه تصویر بعدی را ببینید.

با استفاده از این ابزار توسعه یافته توسط weDevs می توانید فایل readme.txt خود را وارد و صادر کنید. من با ابزار مفید دیگری برخورد کردم که می تواند به شما کمک کند. اگر می‌خواهید یک سند خواندنی عالی برای محصول خود ایجاد کنید، می‌توانید از GenerateWP Readme Generator نیز استفاده کنید.

هنگامی که نوشتن یک readme.txt تمام شد، بررسی کنید که آیا مشکلی ندارد و با روش‌های استاندارد وردپرس مطابقت دارد یا خیر. افزونه خود را با استفاده از یک URL یا با چسباندن متن خود در کادر متن تأیید کنید.

نکات پاداش – چگونه افزونه وردپرس خود را برای سئو بهینه کنیم

به غیر از کلمات کلیدی معمول و چیزهای اسلاگ، WordPress.org هنگام رتبه بندی یک افزونه چند فاکتور دیگر را در نظر می گیرد. موضوعات پشتیبانی خود را فعال نگه دارید که در اسرع وقت مشکلات را حل کند.

نکات عملی زیر را برای بهبود رتبه خود در مخزن وردپرس و گوگل بررسی کنید.

• کلمات کلیدی را در نام افزونه خود قرار دهید
• به‌روزرسانی‌های منظم را فشار دهید (حتی اگر به‌روزرسانی‌های جزئی باشد)
• افزونه خود را با آخرین نسخه های WordPress و PHP سازگار نگه دارید
• برچسب هایی را انتخاب کنید که با کلمات کلیدی مورد نظر شما مطابقت دارند
• درج کلمات کلیدی مرتبط در سوالات متداول (در صورت امکان)
• سعی کنید امتیاز متوسط ​​محصول خود را بهبود بخشید
• کاربران فعال‌تر داخلی (نصب‌های فعال بر رتبه‌بندی تأثیر می‌گذارند)
• یک readme.txt کامل بنویسید که کلمات کلیدی مناسبی داشته باشد

ما همچنین یک راهنمای سئو کامل برای توسعه دهندگان وردپرس آماده کرده ایم. برای اطلاعات بیشتر در مورد سئو وردپرس می توانید آن را بخوانید.

چگونه برای پلاگین های خود امتیاز متوسط ​​خوبی کسب کنید (فقط برای مبتدیان)

من نیز مانند شما به این فکر کردم که چگونه می توانم در ابتدا درست پس از استقرار محصولم به یک رتبه خوب برسم. هر مشکلی راه حلی دارد. می توانید با دوستان، همکاران و اعضای خانواده خود که در وردپرس درگیر هستند تماس بگیرید. از آنها بخواهید که از افزونه شما استفاده کنند و نظرات 5 ستاره را بگذارند.

تقویت اولیه را برای شما فراهم می کند. اگر محصول شما فاقد کیفیت باشد، در درازمدت شکست خواهید خورد. این بررسی های پشت درب فقط در مرحله اولیه نتایج خوبی به همراه دارد. صرفاً بر اساس تکنیک های کلاه سیاه نمی توان افزونه خود را در بازار حفظ کرد.

افکار نهایی

بنابراین این تمام چیزی است که قبل از ایجاد یک فایل Readme.txt موثر برای وردپرس باید بدانید.

ما معتقدیم که مراحل فوق، بهترین شیوه ها و نکات به شما کمک می کند تا افزونه خود را برای موتورهای جستجو بهتر خوانا کنید.

در صورت داشتن هرگونه سوال یا سوال بیشتر، فراموش نکنید که در قسمت نظرات با ما در میان بگذارید. به سلامتی!