पर तकनीकी लेख कैसे प्रारूपित करें

यदि आप विकीहो पर एक तकनीकी विषय लिख रहे हैं, तो ऐसे कई टेम्पलेट्स हैं जिनका उपयोग आप पाठकों के लिए स्पष्टीकरण में मदद के लिए कर सकते हैं कि प्रत्येक चरण में उन्हें क्या करना चाहिए. हालांकि इन सुविधाओं का उपयोग करने की आवश्यकता नहीं है, कीस्ट्रोक, बटन टेम्पलेट्स, और टेक्स्ट इनपुट फ़ील्ड जोड़ने के लिए एक लेख की सहायकता में काफी सुधार हो सकता है. यह आपको दिखाता है कि इन सुविधाओं को एक तकनीकी लेख में कैसे जोड़ना है.

कदम

  1. शीर्षक वाली छवि  चरण 1 पर तकनीकी लेखों के लिए सहायक स्वरूपण जोड़ें
1. सुनिश्चित करें कि आप हमारे नियमित से परिचित हैं प्रारूपण दिशानिर्देश. मूल बातें के लिए, एक तकनीकी विषय स्वरूपित करना किसी भी अन्य विकीहो लेख को स्वरूपित करने से अलग नहीं है. तकनीकी लेख अभी भी नियमित विकीहो दिशानिर्देशों का पालन करना चाहिए, उदाहरण के लिए, सुनिश्चित करें कि आप:
  • प्रत्येक चरण को क्रिया के साथ शुरू करें.
  • आवश्यकतानुसार पदार्थ (# *) में लंबे चरणों (#) को तोड़ दें.
  • भागों या विधियों में लंबे लेख तोड़ें.
  • में पाया गया मानक अनुभाग आदेश का उपयोग करें प्रारूपण दिशानिर्देश.
  • शीर्षक वाली छवि  चरण 2 पर तकनीकी लेखों के लिए सहायक स्वरूपण जोड़ें
    2. बटन बनाने के लिए {{macbutton}} और {{बटन}} का उपयोग करें. यह टेम्पलेट एक सामान्य अस्पष्ट सीएसएस बटन बनाता है जिसका उपयोग कंप्यूटर या इलेक्ट्रॉनिक डिवाइस के उपयोगकर्ता इंटरफ़ेस पर वास्तविक बटन अनुकरण करने के लिए किया जा सकता है. आप अपने कंप्यूटर या डिवाइस पर उपयोग किए गए बटन को नकल करने के लिए टेम्पलेट में किसी भी नियमित टेक्स्ट वर्ण टाइप कर सकते हैं.
  • उदाहरण के लिए, यदि लेख ठीक क्लिक करने के लिए कॉल करता है, तो आप ठीक या ठीक होने के लिए {OK} या {OK} टाइप कर सकते हैं.
  • मैक लेखों पर आपको केवल {{macbutton}} का उपयोग करने की आवश्यकता नहीं है- कुछ लोग विंडोज या सामान्य तकनीकी विषयों पर भी दिखते हैं.
  • इस टेम्पलेट के बारे में अधिक जानकारी के लिए अपने आलेख में बटन और टैब उदाहरण कैसे जोड़ें देखें.
  • शीर्षक वाली छवि  चरण 3 पर तकनीकी लेखों के लिए सहायक स्वरूपण जोड़ें
    3. पाठ इनपुट प्रदर्शित करने के लिए {{kbd}} का उपयोग करें. उदाहरण के लिए, यदि पाठक को टेक्स्ट फ़ील्ड में टेक्स्ट दर्ज करना है, तो हाइपरलिंक या कोड की लाइन टाइप करें, या किसी फ़ील्ड या मेनू विकल्प पर क्लिक करने में मदद मिल सकती है.
  • उदाहरण के लिए, यदि आपको पाठक को दर्ज करने के लिए बताने की आवश्यकता है "शुरू" कमांड प्रॉम्प्ट में, प्रदर्शित करने के लिए {प्रारंभ} टाइप करें शुरू अनुकरण करने के लिए जो वे दर्ज करेंगे.
  • शीर्षक वाली छवि  चरण 4 पर तकनीकी लेखों के लिए सहायक स्वरूपण जोड़ें
    4. पाठ आउटपुट के लिए {{SAMP}} पर विचार करें. इसका उपयोग शायद ही कभी किया जाता है, लेकिन यदि कोई प्रोग्राम कंसोल में कुछ आउटपुट देता है, तो आप कंसोल आउटपुट की नकल करने के लिए {{samp}} को आज़मा सकते हैं.
  • उदाहरण के लिए, यदि प्रोग्राम आउटपुट करता है "प्रकार -? अधिक जानकारी के लिए", प्राप्त करने के लिए कोड {SAMP} का उपयोग करें प्रकार -? अधिक जानकारी के लिए.
  • शीर्षक वाली छवि  चरण 5 पर तकनीकी लेखों के लिए सहायक स्वरूपण जोड़ें
    5. कीबोर्ड कुंजी संयोजनों के लिए {{keypress}} का उपयोग करें. आप इस तरह से एकल कुंजी प्रदर्शित कर सकते हैं, या एक टेम्पलेट के भीतर उन्हें एक साथ स्ट्रिंग कर सकते हैं जब पाठक को एक बार में कई कुंजियों पर क्लिक करने की आवश्यकता होती है.
  • उदाहरण के लिए, यदि पाठक को किसी कार्य को पूरा करने के लिए नियंत्रण, alt, और कुंजियों को हटाने की आवश्यकता है, तो इसे {हटाएं} का उपयोग करके प्रारूपित करें. आउटपुट होगा सीटीआरएल+Alt+हटाएं.
  • देखें कि आलेख में Keystrokes कैसे दिखाएं ARYPROPS का उपयोग करके सभी प्रमुख विकल्पों के लिए आप प्रदर्शित कर सकते हैं.
  • शीर्षक वाली छवि  चरण 6 पर तकनीकी लेखों के लिए सहायक स्वरूपण जोड़ें
    6. जब आप अपने चरणों में आइकन दृश्यों को जोड़ना चाहते हैं तो टेक आइकन टेम्पलेट्स आज़माएं. आप ओएस-विशिष्ट आइकन दिखाने के लिए {{iphone}} {{{{{{{{{mac}} टेम्पलेट्स का उपयोग कर सकते हैं पाठक को पहचानने की आवश्यकता हो सकती है.
  • ध्यान रखें कि ये छवियां हैं और स्मार्ट डिवाइस या स्क्रीन पाठकों द्वारा जोर से नहीं पढ़ा जाएगा, इसलिए आप अभी भी बटन नाम लिखना चाहते हैं.
  • इन टेम्पलेट्स को लंबवत पाइप (|) के बाद आइकन नाम के साथ पैरामीटर की आवश्यकता होती है जो निर्दिष्ट करता है कि आप कौन सा आइकन दिखाना चाहते हैं. उदाहरण के लिए, प्रदर्शित करने के लिए {iphone} या {Android} का उपयोग करें
    IPhoneShare.jpg शीर्षक वाली छवि
    या
    Android7Search.jpg शीर्षक वाली छवि
    .
  • प्रत्येक टेम्पलेट के भीतर उपलब्ध आइकन की पूरी सूची देखने के लिए, और उनके संबंधित नामों को ढूंढने के लिए, प्रत्येक व्यक्तिगत टेम्पलेट पृष्ठ देखें:
  • आईफोन: टेम्पलेट: आईफोन
  • एंड्रॉइड: टेम्पलेट: एंड्रॉइड
  • विंडोज: टेम्पलेट: विंडोज़
  • मैक: टेम्पलेट: मैक
  • शीर्षक वाली छवि  चरण 7 पर तकनीकी लेखों के लिए सहायक स्वरूपण जोड़ें
    7. जब संभव हो स्क्रीनशॉट डालें. यदि संभव हो, तो विशिष्ट बटन या लिंक की ओर इशारा करने के लिए ली गई स्क्रीनशॉट संपादित करें. जब वे कार्य को पूरा करने की कोशिश करते हैं तो पाठक को बटन का पता लगाने में मदद करता है.
  • यदि आपको स्क्रीनशॉट की आवश्यकता है, तो विकीवी पर विकीविज़ुअल टीम से संपर्क करें या इसमें एक धागा खोलें मंचों अन्य समुदाय के सदस्यों से मदद मांगना.
  • टिप्स

    यदि आपके चरणों में कोड स्निपेट शामिल हैं, तो स्वरूपण कोड के विकल्पों के बारे में जानने के लिए विकीहो पर प्रोग्रामिंग आलेख कैसे लिखें.

    चेतावनी

    कुछ टेम्पलेट्स बराबर संकेत से टूट जाते हैं. यदि ऐसा है, तो {1 = पैरामीटर} का उपयोग करें.
    सामाजिक नेटवर्क पर साझा करें:
    समान