Bu wikiHow sizə açıq mənbə layihəsi üçün sənəd yazmağı öyrədir. Bu sənədlərə ümumiyyətlə README faylı deyilir. README, layihəniz haqqında həm istifadəçilər, həm də inkişaf etdiricilər üçün vacib məlumatlar olan bir mətn və ya HTML sənədidir.
Addımlar
Addım 1. Layihənizin adını yazın
Layihəniz üçün README yazarkən, daxil etməli olduğunuz ilk şey layihənin adıdır. Başlıq ilə yanaşı ən son versiya nömrəsini və son yeniləmə tarixini də daxil etməlisiniz.
Addım 2. Layihənizin təsvirini yazın
README -ə daxil etməyiniz lazım olan növbəti şey, layihənizin qısa təsviridir. Layihənin nə olduğunu, niyə mövcud olduğunu və hansı problemləri həll etdiyini izah edin. İstifadəçilər və inkişaf etdiricilər üçün faydalı olacaq hər hansı bir xüsusi xüsusiyyət, ekran görüntüsü, kod tərzi, texnologiya və ya çərçivə və ya başqa bir şey də daxil edə bilərsiniz.
Addım 3. Layihənizin tələblərini izah edin
Layihənizin düzgün işləməsi üçün hər hansı bir xüsusi tələbə ehtiyacınız varsa, bu tələbləri və təlimatları və ya necə quraşdırılacağına dair təlimatlara keçid etdiyinizə əmin olun.
Addım 4. Kodun bir nümunəsini daxil edin
Layihənizin nə üçün istifadə edildiyinə dair aydın və qısa bir nümunə verin. Kod, inkişaf etdiricilərin başa düşməsi üçün asan olmalı və API aydın şəkildə görünməlidir.
Addım 5. Quraşdırma təlimatlarını verin
İstifadəçilərə proqramınızı addım-addım formatında işə salmağı izah edin. Təlimatlarınız mümkün qədər aydın olmalıdır. İstifadəçilərinizin proqram inkişafı və ya sistem idarəçiliyi haqqında heç bir məlumatı olmadığını düşünün.
Addım 6. Proqramdan necə istifadə olunacağını izah edin
İnsanlara proqramınızdan ən yaxşı şəkildə necə istifadə edəcəyinizi söyləyin. Proqramınızı necə istifadə edəcəyinizi, fərqli konfiqurasiya seçimlərini və bunları necə quracağınızı izah edin.
Addım 7. İstifadəçilərə texniki yardımın necə alınacağını söyləyin
İstifadəçilərin texniki yardım üçün müraciət edə biləcəyi hər hansı bir poçt siyahısına, IRC kanallarına və ya icma forumlarına bağlantılar təmin edir. Daha təcrübəli istifadəçilərə layihəni daha yaxşı etmək üçün səhvlərin və fikirlərin hara göndəriləcəyini bildirin.
Fərqli istifadəçilərdən bir çox eyni sual aldığınızı görürsünüzsə, layihə sənədlərinizin bir hissəsi olaraq FAQ (tez -tez verilən suallar) daxil etmək istəyə bilərsiniz
Addım 8. Necə töhfə verəcəyinizi izah edin
Açıq mənbəli bir layihə üzərində işləyirsinizsə, istifadəçilərinizə layihənizə necə töhfə verə biləcəklərini bildirin. Sahib olduğunuz standartları izah edin və potensial iştirakçılara bəzi qaydalar verin.
Addım 9. Kreditləri sadalayın
Kreditin lazım olduğu yerdə həmişə kredit verin. Bütün töhfə verənlərin adlarını və istifadə etdiyiniz üçüncü tərəf kitabxanalarına və ya proqramlarına bağlantılar yazdığınızdan əmin olun. Layihənizi qurarkən əldə edə biləcəyiniz hər hansı bir ilham mənbəyinə bağlantılar əlavə edin.
Addım 10. Əlaqə məlumatlarınızı daxil edin
İnsanlar müxtəlif səbəblərdən sizinlə əlaqə saxlamaq istəyə bilərlər. İnsanların sizinlə əlaqə qurmaq üçün istifadə edə biləcəyi etibarlı bir e -poçt ünvanı verdiyinizə əmin olun.
Bəzi ölkələr qanunla poçt ünvanı və ya şirkət adı kimi əlavə məlumat tələb edə bilər
Addım 11. Lisenziya məlumatı verin
İstifadəçilər üçün layihənizin necə lisenziyalaşdırıldığını bilmək vacibdir. İnternetdə istifadə edə biləcəyiniz bir çox standart lisenziya var. Layihənizin hansı lisenziyadan istifadə etdiyini, həmçinin istifadə edə biləcəyiniz üçüncü tərəf kitabxanalarının və ya proqramlarının lisenziyalarını izah edin.
Sənədlərinizdə bütün lisenziyanı izah etməyə ehtiyac yoxdur. İstifadəçilərə layihənizin hansı lisenziyasından istifadə etdiyini bildirin və tam lisenziya məlumatlarına bir keçid verin
Addım 12. Layihənin bütün versiyalarını sadalayın
Layihənizin bütün əvvəlki versiyalarının siyahısını yaratdığınızdan və hər bir versiya üçün hansı düzəlişlər etdiyinizi qısa bir şəkildə yazdığınızdan əmin olun.
İpuçları
- Layihənizi inkişaf etdirməyə başlamazdan əvvəl README faylınızı yazmağa başlamaq yaxşı bir təcrübədir. Bu, layihəniz haqqında düşünməyinizə və nəyi həyata keçirməyinizə ehtiyac duyacaq. Digər töhfəçilərlə ünsiyyət qura biləcəyiniz qaydalar hazırlamağa kömək edəcək və layihənizin əvvəlində README faylınızı yazmaq üçün daha çox motivasiya alacaqsınız.
- Layihəniz üzərində işləyərkən README faylınızı və digər sənədlərinizi tez -tez yenilədiyinizə əmin olun.
- README faylı bir səhifədən daha uzundursa, ayrı bir sənəd olaraq quraşdırma təlimatları, istifadəçi təlimatları və FAQ kimi daha uzun hissələri yaza bilərsiniz. Bütün layihə sənədləriniz üçün məzmun cədvəli yaratdığınızdan və README sənədindəki müvafiq sənədlərə bir keçid verdiyinizdən əmin olun.