Gestión de notas de fragmentos de código
del ingeniero

El momento en que los ingenieros piensan que "esto es conveniente" llega de repente durante el desarrollo:

• Revisión del código:Descubre la escritura elegante de las personas mayores
• Depuración:3 Es hora de encontrar una solución al error que te molestó
• Lectura de documentos:Descubra parámetros útiles ocultos de API
• Grupo/conferencia de estudio:El ejemplo de código del orador fue útil

Si piensas en "juntémoslos más tarde", es fácil olvidarlos sin ser grabado. Si te envías un correo electrónico a ti mismo utilizando la fórmula Captio, puedes capturarlo inmediatamente desde tu teléfono inteligente, incluso cuando estás en mora.

La clasificación del fragmento de código se realiza en el eje 2 de "idioma" y "categoría":

• Etiqueta de idioma:[Python] [JavaScript] [TypeScript] [SQL] [Shell] [Go]
• Etiqueta de categoría:[API] [DB] [UI] [Auth] [Depley] [Test] [Performance]
• Estado:[Verificado] [No verificado] [Obsoleto]

Unifica las reglas para etiquetar al principio de la nota. Si ingresa "[Python][API]" en la búsqueda Gmail, puede enumerar inmediatamente los códigos de procesamiento API relacionados con Python.

El valor de la nota ocurre cuando se "busca", no cuando se escribe. Maximice la tasa de éxito de la búsqueda de acuerdo con las siguientes reglas:

• Incluir texto del problema: "Qué hacer cuando se produce un error de CORS"
• Mensaje de error original:"Falta el control-de acceso-Permitir-origen"
• Resumen de la solución:"Añadir encabezado en el lado del servidor"
• Fragmento de código:Pega el código que realmente se movió
• Referencia URL:Documentos oficiales y enlaces de Stack Overflow

"Cuando encuentres el mismo problema después de 3 meses, ¿qué palabras clave buscarás?" El truco es imaginar y escribir.

Las notas de fragmentos acumuladas individualmente se convierten en la semilla de la base de conocimientos del equipo:

• 1 semanal Compartir:Publica los fragmentos más útiles de la semana en 1 Slack
• GitHub Gistization: Añadir fragmentos verificados a Gist y añadir a README
• Transcripción Notion/Wiki: Promoción del conocimiento específico del proyecto a la documentación oficial
• Materiales de incorporación:Organizar "Problemas y soluciones frecuentes" para los nuevos miembros

Las notas de 1 persona ahorran tiempo de desarrollo a 10 personas. El flujo de 3 pasos —capturar al instante con el método Captio, acumular en Gmail y compartir mediante GitHub Gist— es una combinación excelente.

Si observa el fragmento Python con "Nombre de la biblioteca + contenido de procesamiento", la capacidad de búsqueda se maximizará. Python tiene una gran cantidad de bibliotecas, por lo que distinguir entre bibliotecas estándar y terceros será útil más adelante.

• Reglas de nombre:[Python][pandas] Lea CSV y procese los valores que faltan: asegúrese de incluir "nombre de la biblioteca" en la etiqueta, como
• Información de la versión: Python La nueva sintaxis (como la declaración match-case) que se puede usar después de que 3.11 especifique la versión. "[ Añadir etiquetas como Python3.11+]
• Comandos de entorno virtual: Los comandos de construcción del entorno como venv, conda y poesía son fáciles de olvidar cuando se usan con frecuencia. "[ Python][env] poesía añadir --dev pytest" como una nota
• Colección de una sola línea: La poderosa frase del Python, como la notación de inclusión de la lista y la fórmula lambda, será necesaria cuando la olvides. Guardar con ejemplos específicos

JavaScript/TypeScript tiene un cambio drástico en el marco, por lo que es especialmente importante describir el "nombre del marco + versión".

