رفتن به مطلب
جامعهٔ برنامه‌نویسان ایران
  • قوانین نگارشی جهت نشر محتوا


    کامبیز اسدزاده

    قوانین و قالب اصول نگارشی در مرجع آی او استریم نسخهٔ 1.3.0

    با توجه به اهداف مرجع، ارائه اسناد و محتوای معتبر رعایت اصول صحیح نگارشی در ترجمه، بازنشر و دیگر شرایط تولید محتوا نیاز است. بنابر‌این برای یادگیری شیوه نگارش و نحوهٔ صحیح نوشتن شما می‌توانید شیوهٔ صحیح نوشتن و استفاده از علائم نگارشی را بیاموزید.

    توجه داشته باشید که، جهت ارتقا درجهٔ کاربری به مدیران و میانجی‌گران برای ایجاد پُست، ویرایش و ارسال آن حتماً باید قوانین زیر را بپذیرید. در غیر این صورت هیچ تاکیدی بر تصحیح نگارش نخواهد بود و پُست شما به عنوان پُست های نا معتبر و غیر استاندارد بلوکه خواهند شد.

    متن زیر بر همین اساس آماده شده است و به مرور زمان تکمیل خواهد شد.

    نقل قول

    قطعا بازخورد‌های شما تاثیر بسیاری در تکمیل سازی این سند خواهد داشت.

    توجه داشته باشید که شرایط زیر در سراسر سیستم نرم‌افزاری که شامل ماژول‌های مختلفی چون (خبر، وبلاگ، پادکست، مستندات و ...) می‌شود. و عدم رعایت آن موجب عدم تایید و حتی لغو مقاله شما خواهد گردید.

    قبل از هر چیز به نمونه مثال زیر توجه کنید:

    عنوان آزمایشی متن (انتخاب سر نویس ۳)

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

    با توجه به اهداف مرجع ممکن است در آموزش‌های شما در میان متن فارسی از متن انگلیسی یا کد‌های برنامه نویسی استفاده کنید که برای مثال : کتابخانه STL یک کتابخانهٔ استاندارد کتابخانه‌ای با نام iostream وجود دارد که با تکه کد #include <iostream> وارد می‌شود. برای حل این مشکل آن تگ < > کد را بر روی نوشته خود اعمال کنید#include <iostream>نتیجه به صورت یک تکه کد درون خطی نمایش داده می‌شود.

     

    در برخی موارد کاراکتر‌های خاص مانند C++ لازم است به صورت صحیح نوشته شود، معمولاً برای این کار آن را به صورت برعکس می‌نویسد اما این کار پیشنهاد نمی‌شود چرا که در بحث سئو تاثیر منفی خواهد گذاشت. ما برای حل این مشکل یک افزونه با عنوان L در نظر گرفته ایم که می‌توانید کاراکتر‌های خود را انتخاب کنید و آن را بر روی آن اعمال نمایید.

    • مثال : زبان برنامه‌نویسی C++ بدون اعمال تگ L
    • مثال : زبان برنامه‌نویسی C++ تگ L اعمال شده است

    بنابراین نکاتی که همه ما به آن در تولید محتوا توجه می‌کنیم به صورت زیر هستند:

    • قبل از شروع نگارش فارسی به «راست چین بودن» محیط ویرایشگر توجه می‌کنیم.
    • برای نگارش صحیح فارسی از صفحه کلید استاندارد فارسی در ویندوز و گنو/لینوکس و مک استفاده می‌کنیماین صفحه کلید به صورت پیش‌فرض در سیستم عامل گنو/لینوکس و مک نصب استهمینطور در نسخه‌های جدید ویندوز(از ۸ و به بعدقابل فعال‌سازی در این سیستم عامل نیز است.
    • در جملات از «می‌باشد» و «نمی‌باشد» استفاده نمی‌کنیممعادل این کلمات به ترتیب «است» و «نیست» است.
    • معادل واژه‌ها بسیار مهم هستند، برای مثال کیبورد معادلش در فارسی صفحه‌کلید است و بهتر است از معادل فارسی استاندارد استفاده شود.
    • در نگارش صحیح فارسی هیچ‌گاه پیشوندها و پسوندها به صورت چسبیده نوشته نمی‌شوندمثلاًنمیشوند، میروم، جنگلها، پرندهگان، طراحیها، آنها و… همگی غلط هستند.
    • برای نوشتن پیشوندها و پسوندها به صورت جداگانه، چنانچه حروف دو بخش به صورت پیش‌فرض احتمال چسبیدن به هم را داشته باشند برای جداسازی آن‌ها از نیم فاصله استفاده می‌کنیممثلاً: نمی‌شود، می‌شود، توسعه‌دهنده، برنامه‌نویس، کسب‌و‌کار‌، می‌رسم، نمی‌خورم، گله‌ها، سبزه‌زار‌ها، طراحی‌ها، آن‌ها و… همگی درست هستند.
    • برای درج نیم فاصله در صفحه کلید استاندارد فارسی از Shift + Space که تقریبا در تمامی سیستم‌عامل‌ها همین ترکیب را دارد استفاده می‌کنیم.
    • در هنگام استفاده از کاراکترها (نظیر . ! ؟ ، … ؛باید به این نکته توجه کرد که آن‌ها بدون هیچ فاصله‌ای به کلمه قبل از خود می‌چسبندهمینطور پس از آن‌ها همیشه یک فاصله وجود دارد.
    • چنانچه در متن از کلمات و یا عباراتی به زبانی دیگر استفاده شده بود حتماً در نخستین جایی که از آن کلمات و یا عبارات استفاده می‌کنیم باید معادل آن به زبان اصلی در درون پرانتز و بلافاصله پس از استفاده درج شودمثلاً جملات زیر را در نظر بگیرید:
      • پردازنده و رم (RAM) رایانه حتماً باید با هم سازگاری داشته باشند.
      • زبان برنامه‌نویسی سی‌پلاس‌پلاس (++C) و فناوری کیوت کوئیک (Qt Quick).
      • جیکیرولینگ (J. K. Rowling) خالق مجموعه داستان‌های هری پاتر (Harry Potter) در مصاحبه اخیر خود با بی بی سی (BBC) از قصد خود در خصوص نوشتن سری جدیدی از داستان‌ها خبر داد.
      • نوروزبل (نؤرۊزبلعید باستانی مردم خطه کاسپین است.
      • به هیچ عنوان هیچ یک از اصطلاحات علمی را به فارسی نباید ترجمه و باز نشر کنیم، برای مثال : فناوری کیوت کوئیک (فناوری کیوت سریع) این غلط است.
    • چنانچه در متن از کلمات و یا عبارتی به زبان فارسی استفاده شود که معادل غیر فارسی آن مفهوم را به شکل بهتری برساند، معادل غیر فارسی در هنگام نخستین استفاده در درون پرانتز نوشته می‌شودمثلاً جملات زیر را در نظر بگیرید:
      • راهنمای فایل (File Directory) یکی از روش‌های رایج دسترسی به فایل‌ها در سیستم عامل‌ها است.
      • طراحی رابط کاربری (UI) و تجربه کاربری (UX) دو مقوله جدا از هم هستند.
    • چنانچه در متن از عبارات مخفف (فارسی و یا غیر فارسیاستفاده کرده باشیم در نخستین استفاده حتماً باید عبارت کامل در درون پرانتز درج شودمثلاً جملات زیر را در نظر بگیرید:
      • جهت استفاده از کتابخانه‌هایی چون Qt باید (سطوح مقدماتی و متوسط زبان برنامه‌نویسی ++Cرا به خوبی پشت گذاشته باشید.
      • جَک JAC (Jangal Accounts)) سیستم یکپارچه‌ای برای مدیریت حساب‌های کاربری در سرویس‌های گوناگون است که توسط شرکت جنگل ساخته شده و مورد استفاده قرار می‌گیرد.
    • هرگاه در متن نیاز به درج توضیحات تکمیلی باشد از پرانتز استفاده می‌کنیممثلا:
      • دات‌ویوز (شرکت دات‌ویوز (Dotwaves) با (مسئولیت محدود)) بزرگترین تولید کننده نرم‌افزار در شمال غرب کشور است.
    • متن باید دارای افعالی یکپارچه باشداین بدان معناست که فعل‌های خبری متن همگی باید دارای یک نقش باشندمثلاً اگر در حال نوشتن متن دستور پخت یک غذا باشیم، عبارت زیر غلط خواهد بود:
      • برای طراحی یک نرم‌افزار تحت کیوت ابتدا باید محیط توسعه را نصب و راه اندازی کردسپس تحت زبان برنامه‌نویسی ++C و فناوری Qt Quick آن را طراحی و توسعه می‌دهیم.
    • متن باید دارای لحنی یکپارچه باشدمثلاً اگر در قسمتی از متن از زبان محاوره استفاده کردیم در جای دیگر نباشد از زبان کتابی صحبت کنیممثلاً ۲ جمله اول هر دو درست هستند ولی جمله سوم غلط است.
      • قراره من در این آموزش برای شما بگم که چطور در رابطه با برنامه‌نویسی سطح پایین دانشتان را ارتقا دهید! (غلط)

      • قراره من در این آموزش برای شما بگم که چطور در رابطه با برنامه‌نویسی سطح پایین دانشتون رو ارتقا بدین (صحیح)

      • قرار است من در این آموزش برای شما نحوه ارتقا دانشتان در برنامه‌نویسی سطح پایین را توضیح دهم. (صحیح)

    • در متن هرجا که لازم باشد به مهم بودن بخشی خاص اشاره شود آن را بلد (Bold) می‌کنیممثال:
      • آوردن ماشین حساب در امتحان ریاضی مهندسی ممنوع نیست.
    • در پاراگراف‌های موجود در متن باید سعی شود که تا جایی که امکان دارد در جملات پشت سر هم از کلمات یکسان استفاده نشودمثلاً متن زیر به خاطر تکرار کلمات یکسان (در این مثال جاوا اسکریپت و استمتن زیبایی نیست:

      • جاوا اسکریپن یک زبان پر طرفدار استجاوا اسکریپت پر کاربرد ترین زبان در لایه رابط کاربری استجاوا اسکریپت ملقب به نام «JS» است.
    • چنانچه در متن بخواهیم یکپارچگی عبارتی را نشان دهیم آن را درون «» قرار می‌دهیماین کار برای سهولت خواندن متن انجام می‌شود.
    • چنانچه در متن بخواهیم که جمله‌ای را نقل قول کنیم آن را در درون «» قرار می‌دهیماگر متن نقل قول شده بیشتر از یک جمله بود به غیر از استفاده از علامت فوق از فونتی کوچکتر و یا اتالیک (Italic) استفاده می‌شود. البته برای راحتی کار و یکسان بودن بهتر است بر روی دکمه قالب روی ویرایستار کلیک کرده و از بخش بلوک‌ (بلوک نقل قول) را انتخاب کنید.
    • در محیط وب اگر در متن از کلمات و یا عباراتی استفاده شود که توضیحاتی مفصل از آن در جایی دیگر موجود باشد، آن کلمات و یا عبارات را به همان جایی که توضیحات مفصل آن وجود دارد پیوند (Link) می‌کنیم.
    • در هنگام لینک کردن عبارات در وب چنانچه لینک مورد نظر خارج از آدرسی خارج از سایت خودمان باشد حتماً باید لینک در تبی (Tab) جداگانه باز شود.
    • در هنگام لینک کردن عبارات حتماً برای آن عنوانی (Title) در نظر می‌گیریماین عنوان زمانی که ماوس بر روی لینک قرار بگیرد نمایش داده می‌شوداین عنوان باید متنی باشد که توضیحات بیشتر را در مورد لینک بدهدمثلاً اگر کلمه رشت را به صفحه ویکی‌پدیا فارسی رشت لینک کرده‌ایم یکی از عنوان‌های مناسب می‌تواند «در مورد رشت در ویکی‌پدیا فارسی بیشتر بخوانید.» باشد.
    • چنانچه در محیط وب متنی را از جایی نقل و قول (و یا کپیکردیم حتماً باید در صفحه خودمان به آن مطلب لینک بدهیماین لینک می‌تواند درون متنی باشد و یا اینکه در انتهای متن‌مان به عنوان منبع ذکر شود.
    • در وب چنانچه مایل به استفاده از تصاویر در متن‌مان بودیم حتماً مسأله اندازه (حجم)‌آن را در نظر می‌گیریممعمولاً از تصاویر با حجم پایین در درون متن استفاده می‌شود و اگر لازم بود که خواننده به تصویر با اندازه اصلی دسترسی داشته باشد معمولاً این تصویر به تصویر کم حجم موجود در متن لینک می‌شود.
    • در نوشتن مطالب از فونت‌های عجیب و غیر استاندارد و یا اندازه‌های بسیار بزرگ/کوچک استفاده نمی‌کنیم. هر چند فونت‌های استاندارد بر روی ویرایستار تعبیه شده است اما همینطور حتی‌الامکان رنگ‌ها و فونت و اندازه‌های پیش‌فرض را تغییر نمی‌دهیم. (مگر اینکه واقعاً در مواردی خاص نیاز به این کار باشد.)
    • کاراکترهای اعداد در زبان‌ فارسی با زبان‌هایی نظیر انگلیسی و عربی کاملاً متفاوت استدر نگارش فارسی فقط و فقط از کاراکترهای فارسی اعداد استفاده می‌کنیماین کاراکترها ۱۲۳۴۵۶۷۸۹۰ هستندتنها زمانی مجاز به استفاده از کاراکترهای اعداد انگلیسی و عربی هستیم که در حال ذکر معادل‌های غیر فارسی باشیممثلا:
      • فایل ام پی تری (MP3) یکی از فرمت‌های رایج موسیقی است.
      • ام فور (M4) یکی از اسلحه‌های رایج بازی کانتر است.
      • در لیست‌ها اعداد شماره‌گذاری را به صورت دستی وارد نمی‌کنیمبرای این کار از ابزار تعبیه شده در محیط نگارش استفاده می‌کنیم. (همینطور در لیست‌های غیر مرتب نیز کاراکترهای شروع کننده پاراگراف را دستی وارد نمی‌کنیم.)
    • در نگارش جدید فارسی از ی مالکیت استفاده نمی‌شودمثلاً عبارات زیر همگی غلط هستند:
      • خانهٔ ما
      • علاقهٔ مفرط
      • پذیرندهٔ جدید
    • برخی از کاراکترها نظیر ی و ک در فارسی متفاوت با عربی استدر نگارش فارسی دقت می‌کنیم که از کاراکترهای عربی استفاده نکنیم.
    • برای خوانایی متن و بالا بردن درک مطلب از پاراگراف‌ استفاده می‌کنیمهر پاراگراف متشکل از یک یا چند جمله است که نزدیکی محتوایی دارندپس از اتمام پاراگراف فارغ از اینکه جمله نهایی در کجا به پایان رسیده است به خط بعدی می‌رویم.
    • پس از انتشار مطلب در محیط وب چنانچه پس از گذشت مدتی طولانی قسمتی از متن با حقایق روز متفاوت بود بر روی آن خط می‌کشیمهمچنین اگر لازم بود بخشی را به عنوان اصلاحیه اضافه می‌کنیممتن زیر را در نظر بگیرید:

      • سیستم عامل مَک او اِس ایکس (Mac OS X) در حال حاضر جدیدترین سیستم عامل ساخته شده توسط شرکت اپل (Apple) استیکی از ویژگی‌های جدید افزوده شده به این سیستم عامل ظاهر بسیار زیبای آن است.
      • حال این متن را پس از گذشت چند سال به شکل زیر تغییر می‌دهیم:
      • سیستم عامل مَک او اِس ایکس (Mac OS X) در حال حاضر جدیدترین سیستم عامل ساخته شده توسط شرکت اپل (Apple) است. (در حال حاضرسیستم عامل مَک او اِس سییرا (macOS Sierra) جدیدترین سیستم عامل اپل است.) یکی از ویژگی‌های جدید افزوده شده به این سیستم عامل ظاهر بسیار زیبای آن است.
    • اگر در متن در حال توضیح موضوع خاصی هستیم بهتر است که در جاهایی از معادل‌های مترادف آن موضوع استفاده کنیممثلاً اگر در حال معرفی یک نرم‌افزار هستیم می‌توانیم برای اشاره به آن از کلماتی نظیر نرم افزار، برنامه، اپ و اپلیکیشن استفاده کنیم.
    • به طور کلی در متن از کلمات و عباراتی که از زبان دیگری آمده‌اند استفاده نمی‌کنیم ولی این مسأله نباید باعث کاهش خوانایی و مفهوم متن شود.
    • ساده نویسی یکی از اصول اصلی نگارش استاینکه از چه مجموعه از کلمات و عباراتی در متن‌مان استفاده کنیم بستگی به سطح خوانندگان‌مان داردمثلاً اگر در حال نوشتن یک متن برای برنامه نویسان هستیم به راحتی می‌توانیم از کلماتی نظیر UX و UI و.. استفاده کنیم ولی استفاده از این کلمات در یک متن عمومی توصیه نمی‌شود و در صورت استفاده حتماً باید معانی آن‌ها به صورت کامل در درون پرانتز و یا پاورقی درج شود.

    روش ارسال کد‌ در قالب مناسب برای درک بهتر مطلب توسط ابزار <>

    • در صورتی که مقاله، سند یا مطلب خاصی را منتشر می‌کنید که دارای تکه کدی است آن را در داخل تگ کد قرار می‌دهیم که نمونه مثال‌های آن به صورت زیر نمایان خواهند شد:

    نمونه مثال خروجی کد C

    //A Hello World! program in C.
    
    #include <stdio.h>
    int main()
    {
       // printf() displays the string inside quotation
       printf("Hello, World!");
       return 0;
    }

    نمونه مثال خروجی کد ++C

    // A Hello World! program in C++.
    
    #include <iostream>
    using namespace std;
    
    int main() 
    {
        cout << "Hello, World!";
        return 0;
    }

    نمونه مثال خروجی کد در Java

    //A Hello World! program in Java.
    
    public class HelloWorld {
        public static void main( String[] args ) {
            System.out.println( "Hello World!" );
            System.exit( 0 ); //success
        }
    }

    نمونه مثال خروجی کد در JavaScript

    // A Hello World! program in JavaScript.
    
    const btn = document.getElementById('button');
    btn.addEventListener('click', function() {
        alert('Hello World!');

    نمونه مثال خروجی کد در QML

    // A Hello World! program in QML.
    
    import QtQuick 2.0
    
    Rectangle {
        id: page
        width: 320; height: 480
        color: "lightgray"
    
        Text {
            id: helloText
            text: "Hello world!"
            y: 30
            anchors.horizontalCenter: page.horizontalCenter
            font.pointSize: 24; font.bold: true
        }
    }

    نمونه مثال خروجی کد در PHP

    // A Hello World! program in PHP.
    
    $text = "Hello, World!";
    $x = 5;
    $y = 4;
    
    echo "<h2>" . $text . "h2><br>";
    echo $x + $y;

    نمونه مثال خروجی کد در Node.JS

    // A Hello World! program in Node.JS
    
    const express = require('express')
    const app = express()
    app.get('/', (req, res) => res.send('Hello World!'))
    app.listen(3000, () => console.log('Example app listening on port 3000!'))

    نمونه مثال خروجی کد در CSS

    p {
        text-align: center;
        color: red;
    } 

    نمونه مثال خروجی کد در #C

    // A Hello World! program in C#.
    
    using System;
    
    namespace HelloWorld
    {
        class Hello 
        {
            static void Main() 
            {
                Console.WriteLine("Hello World!");
    
                // Keep the console window open in debug mode.
                Console.WriteLine("Press any key to exit.");
                Console.ReadKey();
            }
        }
    }

    نمونه مثال خروجی کد در Ruby

    #!/usr/bin/ruby
    print "Hello, World!\n"

    نمونه مثال خروجی کد در Python

    # This program prints Hello, world in Python!
    print('Hello, world!')

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

    مخفی کننده

    این کار باعث می‌شود کاربران به صورت نا خودآگاه در جریان بخشی از محتوایی که نمی‌خواهید آن‌ها را لو دهید قرار نگیرد. مانند داستان یک بازی، بخشی از کد یا هر چیزی که کاربر نمی‌خواهد بدون هیچ تلاشی از آن آگاه باشد.

     

    ویرایش شده در توسط کامبیز اسدزاده

    • پسندیدن 4
    • ترکوندی! 1
    • تشکر شده 1



×
×
  • جدید...