إدارة مذكرة مقتطف كود
للمهندس

اللحظة التي يعتقد فيها المهندسون أن "هذا مناسب" تأتي فجأة أثناء التطوير:

• مراجعة الكود: اكتشف طريقة الكتابة الأنيقة لكبار السن
• التصحيح: 3 اكتشف حلا للخطأ الذي أزعج لمدة ساعة
• قراءة المستندات:اكتشاف المعلمات المفيدة المخفية ل API
• مجموعة الدراسة/المؤتمر:كان المثال الرمزي للمتحدث مفيدا

عندما تفكر "دعونا نضعهم معا لاحقا"، من السهل نسيانهم دون تسجيلهم. إذا أرسلت بريدا إلكترونيا إلى نفسك باستخدام صيغة Captio، فيمكنك التقاطها على الفور من هاتفك الذكي حتى عندما تكون أثناء التنقل.

يتم تصنيف مقتطفات التعليمات البرمجية على محور 2 من "اللغة" و"الفئة":

• علامة اللغة:[Python] [JavaScript] [TypeScript] [SQL] [Shell] [Go]
• علامة الفئة:[API] [DB] [UI] [Auth] [Deploy] [Test] [Performance]
• الحالة:[تم التحقق منها] [لم يتم التحقق منها] [تم التحقق منها]

توحيد قواعد وضع العلامات في بداية المذكرة. إذا أدخلت "[Python][API]" في بحث Gmail، فيمكنك إدراج رموز معالجة API المتعلقة ب Python على الفور.

تحدث قيمة المذكرة عند البحث عنها، وليس عند كتابتها. تعظيم معدل ضرب البحث وفقا للقواعد التالية:

• قم بتضمين نص المشكلة:"ماذا تفعل عند حدوث خطأ CORS"
• رسالة الخطأ الأصلية:"Access-Control-Allow-Origin مفقود"
• ملخص الحل:"إضافة رأس على جانب الخادم"
• جزء الرمز:الصق الرمز الذي تم نقله بالفعل
• المرجع URL:روابط إلى المستندات الرسمية وتجاوز المكدس

"عندما تواجه نفس المشكلة بعد 3 أشهر، ما الكلمات الرئيسية التي ستبحث عنها؟" الحيلة هي التخيل والكتابة.

تصبح مذكرات المقتطفات المتراكمة شخصيا بذرة لقاعدة معارف الفريق:

• أسبوعي 1 شارك: انشر المقتطف الأكثر فائدة لهذا الأسبوع إلى 1 Slack
• GitHub تحويل إلى Gist: اجمع المقتطفات التي جرى التحقق منها في Gist وأضفها إلى README
• نسخ Notion/Wiki:النتائج الخاصة بمشروع الترويج إلى الوثائق الرسمية
• مواد الإعداد:تنظيم "المشاكل والحلول الشائعة" للأعضاء الجدد

ملاحظات 1 أشخاص توفر وقت التطوير لـ 10 أشخاص. والمسار الأقوى يتكون من 3 خطوات: تسجيل فوري بأسلوب Captio، ثم تجميع في Gmail، ثم مشاركة عبر GitHub Gist.

مقتطفات Python هي إمكانية البحث إلى أقصى حد عن طريق تدوين الملاحظات باستخدام "اسم المكتبة + محتوى المعالجة". يحتوي Python على ثروة من المكتبات، لذا فإن التمييز بين المكتبات القياسية والأطراف الثالثة سيكون مفيدا لاحقا.

• قواعد التسمية:[Python][pandas] قراءة CSVs ومعالجة القيم المفقودة - تأكد من تضمين "اسم المكتبة" في العلامة
• معلومات الإصدار: Python بناء جملة جديد (مثل عبارات حالة المطابقة) التي يمكن استخدامها بعد أن يحدد 3.11 الإصدار. "[ أضف علامات مثل "Python3.11+]"
• أوامر البيئة الافتراضية: من السهل نسيان أوامر بناء البيئة مثل venv وconda والشعر على الرغم من استخدامها بشكل متكرر. "[ Python][env] poetry add --dev pytest" مثل مذكرة
• مجموعة بطانة واحدة: ستكون البطانة الواحدة القوية من Python، مثل تدوين القائمة وصيغة لامدا، ضرورية عندما تنساها. احفظ مع أمثلة محددة

يتغير إطار عمل JavaScript/TypeScript بشكل كبير، لذلك من المهم بشكل خاص وصف "اسم الإطار + الإصدار".

