عندما انضممت إلى Shopify العام الماضي ، كنت أعلم أن ثقافتها الهندسية من الدرجة الأولى. ما لم أكن أعرفه هو أن ثقافة التوثيق الخاصة بالشركة كانت أكثر تطوراً مما كنت أختبره سابقاً. ببساطة ، لقد تأثرت بكمية الوثائق المتعلقة بكل شيء تقريبًا: الإعداد ، والمشاريع ، والأدوات الداخلية ، والعمليات الداخلية.
جعلني ذلك أفكر في أوقات في حياتي المهنية عندما كان العثور على جزء من المعلومات رحلة ملحمية - كان التوثيق شبه معدوم أو قديم. كان علي أن أتواصل مع الناس لأن المعرفة كانت في رؤوسهم.
في صناعة التكنولوجيا ، هناك مشكلة في التوثيق الداخلي. لقد شعرنا جميعًا بالتوق إلى إنجاز الأمور عند الانضمام إلى شركة جديدة. بدلاً من ذلك ، وجدنا أنفسنا في قاعدة بيانات غير موثقة بشكل جيد ، أو مع تعليمات غير واضحة حول كيفية إعداد مشروع. عندما ينتقل المهندسون من فريق إلى فريق ، أو من مشروع إلى مشروع ، أو يغادرون الشركة ، يصبح التوثيق الجيد ضروريًا.
تعد مشاركة السياق الفني داخليًا أحد أهم الأشياء التي يمكننا القيام بها وقوتها. إنه يخلق مساحة للمناقشات وحل المشكلات ، ويتيح للخبراء تبادل المعرفة لصالح الجميع.
لكن التوثيق الداخلي قد يكون صعبًا: إنها عملية تستغرق وقتًا ومالًا. غالبًا ما يتم نشر الوثائق عبر منصات مختلفة بدلاً من دمجها لسهولة الاستخدام. ولا يتم دائمًا ترتيب أولوياتها — كود الشحن طريقة أكثر إثارة وإشباعًا من توثيق عملية ما. أصبح التنقل في قواعد الرموز الجديدة أحد أكبر التحديات في تطوير البرمجيات.
في Shopify ، حاولنا التغلب على هذه المشكلة من خلال توحيد الطريقة التي نكتب بها ، وتجنب مصادر الحقيقة المتباينة ، وإنشاء ثقافة الكتابة. نتعامل مع التوثيق على أنه منتج ، ونحرص على إنشاء وثائق شاملة. الطريقة الأكثر فعالية لتشجيع الآخرين على الكتابة هي الكتابة. يمكن أن يكون الأمر سهلاً مثل فتح طلب سحب والموافقة عليه. فوائد ثقافة التوثيق القوية لحظية.
في بيئة العمل عن بعد ، الكتابة هي طريقتنا الافتراضية لمشاركة المعرفة. يمكن للجميع الوصول إلى كل شيء: جميع المستودعات ، ولوحات المعلومات ، وويكي ، ومستندات Google Drive. يزيد التوثيق من قابلية اكتشاف المحتوى ، ومن خلال جعل جميع المعلومات قابلة للبحث ، تتحسن معرفة القراءة والكتابة. وعندما تتحسن معرفة القراءة والكتابة ، تتحسن الإنتاجية أيضًا.