FLOSSManuals فارسی


مرور كلي بر ويرايش

ويرايش راهنما قسمت لذت بخش كار است: نوشتن مستندات رايگان يك تجربة لذت بخش است، بنابراين روي كاري كه از آن لذت ميبريد تمركز كرده و شروع كنيد. نيازي نيست كه براي همكاري نگران مسائل جزئی باشید، هر ويرايشي به شما كمك خواهد كرد. بهتر كردن تصاوير، تقويت چيدمان، تصحيح املايي، چيدن (laying out) راهنماهاي "print- on- demand" ، بازنويسي يك جمله يا اضافه كردن فصلها يا راهنماهاي كامل همه كارهايي هستند كه در بهتر كردن راهنماها كمك ميكنند. بنابراين موضوعي را كه برايتان جذاب است، انتخاب كرده، پيش برويد و آن را انجام دهيد.

بهترين راه براي يادگرفتن نحوة همكاري، جهش (jump in) و انجام آن است. نگران اشتباهاتتان نباشيد، فقط شروع به همكاري و ويرايش كنيد. اگر شما مرتكب اشتباهي بشويد، شخص ديگري متوجه آن شده و آن را اصلاح خواهد كرد.

اگر شما نگران هستيد كه اشتباهاتتان موجب بد فهمي خوانندگان شود، نگران نباشيد! تمام ويرايشهاي صورت گرفته روي راهنماها "زنده" نبوده، بلكه همگي از طريق يك فرايند ساده انتشار فيلتر ميشوند تا ويرايشها قبل از ظاهر شدن در راهنماي اصلي بررسي شوند.

كار Floss Manuals در مورد ايجاد مستندات خوب است، ولي ما همچنين در مورد همكاري و ساختن دانش به صورت جمعي نيز فعاليت ميكنيم. انجمني درگير توليد راهنماها است و اگر شما ميخواهيد در مورد مسائل آن صحبت كنيد، ميتوانيد عضو "mailing list" شويد:

http://lists.Flossmanuals.net/listinfo.cgi/discuss-flossmanuals.net

write

قسمت write

(http://lists.Floss manuals.net/write)

از Floss Manuals، جايي است كه تمام راهنماها براي ويرايش كردن در آن قرار دارند.

write.png

شما ميتوانيد دو بخش اصلي اين صفحه را ببينيد. در سمت چپ نوار راهيابي (navigation) و در سمت راست پنجرة محتوا قرار گرفته است. در مثال بالا، صفحة خانگي write نشان داده شده است. شما ميتوانيد ليستي از راهنماها را زير عنوان MANUALS ببينيد:

manuals.png


با كليك كردن روي هر يك از اين عنوانها، شما به صفحة خانگي آن راهنما خواهيد رفت. اگر من روي راهنماي GIMP كليك كنم، چيزي مشابه شكل زير را خواهم ديد:


manualhme.png

اين صفحه شامل اطلاعاتي در مورد راهنماي GIMP است. به ياد داشته باشيد كه خوانندگاني كه از قسمت Read (صفحه اصلي Floss Manuals) روي GIMP كليك كنند، اين صفحه را نخواهند ديد.

راهنماي واقعي GIMP به صورت زير است:

manualindex.png

در شكل بالا نسخه "منتشر شدهي " راهنماي GIMP را ميبينيد. ممكن است اين سوال برايتان پيش بيايد كه چرا دو نسخه از نرم افزار وجود دارد؟ هر راهنما يك نسخة در حال ايجاد و يك نسخة منتشر شده دارد. نسخة در حال توليد ممكن است شامل ويرايشهاي نيمه تمام، فصلهايي كه هنوز در راهنماي اصلي قرار نگرفتهاند و محتوايي كه نياز به تصحيح املايي دارد، باشد. ديدن تمام اينها براي خوانندگان جالب نيست، بنابراين زمانيكه تمام ويرايشها و تصحيحات املايي انجام شوند، تغييرات در راهنمايي كه خواننده ميبيند، کپي ميشوند.

نسخة در حال ايجاد كه شما تمام اينها را روي آن انجام ميدهيد، در قسمت write و نسخة قابل خواندن در قسمت Read نگهداري ميشود. اگر راهنمايي نسخهاي در قسمت read نداشته باشد، به اين معني است كه هنوز براي قرار گرفتن در اين قسمت آماده نيست و كار بيشتري بايد بر روي آن انجام شود.

همچنين داشتن دو نسخه متفاوت به اين شكل، به اين معني است كه شما نبايد نگران اشتباهاتتان موقع ويرايش كردن باشيد. خواننده هرگز اين اشتباهات را نخواهد ديد.

فصلها chapters

هر راهنما شامل چند فصل است. وقتي شما يك راهنما را ويرايش ميكنيد، در واقع در حال ويرايش كردن يكي از فصلهاي آن هستيد. ميتوانيد از طريق صفحة خانگي write راهنماها، براي ويرايش كردن به فصلها دسترسي پيدا كنيد (اين صفحه را صفحه خانگي راهنما ميناميم). اگر به مثال صفحة خانگي GIMP نگاه كنيم در آن ليستي از فصلها را خواهيم ديد:


index.png

سه ستون را ميبينيم، ستون اول شامل نام فصل است. اين نام به نسخة قابل ويرايش فصل لينك شده است. در صورت تمايل ميتوانيم فصل را مستقيماً با كليك كردن روي edit در ستون بعدي، ويرايش كنيم در آخرين ستون متن اولين جمله در آن فصل قرار دارد.

نام هر فصل به روشي رايج ميان بسياري از wiki ها به نام "camel case" نوشته ميشود. يك camel case يك كلمة مركب (يك يا چند كلمة متصل به هم) بدون فاصله ميان كلمات است كه حرف اول هر كلمه با حروف بزرگ نوشته شده است.

به عنوان مثال به جاي "installing windows داريم "installing windows".

نامها فقط در قسمت write به اين صورت هستند. وقتي يك نسخة جديد از يك راهنما در قسمت Read كپي ميشود، اين عناوين به صورتي تغيير مييابند كه خواندن آنها آسانتر باشد. همچنين توجه داشته باشيد كه ليست فصلها در بالا شامل فصلهايي است كه در راهنما در قسمت READ وجود ندارند و همچنين ترتيب اين فصلها متفاوت است. انتخاب نام مناسب براي فصلها، تصميمگيري در مورد شمول يا عدم شمول فصلها در راهنما و قرار دادن آنها به ترتيب درست وظيفةmaintainer راهنماهاست.