तकनीकी दस्तावेज़ीकरण, टूल और पेशा — एक स्वतंत्र पत्रिका
TECHWRITERS.ORG

CI/CD

टैग वाले लेख: CI/CD

CI/CD में documentation
टूल्स

CI/CD में documentation

Documentation को build artifact की तरह लें: publish होने से पहले structure, links, examples और rules validate करें। CI usefulness तय नहीं कर सकता, लेकिन human review से पहले predictable defects रोक सकता है। Documentation build को quality gate मानें।

लेख के लिए तकनीकी संपादकीय चित्र: Vale को quality gate की तरह इस्तेमाल करें, punctuation police की तरह नहीं।
टूल्स

Vale को quality gate की तरह इस्तेमाल करें, punctuation police की तरह नहीं

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 प…