• React/Next.js: حدد الإصدار الرئيسي والنموذج مثل "[React18][Hooks]" و"[Next14][App Router]". تختلف مكونات الخادم تماما بين Pages Router وApp Router
• أنواع TypeScript: يسهل نسيان استخدام الأنواع العامة المعقدة والأنواع المساعدة مثل Partial وPick وOmit. دوّنها مع حالة استخدام محددة
• أمر npm/yarn: الأمر لتحديد التثبيت وإلغاء التثبيت وإصدار الحزمة يختلف قليلا. "[ Npm] npm install --save-exact package@1.2.3" مثل ملاحظة
• المتصفح API:مراقب التقاطع، عمال الويب، عامل الخدمة، وما إلى ذلك، يتم حفظ API كمقتطف عندما لا يتم تذكره على الفور عند الحاجة

تعد المعلومات المتعلقة ب "بيئة التنفيذ" و "مستوى المخاطر" مهمة بشكل خاص لأوامر البنية التحتية ل SQL shell.

• SQL: حدد نوع RDBMS، مثل "[SQL][PostgreSQL] window function ranking" و"[SQL][MySQL] JSON type column query". غالبا ما يكون ل MySQL وPostgreSQL وSQLite بناء جملة مختلف
• نص Shell:كما هو الحال في "[Shell] [مدمر] بديل آمن ل rm -rf: trash-cli"، يتم وضع علامة على الأوامر الخطرة عند تنفيذها في بيئة الإنتاج ب [مدمر]
• Docker/K8s:قم بتضمين المشاهد التشغيلية في العنوان، مثل "[Docker] تقليل حجم الصورة مع بناء متعدد المراحل" و"[K8s] تحديث ConfigMap بدون إعادة تشغيل Pod"
• Git:إذا كتبت الغرض من العملية باللغة اليابانية، مثل "[Git] تطبيق التزامات محددة فقط على فرع آخر: cherry-pick"، فسيزداد معدل ضرب البحث

هناك العديد من أدوات إدارة مقتطفات التعليمات البرمجية، ولكن الإدارة القائمة على البريد الإلكتروني لها مزاياها الخاصة في تحقيق التوازن بين "الالتقاط الفوري" و "راحة البحث".

Merit 1: وقت أقل لالتقاط

افتح GitHub Gist، وأدخل العنوان، والصق الرمز... لا يمكن استخدام التدفق أثناء السفر أو الاجتماعات. بصفتي مهندس iOS، أقوم بتجميع مقتطفات Swift عبر البريد الإلكتروني على أساس يومي، ولكن في غضون نصف عام، أصبحت 200 أو أكثر من المقتطفات مكتبة بشكل طبيعي. باستخدام نوع Captio، يمكنك كتابة مقتطف التعليمات البرمجية والسياق باستخدام 3 ثانية على هاتفك الذكي. " من المؤكد أن ترميها في البريد الإلكتروني أولا بدلا من نسيانها، "دعونا ننظمها في جوهر لاحقا".

Merit 2: أداء البحث Gmail

وظيفة البحث في Gmail عالية الأداء للغاية. إذا بحثت عن طريق المصدر + الكلمة الرئيسية، مثل من: noreply@mail.simplememofast.com python api retry"، فيمكنك تحديد ملاحظات المقتطف الخاصة بك فقط. بالطبع، من الممكن أيضا تضييق نطاق البحث عن النص الكامل حسب اسم المرفق ونطاق التاريخ.

Merit 3: لا تعتمد على الأداة

تبديل أدوات إدارة المقتطفات أمر مزعج للغاية. التصدير → مشاكل توافق الاستيراد، وفقدان العلامات والبيانات الوصفية، وما إلى ذلك. ومع ذلك، فإن البريد الإلكتروني هو آلية قياسية تم استخدامها لعقود ولا تعتمد على أدوات محددة. حتى إذا غير Gist أو Notion المواصفات أو انتهت الخدمة، فلن يتأثر المقتطف المحفوظ في البريد الإلكتروني. إذا كنت مهتما بالأداة المستندة إلى Markdown، فيرجى أيضا الاطلاع على الفرق من Obsidian و المقارنة مع Joplin.

Merit 4: يتم تسجيل السلسلة الزمنية تلقائيا

يسجل البريد الإلكتروني تلقائيا تاريخ ووقت الإرسال، حتى تتمكن من رؤية "متى قمت بحفظ هذا المقتطف" و"متى قمت بحل هذا الخطأ" بدقة. إنه مفيد جدا باعتباره "سجل المعرفة الزمنية" عند مراجعة المشاريع وكتابة المدونات الفنية.

Merit 5: مشاركة سهلة للفريق

إذا كنت ترغب في مشاركة مذكرة المقتطف المحفوظة مع زملائك، فما عليك سوى إعادة توجيه البريد الإلكتروني كما هو. لا يلزم تحويل التنسيق أو دعوة الحساب. " سأرسل لك الحل لخطأ CORS في ذلك اليوم عن طريق البريد الإلكتروني،" وتكتمل المشاركة على الفور.