टैग वाले लेख: शैली मार्गदर्शिका
Glossary तब उपयोगी है जब वह product, interface और docs में decisions control करे, केवल words collect न करे। Useful entry में preferred term, definition, deprecated variants, context और owner होना चाहिए।
Scale पर consistency content models, terminology और reusable patterns से आती है, विशाल style guide याद कराने से नहीं। Important rules को schemas और components में encode करें। Small team shared habits और direct editing पर चल सकती है। दर्जनों या सैकड़ों contributors के साथ memory control system नहीं रह सकती। Rules publishing environment में रहने चाहिए।
“ऐसी style guide जिसका लोग वास्तव में उपयोग करें” पर एक व्यावहारिक और जाँच योग्य मार्गदर्शिका, जिसे documentation team लंबे समय तक बनाए रख सके। “ऐसी style guide जिसका लोग वास्तव में उपयोग करें” को तकनीकी दस्तावेज़ीकरण के लिए व्यावहारिक, जाँच योग्य और टिकाऊ तरीके से समझाया गया है। शुरुआत में वास्तविक उपयोगकर्ता समस्या को टीम की आंतरिक पसंद से अलग करें और ऐसी शर्तें लिखें जिन्हें पाठ…
Style linting तब उपयोगी है जब वह terminology drift, risky wording और repeatable editorial defects पकड़े। Rules कम, स्पष्ट और इतने शांत रखें कि failed check पर writers भरोसा करें। Linter कुछ सेकंड में हजारों sentences check कर सकता है, इसलिए हर editorial preference encode करने का मन होता है। ऐसा न करें। पहले गलत product names, inconsistent terminology, risky wording, ambiguous warnings और repeated formatting errors प…