دستاویزات ایک فیچر ہیں
دستاویزات آپ کی پروڈکٹ سے الگ نہیں ہیں۔ یہ پروڈکٹ کا حصہ ہیں۔
بہت سے ڈویلپرز ایک ناقص طریقہ کار پر عمل کرتے ہیں:
- فیچر بنائیں ۔
- فیچر کا ٹیسٹ کریں ۔
- فیچر ریلیز کریں ۔
- فیچر کی دستاویزات تیار کریں ۔
صارفین آپ کے کوڈ کا تجربہ نہیں کرتے۔ وہ آپ کے انٹرفیس، آپ کے ورک فلو اور آپ کی دستاویزات کا تجربہ کرتے ہیں۔ ایک صارف کے لیے، دستاویزات ایک فیچر ہیں۔
تخلیق کار دستاویزات کو نظر انداز کر دیتے ہیں کیونکہ وہ پہلے سے ہی پروڈکٹ کو سمجھتے ہیں۔ آپ جانتے ہیں کہ آپ نے کچھ فیصلے کیوں کیے۔ آپ جانتے ہیں کہ API کیسے کام کرتی ہے۔ آپ شارٹ کٹس سے واقف ہیں۔
صارف نہیں جانتا۔ جو چیز آپ کو بالکل واضح لگتی ہے، وہ ان کے لیے پراسرار ہوتی ہے۔
بار بار پوچھے جانے والے سوالات کو 'ڈاکیومنٹیشن ڈیٹ' (documentation debt) سمجھیں۔ اگر لوگ ایک ہی سوال دو بار پوچھتے ہیں، تو آپ کو ایک مسئلہ درپیش ہے۔ یا تو آپ کی پروڈکٹ الجھن پیدا کرنے والی ہے یا آپ کی دستاویزات نامکمل ہیں۔ کبھی کبھی آپ کو API کو ٹھ