• React/Next.js: Especifique las principales versiones y paradigmas como "[React18][Hooks]" y "[Next14][App Router]". Los componentes del servidor son completamente diferentes entre Pages Router y App Router
• Tipo de tipoScript:Cómo usar genéricos complejos y tipos de utilidad (Parcial, Pick, Omit) es fácil de olvidar. Memo con un caso de uso específico
• comando npm/yarn: El comando para especificar la instalación, la desinstalación y la versión del paquete es ligeramente diferente. "[ Npm] npm install --save-exact package@1.2.3" como una nota
• Navegador API:Observador de intersecciones, trabajadores web, trabajadores de servicio, etc., que se utilizan con poca frecuencia y no se pueden recordar inmediatamente cuando es necesario. API se guarda como un fragmento

La información sobre el "entorno de ejecución" y el "nivel de riesgo" de los comandos de infraestructura de shell SQL es particularmente importante.

• SQL: Especifique el tipo de RDBMS como "[SQL][PostgreSQL] clasificación de funciones de ventana" y "consulta de columna de tipo "[SQL][MySQL] JSON". MySQL, PostgreSQL y SQLite a menudo tienen una sintaxis diferente
• Shell script:Como se muestra en "[Shell][Destructive] Alternativa segura a rm-rf: trash-cli", los comandos peligrosos que se ejecutan en un entorno de producción están etiquetados con [destructivo]
• Docker/K8s: Incluir escenas operativas en el título, como "[Docker] Reducción del tamaño de la imagen con compilación de varias etapas" y "[K8s] Actualización de ConfigMap sin reinicio de Pod"
• Git:Si escribes el propósito de la operación en japonés, como "[Git] Aplica solo confirmaciones específicas a otra rama: cherry-pick", la tasa de éxito de la búsqueda aumentará

Hay muchas herramientas de gestión de fragmentos de código, pero la gestión basada en el correo electrónico tiene sus propias ventajas al equilibrar la "inmediatez de captura" y la "conveniencia de búsqueda".

Aventaja 1: Menos tiempo para capturar

Abra GitHub Gist, introduzca el título y pegue el código... El flujo no se puede utilizar durante viajes o reuniones. Como ingeniero de iOS, acumulo fragmentos de Swift por correo electrónico a diario, pero en medio año, los fragmentos de 200 o más se convirtieron naturalmente en una biblioteca. Con el tipo Captio, puede anotar el fragmento de código y el contexto con 3 segundos en su teléfono inteligente ". Es más seguro lanzarlo en el correo electrónico primero que olvidarlo, "Organicémoslo en Gist más tarde".

Merit 2: Rendimiento de búsqueda de Gmail

La función de búsqueda de Gmail es de muy alto rendimiento. " Si busca por fuente + palabra clave, como desde: noreply@mail.simplememofast.com python api retry", puede identificar solo sus notas de fragmentos. Por supuesto, la búsqueda de texto completo también se puede reducir por el nombre del archivo adjunto y el rango de fechas.

Mérit 3: Sin dependencia de la herramienta

Cambiar la herramienta de gestión de fragmentos es muy problemático. Exportar → Problemas de compatibilidad de importación, pérdida de etiquetas y metadatos, etc. Sin embargo, el correo electrónico es un mecanismo estándar que se ha utilizado durante décadas y no depende de herramientas específicas. Incluso si Gist o Notion cambian las especificaciones o el servicio finaliza, el fragmento guardado en el correo electrónico no se verá afectado. Si está interesado en la herramienta basada en Markdown, consulte también Diferencia de Obsidian y comparación con Joplin.

Mérit 4: La serie temporal se registra automáticamente

La fecha y hora de transmisión se registran automáticamente en el correo electrónico, para que pueda ver con precisión "cuándo guardó este fragmento" y "cuándo resolvió este error". Es muy útil como "registro de conocimiento cronológico" al revisar proyectos y escribir blogs técnicos.

Mérit 5: Fácil intercambio en equipo

Si desea compartir su nota de fragmento guardada con sus colegas, simplemente reenvíela tal como está por correo electrónico. No se requiere conversión de formato ni invitación de cuenta. " Te enviaré la solución al error CORS el otro día por correo electrónico", y el intercambio se completa de inmediato.