Inglés para programadores · Documentación

Documentación en inglés: frases para README y docs

Respuesta rápida

Escribir documentación en inglés es más fácil con frases modelo: cómo instalar, cómo usar, qué hace cada parámetro, qué cambió en la versión. Elegimos 300 frases de la app Devlingo para README, docs de API, comentarios y changelog, con traducción, contexto y audio.

Actualizado el

La documentación en inglés usa frases cortas en imperativo para los pasos (Run the following command) y en presente para describir (This function returns…). Evita simply y just: lo que es simple para ti puede no serlo para quien lee.

Frases fáciles (94)

  1. Please refer to the README for setup instructions.

    Consulta el README para las instrucciones de configuración.

    Cuándo usarla: Directing someone to the project README file

  2. This function returns a list of active users.

    Esta función devuelve una lista de usuarios activos.

    Cuándo usarla: Writing an inline comment describing a function's return value

  3. See the changelog for a list of recent updates.

    Consulta el changelog para ver las actualizaciones recientes.

    Cuándo usarla: Pointing someone to the changelog file

  4. Make sure to update the docs before merging.

    Asegúrate de actualizar la documentación antes de hacer merge.

    Cuándo usarla: Reminding a teammate to keep documentation in sync with code changes

  5. This endpoint accepts a JSON body with the following fields.

    Este endpoint acepta un cuerpo JSON con los siguientes campos.

    Cuándo usarla: Documenting an API endpoint's request format

  6. Add a brief description of your changes to the pull request.

    Agrega una breve descripción de tus cambios al pull request.

    Cuándo usarla: Asking someone to document their PR properly

  7. I'll add code comments to explain the business logic.

    Agregaré comentarios en el código para explicar la lógica de negocio.

    Cuándo usarla: Committing to document complex business rules in the code

  8. The API returns a 404 status code if the resource is not found.

    La API devuelve un código de estado 404 si el recurso no se encuentra.

    Cuándo usarla: Documenting an API error response in the docs

  9. Before running the project locally, make sure you have Node.js 18 or later installed.

    Antes de ejecutar el proyecto localmente, asegúrate de tener instalado Node.js 18 o superior.

    Cuándo usarla: Writing prerequisites in an onboarding or setup guide

  10. The configuration file supports hot reloading, so changes take effect without restarting the application.

    El archivo de configuración soporta recarga en caliente, por lo que los cambios surten efecto sin reiniciar la aplicación.

    Cuándo usarla: Documenting hot reload capabilities in configuration docs

  11. We need to update the README with the new setup instructions.

    Necesitamos actualizar el README con las nuevas instrucciones de configuración.

    Cuándo usarla: When the project setup process has changed and the README is outdated

  12. Please add a code comment explaining why we chose this approach.

    Por favor, agrega un comentario en el código explicando por qué elegimos este enfoque.

    Cuándo usarla: During code review when a non-obvious implementation decision lacks explanation

  13. I wrote an onboarding guide so new developers can get started quickly.

    Escribí una guía de incorporación para que los nuevos desarrolladores puedan empezar rápidamente.

    Cuándo usarla: When a team member creates documentation to help new hires ramp up

  14. Don't forget to update the changelog before we tag the release.

    No olvides actualizar el changelog antes de etiquetar la versión.

    Cuándo usarla: Reminding a team member to document changes before cutting a new release

  15. Let's add architecture diagrams to the documentation so new developers can understand the system at a glance.

    Agreguemos diagramas de arquitectura a la documentación para que los nuevos desarrolladores puedan entender el sistema de un vistazo.

    Cuándo usarla: Proposing visual documentation to improve system understanding

  16. The environment setup instructions need to be tested on a clean machine.

    Las instrucciones de configuración del entorno necesitan ser probadas en una máquina limpia.

    Cuándo usarla: When verifying that setup documentation works for someone starting from scratch

  17. Our internal wiki has become outdated and needs a comprehensive review.

    Nuestra wiki interna se ha quedado desactualizada y necesita una revisión integral.

    Cuándo usarla: When recognizing that internal documentation has fallen behind the actual system state

  18. Every pull request that changes the API must include documentation updates.

    Cada pull request que cambie la API debe incluir actualizaciones de documentación.

    Cuándo usarla: Establishing a team policy about keeping docs in sync with code changes

  19. Comments should explain why the code does something, not what it does.

    Los comentarios deben explicar por qué el código hace algo, no qué hace.

    Cuándo usarla: Giving feedback during code review about the quality of code comments

  20. I added inline documentation for all public methods in the SDK.

    Agregué documentación en línea para todos los métodos públicos del SDK.

    Cuándo usarla: Reporting completion of documentation work on a public-facing library

  21. Please keep the README concise and link to detailed docs for advanced configuration.

    Por favor, mantén el README conciso y enlaza a la documentación detallada para configuración avanzada.

    Cuándo usarla: Advising on README structure to avoid overwhelming new users

  22. Avoid using TODO comments as a substitute for proper task tracking.

    Evita usar comentarios TODO como sustituto de un seguimiento adecuado de tareas.

    Cuándo usarla: Advising against overreliance on code comments for project management

  23. Add a table of contents to the README since it has grown to over fifty sections.

    Agrega una tabla de contenidos al README ya que ha crecido a más de cincuenta secciones.

    Cuándo usarla: When a README has become too long to navigate without an index

  24. Stale documentation is worse than no documentation because it misleads developers.

    La documentación desactualizada es peor que no tener documentación porque engaña a los desarrolladores.

    Cuándo usarla: Arguing for the importance of keeping documentation up to date

  25. Write the error codes table so support engineers can quickly identify issues.

    Escribe la tabla de códigos de error para que los ingenieros de soporte puedan identificar problemas rápidamente.

    Cuándo usarla: Creating reference documentation that maps error codes to their meanings

  26. The how-to guide should include common pitfalls and their solutions.

    La guía práctica debe incluir errores comunes y sus soluciones.

    Cuándo usarla: Improving a how-to guide with troubleshooting information

  27. I wrote a step-by-step tutorial on how to integrate our webhook system.

    Escribí un tutorial paso a paso sobre cómo integrar nuestro sistema de webhooks.

    Cuándo usarla: Creating educational content for a developer platform

  28. Add a prerequisites section to the setup guide listing required software versions.

    Agrega una sección de requisitos previos a la guía de configuración listando las versiones de software requeridas.

    Cuándo usarla: Improving setup documentation with dependency information

  29. The wiki page on our caching strategy has not been updated since last year.

    La página wiki sobre nuestra estrategia de caché no se ha actualizado desde el año pasado.

    Cuándo usarla: Identifying stale internal documentation that needs attention

  30. Every public function must have a documentation comment describing its parameters and return value.

    Toda función pública debe tener un comentario de documentación describiendo sus parámetros y valor de retorno.

    Cuándo usarla: Enforcing documentation standards in a code review checklist

  31. Let's add a glossary to the docs defining all domain-specific terms we use.

    Agreguemos un glosario a la documentación definiendo todos los términos específicos del dominio que usamos.

    Cuándo usarla: Proposing to add terminology definitions to make documentation more accessible

  32. Please update the environment variable documentation to include the new feature flag.

    Por favor, actualiza la documentación de variables de entorno para incluir la nueva feature flag.

    Cuándo usarla: When a new feature flag has been added but the configuration docs are not updated

  33. Good documentation is an investment that pays off by reducing support tickets and onboarding time.

    Una buena documentación es una inversión que se paga al reducir tickets de soporte y tiempo de incorporación.

    Cuándo usarla: Advocating for documentation investment during a team planning meeting

  34. We added a frequently asked questions page based on the most common support requests.

    Agregamos una página de preguntas frecuentes basada en las solicitudes de soporte más comunes.

    Cuándo usarla: Using support data to drive documentation improvements

  35. We decided to use Markdown for all documentation because it renders well on GitHub and is easy to diff.

    Decidimos usar Markdown para toda la documentación porque se renderiza bien en GitHub y es fácil de comparar.

    Cuándo usarla: Explaining the rationale behind the documentation format choice

  36. New team members should complete the documentation scavenger hunt during their first week.

    Los nuevos miembros del equipo deben completar la búsqueda del tesoro de documentación durante su primera semana.

    Cuándo usarla: Describing an onboarding exercise that familiarizes new hires with existing documentation

  37. I moved the legacy setup instructions to an archive page so they do not confuse new users.

    Moví las instrucciones de configuración heredadas a una página de archivo para que no confundan a los nuevos usuarios.

    Cuándo usarla: Cleaning up documentation by separating outdated content from current content

  38. Remove the outdated screenshots from the docs and replace them with current ones.

    Elimina las capturas de pantalla desactualizadas de la documentación y reemplázalas con las actuales.

    Cuándo usarla: Updating visual documentation to match the current state of the application

  39. I noticed the README still references the old package name that we renamed three months ago.

    Noté que el README todavía hace referencia al nombre antiguo del paquete que renombramos hace tres meses.

    Cuándo usarla: Finding outdated information in documentation during a routine check

  40. We maintain separate getting-started guides for mobile developers and backend developers.

    Mantenemos guías de inicio separadas para desarrolladores móviles y desarrolladores backend.

    Cuándo usarla: Describing audience-specific documentation for different developer personas

  41. The README badge shows the build status, code coverage, and the latest release version.

    La insignia del README muestra el estado del build, cobertura de código y la última versión de lanzamiento.

    Cuándo usarla: Describing visual status indicators commonly placed in project README files

  42. The technical writing team reviews all public-facing documentation before it goes live.

    El equipo de redacción técnica revisa toda la documentación pública antes de que se publique.

    Cuándo usarla: Describing the quality assurance process for documentation publishing

  43. The README should include setup instructions for new developers

    El README debería incluir instrucciones de configuración para nuevos desarrolladores

    Cuándo usarla: Onboarding documentation

  44. The changelog needs to be updated before the release

    El changelog necesita ser actualizado antes del lanzamiento

    Cuándo usarla: Release documentation process

  45. This function is missing its documentation comment

    Esta función le falta su comentario de documentación

    Cuándo usarla: Adding inline code documentation

  46. The glossary helps new team members understand our terminology

    El glosario ayuda a los nuevos miembros del equipo a entender nuestra terminología

    Cuándo usarla: Creating a project glossary

  47. Can you review the inline comments for accuracy?

    ¿Puedes revisar los comentarios inline para verificar su precisión?

    Cuándo usarla: Reviewing code comments

  48. The user guide needs screenshots of the latest interface

    La guía del usuario necesita capturas de pantalla de la interfaz más reciente

    Cuándo usarla: Updating visual documentation

  49. I added a prerequisites section at the top of the guide

    Agregué una sección de prerrequisitos al inicio de la guía

    Cuándo usarla: Setting up documentation structure

  50. The contributing guide outlines how to submit pull requests

    La guía de contribución describe cómo enviar pull requests

    Cuándo usarla: Open source contribution documentation

  51. Let's create a FAQ section based on the most asked questions

    Creemos una sección de FAQ basada en las preguntas más frecuentes

    Cuándo usarla: Building FAQ documentation

  52. The style guide ensures consistency across the documentation

    La guía de estilo asegura consistencia en toda la documentación

    Cuándo usarla: Documentation standards

  53. The release notes should highlight new features and bug fixes

    Las notas de lanzamiento deben resaltar nuevas funcionalidades y correcciones de bugs

    Cuándo usarla: Writing release documentation

  54. The parameter description is missing from the function header

    La descripción del parámetro falta en el encabezado de la función

    Cuándo usarla: Completing function documentation

  55. The onboarding documentation should include common pitfalls

    La documentación de onboarding debería incluir errores comunes

    Cuándo usarla: Helping new team members avoid mistakes

  56. The README badges show the build status and test coverage

    Los badges del README muestran el estado del build y cobertura de pruebas

    Cuándo usarla: Adding status badges to documentation

  57. Let's document the environment variables required to run the app

    Documentemos las variables de entorno necesarias para ejecutar la app

    Cuándo usarla: Configuration documentation

  58. Let's add a table of contents to make the document easier to navigate

    Agreguemos una tabla de contenidos para facilitar la navegación del documento

    Cuándo usarla: Improving documentation navigation

  59. Please update the installation instructions for the latest version

    Por favor actualiza las instrucciones de instalación para la última versión

    Cuándo usarla: Keeping setup docs current

  60. We should add cross-references between related documentation pages

    Deberíamos agregar referencias cruzadas entre páginas de documentación relacionadas

    Cuándo usarla: Linking documentation together

  61. The code review checklist should be part of the documentation

    La lista de verificación de code review debería ser parte de la documentación

    Cuándo usarla: Standardizing review processes

  62. Let's keep the documentation language simple and avoid jargon

    Mantengamos el lenguaje de la documentación simple y evitemos jerga

    Cuándo usarla: Writing accessible documentation

  63. Let's add a known issues section to the release notes

    Agreguemos una sección de problemas conocidos en las notas de lanzamiento

    Cuándo usarla: Documenting known limitations

  64. Can you proofread the documentation for grammar and spelling?

    ¿Puedes revisar la documentación en cuanto a gramática y ortografía?

    Cuándo usarla: Documentation quality review

  65. I added a section on how to run the project locally

    Agregué una sección sobre cómo ejecutar el proyecto localmente

    Cuándo usarla: Local development documentation

  66. Can you add a comparison table between the free and premium features?

    ¿Puedes agregar una tabla comparativa entre las funcionalidades free y premium?

    Cuándo usarla: Feature comparison documentation

  67. Let's create a cheat sheet with the most common commands

    Creemos una hoja de trucos con los comandos más comunes

    Cuándo usarla: Quick reference documentation

  68. The coding standards document should be the first thing new developers read

    El documento de estándares de código debería ser lo primero que lean los nuevos desarrolladores

    Cuándo usarla: Establishing coding conventions

  69. Let's add a section about the development workflow and branching strategy

    Agreguemos una sección sobre el flujo de desarrollo y estrategia de ramas

    Cuándo usarla: Git workflow documentation

  70. Let's create a video walkthrough for the complex setup process

    Creemos un video tutorial para el proceso de configuración complejo

    Cuándo usarla: Creating video documentation

  71. The documentation template standardizes how we write new guides

    La plantilla de documentación estandariza cómo escribimos nuevas guías

    Cuándo usarla: Documentation templates

  72. Can you add sequence numbers to the API workflow steps?

    ¿Puedes agregar números de secuencia a los pasos del workflow de la API?

    Cuándo usarla: Ordering documentation steps

  73. The documentation should specify which platforms are supported

    La documentación debería especificar qué plataformas son soportadas

    Cuándo usarla: Platform compatibility docs

  74. Can you write a brief summary at the top of each documentation page?

    ¿Puedes escribir un breve resumen al inicio de cada página de documentación?

    Cuándo usarla: Documentation readability improvement

  75. The documentation review is part of our definition of done

    La revisión de la documentación es parte de nuestra definición de hecho

    Cuándo usarla: Documentation as quality gate

  76. I added a troubleshooting flowchart to help diagnose common problems

    Agregué un diagrama de flujo de resolución de problemas para ayudar a diagnosticar problemas comunes

    Cuándo usarla: Visual troubleshooting guides

  77. The documentation should explain the difference between each log level

    La documentación debería explicar la diferencia entre cada nivel de log

    Cuándo usarla: Logging documentation

  78. Let's create a visual guide for the entire user journey

    Creemos una guía visual para todo el recorrido del usuario

    Cuándo usarla: User experience documentation

  79. The documentation should link to the related Jira tickets for context

    La documentación debería enlazar a los tickets de Jira relacionados para contexto

    Cuándo usarla: Connecting docs to project management

  80. Can you add a section explaining the conventions used throughout the docs?

    ¿Puedes agregar una sección explicando las convenciones usadas en toda la documentación?

    Cuándo usarla: Documentation meta-information

  81. The API documentation clearly distinguishes between required and optional fields

    La documentación de la API distingue claramente entre campos obligatorios y opcionales

    Cuándo usarla: API field documentation

  82. The API documentation should include curl examples for quick testing

    La documentación de la API debería incluir ejemplos con curl para prueba rápida

    Cuándo usarla: Adding practical API examples

  83. The documentation portal should have a feedback mechanism for readers

    El portal de documentación debería tener un mecanismo de feedback para los lectores

    Cuándo usarla: Documentation feedback loop

  84. The documentation should include a system requirements section

    La documentación debería incluir una sección de requisitos del sistema

    Cuándo usarla: System prerequisites documentation

  85. We should add a decision tree for choosing the right component

    Deberíamos agregar un árbol de decisión para elegir el componente correcto

    Cuándo usarla: Component selection guide

  86. The documentation should include a section on how to report security issues

    La documentación debería incluir una sección sobre cómo reportar problemas de seguridad

    Cuándo usarla: Security reporting documentation

  87. The documentation portal has a dark mode toggle for better readability

    El portal de documentación tiene un toggle de modo oscuro para mejor legibilidad

    Cuándo usarla: Documentation UX improvement

  88. Let's add a list of all the environment variables with their descriptions

    Agreguemos una lista de todas las variables de entorno con sus descripciones

    Cuándo usarla: Environment variable reference

  89. The documentation uses consistent terminology throughout all sections

    La documentación usa terminología consistente en todas las secciones

    Cuándo usarla: Documentation consistency

  90. Let's create a glossary of abbreviations used in the codebase

    Creemos un glosario de abreviaturas usadas en el código

    Cuándo usarla: Abbreviation reference documentation

  91. The documentation includes a compatibility matrix for browser and OS support

    La documentación incluye una matriz de compatibilidad para soporte de navegador y SO

    Cuándo usarla: Compatibility documentation

  92. The API documentation should group endpoints by resource type

    La documentación de la API debería agrupar endpoints por tipo de recurso

    Cuándo usarla: API documentation organization

  93. I created a reference card summarizing the most important configuration values

    Creé una tarjeta de referencia resumiendo los valores de configuración más importantes

    Cuándo usarla: Quick reference documentation

  94. Can you add timestamps to the documentation pages to show when they were last updated?

    ¿Puedes agregar timestamps a las páginas de documentación para mostrar cuándo fueron actualizadas?

    Cuándo usarla: Documentation freshness tracking

Frases intermedias (125)

  1. We should document the environment variables required to run the project.

    Deberíamos documentar las variables de entorno necesarias para ejecutar el proyecto.

    Cuándo usarla: Suggesting adding configuration documentation

  2. Each parameter is described in the table below with its type and default value.

    Cada parámetro se describe en la tabla a continuación con su tipo y valor predeterminado.

    Cuándo usarla: Introducing a parameters table in API documentation

  3. This section covers the migration steps from version 2 to version 3.

    Esta sección cubre los pasos de migración de la versión 2 a la versión 3.

    Cuándo usarla: Writing a migration guide introduction

  4. Deprecated: This method will be removed in the next major release. Use fetchData() instead.

    Obsoleto: Este método será eliminado en la próxima versión principal. Usa fetchData() en su lugar.

    Cuándo usarla: Writing a deprecation notice in code documentation

  5. The architecture follows a clean separation between the data layer, domain layer, and presentation layer.

    La arquitectura sigue una separación clara entre la capa de datos, la capa de dominio y la capa de presentación.

    Cuándo usarla: Describing the app architecture in a design document

  6. Please include a code example showing how to initialize the SDK.

    Por favor, incluye un ejemplo de código que muestre cómo inicializar el SDK.

    Cuándo usarla: Requesting a usage example in documentation

  7. Known issue: The search feature may return duplicate results under heavy load.

    Problema conocido: La función de búsqueda puede devolver resultados duplicados bajo carga pesada.

    Cuándo usarla: Documenting a known bug in release notes or troubleshooting guide

  8. Authentication is handled via JWT tokens passed in the Authorization header.

    La autenticación se maneja mediante tokens JWT enviados en el encabezado Authorization.

    Cuándo usarla: Explaining the authentication mechanism in API docs

  9. The troubleshooting section addresses the most commonly reported issues and their solutions.

    La sección de solución de problemas aborda los problemas reportados con más frecuencia y sus soluciones.

    Cuándo usarla: Introducing the troubleshooting section of a guide

  10. To configure the database connection, set the DATABASE_URL environment variable in your .env file.

    Para configurar la conexión a la base de datos, establece la variable de entorno DATABASE_URL en tu archivo .env.

    Cuándo usarla: Explaining database configuration in setup documentation

  11. The API docs are missing examples for the authentication endpoints.

    La documentación de la API no tiene ejemplos para los endpoints de autenticación.

    Cuándo usarla: When reviewing API documentation and finding incomplete sections

  12. This function is complex enough to warrant a detailed docstring.

    Esta función es lo suficientemente compleja como para justificar un docstring detallado.

    Cuándo usarla: During code review when a complex function lacks proper documentation

  13. We should document the database schema changes in the migration guide.

    Deberíamos documentar los cambios en el esquema de la base de datos en la guía de migración.

    Cuándo usarla: When planning a database migration and needing to communicate changes to the team

  14. Can you write a troubleshooting guide for the most common deployment errors?

    ¿Puedes escribir una guía de resolución de problemas para los errores de despliegue más comunes?

    Cuándo usarla: Asking a team member to create operational documentation for known issues

  15. The FAQ section should cover questions about rate limiting and pagination.

    La sección de preguntas frecuentes debería cubrir preguntas sobre limitación de tasa y paginación.

    Cuándo usarla: When building out an API documentation site and planning the FAQ content

  16. The migration guide should include step-by-step instructions and a rollback plan in case something goes wrong.

    La guía de migración debe incluir instrucciones paso a paso y un plan de reversión en caso de que algo salga mal.

    Cuándo usarla: Discussing requirements for a version migration guide

  17. We need to document the API rate limits so consumers know how many requests they can make per minute.

    Necesitamos documentar los límites de tasa de la API para que los consumidores sepan cuántas solicitudes pueden hacer por minuto.

    Cuándo usarla: Adding rate limit information to API documentation

  18. Our contributing guidelines explain how to set up the development environment and submit pull requests.

    Nuestras pautas de contribución explican cómo configurar el entorno de desarrollo y enviar pull requests.

    Cuándo usarla: Describing the content of an open source project's CONTRIBUTING.md file

  19. We need to add a deprecation notice with the recommended alternative approach.

    Necesitamos agregar un aviso de deprecación con el enfoque alternativo recomendado.

    Cuándo usarla: When sunsetting a feature and needing to guide users to the replacement

  20. The tutorial walks through building a REST API from scratch with authentication.

    El tutorial guía en la construcción de una API REST desde cero con autenticación.

    Cuándo usarla: Describing the scope of a how-to guide in developer documentation

  21. Each release note should highlight breaking changes at the top of the document.

    Cada nota de versión debe destacar los cambios incompatibles al inicio del documento.

    Cuándo usarla: Setting standards for how release notes should be structured

  22. We use JSDoc annotations to generate our TypeScript library documentation.

    Usamos anotaciones JSDoc para generar la documentación de nuestra biblioteca TypeScript.

    Cuándo usarla: Explaining the documentation tooling used in a JavaScript/TypeScript project

  23. I created a quick-start guide that gets developers to their first API call in five minutes.

    Creé una guía de inicio rápido que lleva a los desarrolladores a su primera llamada API en cinco minutos.

    Cuándo usarla: Describing a new developer experience improvement in API documentation

  24. The upgrade path from the legacy system is documented in the migration playbook.

    La ruta de actualización del sistema heredado está documentada en el manual de migración.

    Cuándo usarla: Directing team members to existing documentation about a system migration

  25. We generate our API reference documentation directly from the source code annotations.

    Generamos nuestra documentación de referencia de la API directamente de las anotaciones del código fuente.

    Cuándo usarla: Explaining the documentation generation pipeline to a new team member

  26. The Swagger UI lets developers test API endpoints interactively from the documentation.

    Swagger UI permite a los desarrolladores probar endpoints de la API de forma interactiva desde la documentación.

    Cuándo usarla: Explaining the benefits of interactive API documentation

  27. The configuration file supports twelve parameters, and each one is documented with valid ranges.

    El archivo de configuración admite doce parámetros, y cada uno está documentado con rangos válidos.

    Cuándo usarla: Describing thorough configuration documentation with validation details

  28. I set up a documentation linter to catch broken links and formatting issues automatically.

    Configuré un linter de documentación para detectar enlaces rotos y problemas de formato automáticamente.

    Cuándo usarla: Implementing automated quality checks for documentation

  29. We need to version our API documentation separately from the codebase.

    Necesitamos versionar nuestra documentación de API por separado del código base.

    Cuándo usarla: Discussing documentation versioning strategy for a public API

  30. Each microservice has its own README explaining its purpose, dependencies, and how to run it locally.

    Cada microservicio tiene su propio README explicando su propósito, dependencias y cómo ejecutarlo localmente.

    Cuándo usarla: Describing documentation standards in a microservices architecture

  31. The release notes follow the keep-a-changelog format with added, changed, fixed, and removed sections.

    Las notas de versión siguen el formato keep-a-changelog con secciones de agregado, cambiado, corregido y eliminado.

    Cuándo usarla: Describing the structure used for organizing release notes

  32. Include curl examples alongside the SDK code samples in the API reference.

    Incluye ejemplos de curl junto con las muestras de código del SDK en la referencia de la API.

    Cuándo usarla: Improving API documentation accessibility for developers who prefer raw HTTP calls

  33. The changelog entry should be written from the user's perspective, not the developer's.

    La entrada del changelog debe estar escrita desde la perspectiva del usuario, no del desarrollador.

    Cuándo usarla: Giving feedback on how to write user-friendly changelog entries

  34. The troubleshooting guide needs a decision tree to help narrow down the root cause.

    La guía de resolución de problemas necesita un árbol de decisiones para ayudar a identificar la causa raíz.

    Cuándo usarla: Improving a troubleshooting document with a structured diagnostic approach

  35. The internal knowledge base should have a dedicated section for incident response procedures.

    La base de conocimiento interna debería tener una sección dedicada a procedimientos de respuesta a incidentes.

    Cuándo usarla: Organizing operational documentation within a company knowledge management system

  36. We track documentation coverage the same way we track code coverage.

    Rastreamos la cobertura de documentación de la misma manera que rastreamos la cobertura de código.

    Cuándo usarla: Describing a mature documentation practice with metrics and accountability

  37. The API rate limit headers should be explained in the authentication section of our docs.

    Los headers de límite de tasa de la API deben explicarse en la sección de autenticación de nuestra documentación.

    Cuándo usarla: Identifying where rate limit information should be documented in the API reference

  38. The runbook should specify the exact commands to run, not just describe the general procedure.

    El runbook debe especificar los comandos exactos a ejecutar, no solo describir el procedimiento general.

    Cuándo usarla: Reviewing a runbook and requesting more actionable content

  39. The database documentation should include a section on backup and recovery procedures.

    La documentación de la base de datos debe incluir una sección sobre procedimientos de respaldo y recuperación.

    Cuándo usarla: Ensuring database documentation covers operational aspects beyond just the schema

  40. We should write a code style guide that documents our team's conventions for naming and formatting.

    Deberíamos escribir una guía de estilo de código que documente las convenciones de nuestro equipo para nomenclatura y formato.

    Cuándo usarla: Proposing documentation of coding standards for team consistency

  41. Make sure to cross-reference related documentation pages so readers can find additional context.

    Asegúrate de hacer referencias cruzadas entre páginas de documentación relacionadas para que los lectores encuentren contexto adicional.

    Cuándo usarla: Improving documentation navigation through internal linking

  42. The configuration reference lists every option with its type, default value, and a brief description.

    La referencia de configuración lista cada opción con su tipo, valor por defecto y una breve descripción.

    Cuándo usarla: Describing a well-structured configuration documentation page

  43. We automated the deployment of our documentation site using a continuous integration pipeline.

    Automatizamos el despliegue de nuestro sitio de documentación usando un pipeline de integración continua.

    Cuándo usarla: Describing the documentation deployment infrastructure

  44. The onboarding checklist includes reading the architecture overview, setting up the local environment, and running the test suite.

    La lista de verificación de incorporación incluye leer la visión general de la arquitectura, configurar el entorno local y ejecutar la suite de pruebas.

    Cuándo usarla: Outlining the key steps in a developer onboarding process

  45. Avoid writing documentation that duplicates what the code already communicates through good naming.

    Evita escribir documentación que duplique lo que el código ya comunica a través de buenos nombres.

    Cuándo usarla: Discussing when documentation adds value versus when it becomes redundant noise

  46. The troubleshooting page should be organized by symptom so users can find answers based on what they observe.

    La página de resolución de problemas debe estar organizada por síntoma para que los usuarios encuentren respuestas basándose en lo que observan.

    Cuándo usarla: Structuring troubleshooting documentation for better usability

  47. The deprecation timeline gives users twelve months to migrate before the old API is shut down.

    El cronograma de deprecación da a los usuarios doce meses para migrar antes de que la API antigua sea desactivada.

    Cuándo usarla: Communicating a deprecation schedule in API documentation

  48. The wiki should be searchable and every page should have an owner responsible for keeping it current.

    La wiki debe ser buscable y cada página debe tener un responsable de mantenerla actualizada.

    Cuándo usarla: Establishing governance practices for internal documentation

  49. Can you add a code example to this API reference?

    ¿Puedes agregar un ejemplo de código a esta referencia de API?

    Cuándo usarla: Enhancing API documentation

  50. We should document the error codes and their meanings

    Deberíamos documentar los códigos de error y sus significados

    Cuándo usarla: Creating error reference documentation

  51. Please add the return type description to the docstring

    Por favor agrega la descripción del tipo de retorno en la docstring

    Cuándo usarla: Completing function documentation

  52. I wrote a troubleshooting section for the most common issues

    Escribí una sección de solución de problemas para los problemas más comunes

    Cuándo usarla: Creating self-service support docs

  53. The API endpoint documentation is outdated and needs a refresh

    La documentación del endpoint de la API está desactualizada y necesita una actualización

    Cuándo usarla: Updating stale documentation

  54. Let's add a sequence diagram to explain this workflow

    Agreguemos un diagrama de secuencia para explicar este flujo de trabajo

    Cuándo usarla: Using visual diagrams in documentation

  55. The configuration options should be documented with default values

    Las opciones de configuración deberían documentarse con valores predeterminados

    Cuándo usarla: Documenting configurable settings

  56. We need to add deprecation notices to the old API methods

    Necesitamos agregar avisos de depreciación a los métodos antiguos de la API

    Cuándo usarla: Marking deprecated functionality

  57. The documentation should be versioned alongside the code

    La documentación debería versionarse junto con el código

    Cuándo usarla: Documentation versioning strategy

  58. We should add type annotations to improve the documentation clarity

    Deberíamos agregar anotaciones de tipo para mejorar la claridad de la documentación

    Cuándo usarla: Using type information for documentation

  59. This technical specification needs peer review before publishing

    Esta especificación técnica necesita revisión por pares antes de publicar

    Cuándo usarla: Documentation review process

  60. I documented the data model relationships in a diagram

    Documenté las relaciones del modelo de datos en un diagrama

    Cuándo usarla: Creating data model documentation

  61. Can you write a quick start guide for the SDK?

    ¿Puedes escribir una guía de inicio rápido para el SDK?

    Cuándo usarla: Creating getting started documentation

  62. Let's use Swagger to generate the API documentation automatically

    Usemos Swagger para generar la documentación de la API automáticamente

    Cuándo usarla: Automated documentation tools

  63. I noticed the code samples in the docs don't compile anymore

    Noté que los ejemplos de código en los docs ya no compilan

    Cuándo usarla: Maintaining documentation accuracy

  64. We should add a data dictionary for the database tables

    Deberíamos agregar un diccionario de datos para las tablas de la base de datos

    Cuándo usarla: Database documentation

  65. The API rate limits should be clearly documented for consumers

    Los límites de tasa de la API deberían documentarse claramente para los consumidores

    Cuándo usarla: Documenting API constraints

  66. I created a decision log to track our architectural choices

    Creé un registro de decisiones para rastrear nuestras elecciones arquitecturales

    Cuándo usarla: Recording project decisions

  67. The class diagram needs to be updated after the refactoring

    El diagrama de clases necesita ser actualizado después de la refactorización

    Cuándo usarla: Keeping diagrams in sync with code

  68. Can you add usage examples for each public method?

    ¿Puedes agregar ejemplos de uso para cada método público?

    Cuándo usarla: Creating comprehensive method documentation

  69. I wrote a tutorial that walks through building a feature from scratch

    Escribí un tutorial que guía a través de la construcción de una funcionalidad desde cero

    Cuándo usarla: Creating tutorial documentation

  70. The testing strategy document outlines our quality assurance approach

    El documento de estrategia de pruebas describe nuestro enfoque de aseguramiento de calidad

    Cuándo usarla: QA documentation

  71. I added examples showing both success and error response formats

    Agregué ejemplos mostrando los formatos de respuesta de éxito y error

    Cuándo usarla: Documenting API response formats

  72. The webhook documentation needs to include payload examples

    La documentación de webhooks necesita incluir ejemplos de payload

    Cuándo usarla: Documenting webhook integrations

  73. We documented the design system with component specifications

    Documentamos el design system con especificaciones de componentes

    Cuándo usarla: Design system documentation

  74. The dependency list should include version requirements and licenses

    La lista de dependencias debería incluir requisitos de versión y licencias

    Cuándo usarla: Documenting project dependencies

  75. The documentation should include accessibility guidelines for the UI

    La documentación debería incluir directrices de accesibilidad para la UI

    Cuándo usarla: Accessibility documentation

  76. We need to update the architecture overview after adding the new service

    Necesitamos actualizar la vista general de la arquitectura después de agregar el nuevo servicio

    Cuándo usarla: Maintaining system architecture docs

  77. The API changelog tracks all breaking and non-breaking changes

    El changelog de la API rastrea todos los cambios que rompen y que no rompen

    Cuándo usarla: API change management documentation

  78. The integration guide explains how to connect with third-party services

    La guía de integración explica cómo conectar con servicios de terceros

    Cuándo usarla: Third-party integration documentation

  79. Let's document the feature flags and how they affect behavior

    Documentemos las feature flags y cómo afectan el comportamiento

    Cuándo usarla: Feature flag documentation

  80. The data flow documentation shows how information moves through the system

    La documentación de flujo de datos muestra cómo la información se mueve por el sistema

    Cuándo usarla: System data flow documentation

  81. The API documentation should include request and response headers

    La documentación de la API debería incluir headers de solicitud y respuesta

    Cuándo usarla: Complete API documentation

  82. I documented the localization workflow for adding new languages

    Documenté el flujo de trabajo de localización para agregar nuevos idiomas

    Cuándo usarla: Internationalization process documentation

  83. We need inline documentation for the complex business logic

    Necesitamos documentación inline para la lógica de negocio compleja

    Cuándo usarla: Documenting domain-specific code

  84. Can you update the entity relationship diagram with the new tables?

    ¿Puedes actualizar el diagrama de entidad-relación con las nuevas tablas?

    Cuándo usarla: Maintaining database diagrams

  85. The documentation search needs to be indexed for better discoverability

    La búsqueda en la documentación necesita ser indexada para mejor descubrimiento

    Cuándo usarla: Improving documentation search

  86. We should keep a log of all the technical debt we identify

    Deberíamos mantener un registro de toda la deuda técnica que identificamos

    Cuándo usarla: Technical debt tracking docs

  87. The API sandbox documentation helps developers test without affecting production

    La documentación del sandbox de la API ayuda a los desarrolladores a probar sin afectar producción

    Cuándo usarla: Sandbox environment docs

  88. The auto-generated documentation needs manual review for accuracy

    La documentación generada automáticamente necesita revisión manual para precisión

    Cuándo usarla: Validating auto-generated docs

  89. The API pagination documentation should show cursor-based and offset examples

    La documentación de paginación de la API debería mostrar ejemplos basados en cursor y offset

    Cuándo usarla: Pagination documentation

  90. Let's add interactive code samples that readers can run directly

    Agreguemos ejemplos de código interactivos que los lectores puedan ejecutar directamente

    Cuándo usarla: Interactive documentation

  91. I documented the design tokens used across the component library

    Documenté los design tokens usados en la biblioteca de componentes

    Cuándo usarla: Design token documentation

  92. We need to document the data validation rules for each input field

    Necesitamos documentar las reglas de validación de datos para cada campo de entrada

    Cuándo usarla: Input validation documentation

  93. The documentation needs to be accessible to non-technical stakeholders

    La documentación necesita ser accesible para stakeholders no técnicos

    Cuándo usarla: Writing for mixed audiences

  94. I updated the API documentation to reflect the new response format

    Actualicé la documentación de la API para reflejar el nuevo formato de respuesta

    Cuándo usarla: Keeping API docs in sync

  95. We should document how the cron jobs are scheduled and monitored

    Deberíamos documentar cómo los cron jobs son programados y monitoreados

    Cuándo usarla: Scheduled jobs documentation

  96. The component storybook serves as living documentation for the UI

    El storybook de componentes sirve como documentación viva para la UI

    Cuándo usarla: UI component documentation

  97. Can you document the environment-specific configuration differences?

    ¿Puedes documentar las diferencias de configuración específicas por entorno?

    Cuándo usarla: Environment configuration docs

  98. The documentation should clearly state the supported authentication methods

    La documentación debería indicar claramente los métodos de autenticación soportados

    Cuándo usarla: Authentication documentation

  99. We need to keep the API mock server responses in sync with the documentation

    Necesitamos mantener las respuestas del servidor mock de la API sincronizadas con la documentación

    Cuándo usarla: Mock server documentation consistency

  100. The documentation build system checks for broken links automatically

    El sistema de build de la documentación verifica enlaces rotos automáticamente

    Cuándo usarla: Documentation CI/CD

  101. I documented the notification system with all trigger conditions

    Documenté el sistema de notificaciones con todas las condiciones de disparo

    Cuándo usarla: Notification system documentation

  102. Can you document the differences between the development and production builds?

    ¿Puedes documentar las diferencias entre los builds de desarrollo y producción?

    Cuándo usarla: Build configuration documentation

  103. Let's consolidate the scattered documentation into a single source of truth

    Consolidemos la documentación dispersa en una única fuente de verdad

    Cuándo usarla: Documentation centralization

  104. The permission matrix shows which roles can access each feature

    La matriz de permisos muestra qué roles pueden acceder a cada funcionalidad

    Cuándo usarla: Access control documentation

  105. We need a clear diagram of the state transitions in this workflow

    Necesitamos un diagrama claro de las transiciones de estado en este workflow

    Cuándo usarla: State machine documentation

  106. The documentation versioning follows semantic versioning alongside the codebase

    El versionamiento de la documentación sigue versionamiento semántico junto con el código

    Cuándo usarla: Version-aligned documentation

  107. The documentation should include performance optimization tips for developers

    La documentación debería incluir consejos de optimización de rendimiento para desarrolladores

    Cuándo usarla: Performance best practices docs

  108. Let's document the feature toggle naming conventions for consistency

    Documentemos las convenciones de nomenclatura de feature toggle para consistencia

    Cuándo usarla: Feature flag naming documentation

  109. The analytics event documentation maps each event to its business purpose

    La documentación de eventos de analytics mapea cada evento a su propósito de negocio

    Cuándo usarla: Analytics tracking documentation

  110. We should document the CI pipeline stages and what each one validates

    Deberíamos documentar las etapas del pipeline de CI y lo que cada una valida

    Cuándo usarla: CI/CD pipeline documentation

  111. Let's document the error codes with actionable resolution steps

    Documentemos los códigos de error con pasos de resolución accionables

    Cuándo usarla: Error resolution documentation

  112. The API documentation includes rate limit headers in the response examples

    La documentación de la API incluye headers de rate limit en los ejemplos de respuesta

    Cuándo usarla: Rate limit documentation details

  113. I documented the test data generation process and seed scripts

    Documenté el proceso de generación de datos de prueba y scripts de semilla

    Cuándo usarla: Test data documentation

  114. Let's document the edge cases that the validation layer handles

    Documentemos los casos extremos que la capa de validación maneja

    Cuándo usarla: Validation logic documentation

  115. The documentation should explain how the feature flag evaluation works

    La documentación debería explicar cómo funciona la evaluación de feature flag

    Cuándo usarla: Feature flag evaluation documentation

  116. Can you create a mapping between the old and new API endpoints?

    ¿Puedes crear un mapeo entre los endpoints antiguos y nuevos de la API?

    Cuándo usarla: API migration mapping documentation

  117. I added annotations to the architecture diagram explaining each layer

    Agregué anotaciones al diagrama de arquitectura explicando cada capa

    Cuándo usarla: Annotated architecture diagrams

  118. The SDK documentation includes getting started guides for each platform

    La documentación del SDK incluye guías de inicio rápido para cada plataforma

    Cuándo usarla: Multi-platform SDK docs

  119. The documentation should warn about known limitations of the current implementation

    La documentación debería advertir sobre limitaciones conocidas de la implementación actual

    Cuándo usarla: Limitation documentation

  120. I documented the health check endpoints and their expected responses

    Documenté los endpoints de health check y sus respuestas esperadas

    Cuándo usarla: Health check endpoint documentation

  121. The documentation should specify the maximum payload size for each endpoint

    La documentación debería especificar el tamaño máximo de payload para cada endpoint

    Cuándo usarla: API constraints documentation

  122. Let's add a section on how the feature was designed and why

    Agreguemos una sección sobre cómo se diseñó la funcionalidad y por qué

    Cuándo usarla: Design rationale documentation

  123. The documentation maps each microservice to its owning team

    La documentación mapea cada microservicio a su equipo responsable

    Cuándo usarla: Service ownership documentation

  124. The documentation should include a dedicated section for mobile-specific behavior

    La documentación debería incluir una sección dedicada para comportamiento específico de mobile

    Cuándo usarla: Platform-specific documentation

  125. The documentation explains how to set up local development with Docker

    La documentación explica cómo configurar desarrollo local con Docker

    Cuándo usarla: Docker setup documentation

Frases avanzadas (81)

  1. Breaking change: The response format for the /users endpoint has been updated to include pagination metadata.

    Cambio incompatible: El formato de respuesta del endpoint /users se ha actualizado para incluir metadatos de paginación.

    Cuándo usarla: Writing a breaking change entry in the changelog

  2. The module exports a singleton instance that should be initialized once during application startup.

    El módulo exporta una instancia singleton que debe inicializarse una vez durante el arranque de la aplicación.

    Cuándo usarla: Documenting initialization requirements for a module

  3. Rate limiting is enforced at 100 requests per minute per API key. Exceeding this limit returns a 429 status code.

    El límite de solicitudes es de 100 por minuto por clave de API. Exceder este límite devuelve un código de estado 429.

    Cuándo usarla: Documenting rate limiting policies in API documentation

  4. The middleware intercepts incoming requests and validates the session token before forwarding to the handler.

    El middleware intercepta las solicitudes entrantes y valida el token de sesión antes de reenviarlas al handler.

    Cuándo usarla: Explaining middleware behavior in architecture documentation

  5. For backward compatibility, the legacy endpoint will remain available until December 2026, after which it will be permanently removed.

    Para compatibilidad retroactiva, el endpoint heredado estará disponible hasta diciembre de 2026, después de lo cual será eliminado permanentemente.

    Cuándo usarla: Communicating a deprecation timeline in documentation

  6. The error handling strategy uses a centralized error boundary that catches unhandled exceptions and logs them to our monitoring service.

    La estrategia de manejo de errores utiliza un error boundary centralizado que captura excepciones no controladas y las registra en nuestro servicio de monitoreo.

    Cuándo usarla: Describing error handling architecture in technical docs

  7. Refer to the sequence diagram below for a visual overview of the request-response lifecycle.

    Consulta el diagrama de secuencia a continuación para una visión general visual del ciclo de vida de solicitud y respuesta.

    Cuándo usarla: Referencing a diagram in architecture documentation

  8. When contributing to this project, please follow the coding style guide and ensure all tests pass before submitting a pull request.

    Al contribuir a este proyecto, sigue la guía de estilo de código y asegúrate de que todas las pruebas pasen antes de enviar un pull request.

    Cuándo usarla: Writing contribution guidelines for an open-source project

  9. This release includes performance improvements, bug fixes, and a new caching layer that reduces average response time by 40%.

    Esta versión incluye mejoras de rendimiento, correcciones de errores y una nueva capa de caché que reduce el tiempo promedio de respuesta en un 40%.

    Cuándo usarla: Writing release notes summarizing changes

  10. Ensure that all public methods have proper documentation comments including parameter descriptions, return types, and possible exceptions.

    Asegúrate de que todos los métodos públicos tengan comentarios de documentación adecuados, incluyendo descripciones de parámetros, tipos de retorno y posibles excepciones.

    Cuándo usarla: Setting documentation standards in a contributing guide

  11. Let's create an Architecture Decision Record for the database migration strategy.

    Vamos a crear un Registro de Decisión Arquitectónica para la estrategia de migración de la base de datos.

    Cuándo usarla: When making an important architectural decision that should be recorded for future reference

  12. The runbook needs a section on how to handle database failover.

    El runbook necesita una sección sobre cómo manejar el failover de la base de datos.

    Cuándo usarla: When updating operational documentation for incident response

  13. I documented the design decision to use event sourcing instead of traditional CRUD.

    Documenté la decisión de diseño de usar event sourcing en lugar de CRUD tradicional.

    Cuándo usarla: When recording an important architectural choice for future reference

  14. The sequence diagram shows how the payment flow interacts with the notification service.

    El diagrama de secuencia muestra cómo el flujo de pago interactúa con el servicio de notificaciones.

    Cuándo usarla: Describing a technical diagram in architectural documentation

  15. The auto-generated docs from the OpenAPI spec are missing response examples.

    La documentación generada automáticamente de la especificación OpenAPI no tiene ejemplos de respuesta.

    Cuándo usarla: When reviewing automatically generated API documentation for completeness

  16. The ADR documents the tradeoffs between using a monolith and a microservices architecture.

    El ADR documenta las compensaciones entre usar una arquitectura monolítica y microservicios.

    Cuándo usarla: Explaining the content of a specific Architecture Decision Record

  17. The runbook includes step-by-step instructions for scaling the cluster during peak traffic.

    El runbook incluye instrucciones paso a paso para escalar el clúster durante picos de tráfico.

    Cuándo usarla: Describing operational documentation content for handling high-traffic events

  18. The entity-relationship diagram in our docs needs to reflect the new foreign key constraints.

    El diagrama entidad-relación en nuestra documentación necesita reflejar las nuevas restricciones de clave foránea.

    Cuándo usarla: When database schema documentation is out of sync with actual schema changes

  19. The onboarding doc explains our branching strategy, code review process, and deployment pipeline.

    El documento de incorporación explica nuestra estrategia de ramas, proceso de revisión de código y pipeline de despliegue.

    Cuándo usarla: Describing comprehensive onboarding documentation for new hires

  20. We maintain a decision log so future developers understand why certain tradeoffs were made.

    Mantenemos un registro de decisiones para que futuros desarrolladores entiendan por qué se hicieron ciertas compensaciones.

    Cuándo usarla: Explaining the purpose of keeping architectural decision records

  21. The database schema documentation should include column types, constraints, and index definitions.

    La documentación del esquema de la base de datos debe incluir tipos de columnas, restricciones y definiciones de índices.

    Cuándo usarla: Specifying what a complete database schema document should contain

  22. Our docs-as-code approach means documentation lives in the same repository as the source code.

    Nuestro enfoque de documentación como código significa que la documentación vive en el mismo repositorio que el código fuente.

    Cuándo usarla: Explaining the team's documentation philosophy to a new team member

  23. The postmortem report should be added to our incident response knowledge base.

    El informe de postmortem debe agregarse a nuestra base de conocimiento de respuesta a incidentes.

    Cuándo usarla: After resolving an incident and wanting to document lessons learned

  24. The contributing guide requires all code examples in documentation to be tested in continuous integration.

    La guía de contribución requiere que todos los ejemplos de código en la documentación sean probados en integración continua.

    Cuándo usarla: Establishing quality standards for documentation code snippets

  25. Self-documenting code reduces the need for comments, but it does not eliminate the need for high-level documentation.

    El código autodocumentado reduce la necesidad de comentarios, pero no elimina la necesidad de documentación de alto nivel.

    Cuándo usarla: Discussing the balance between code readability and written documentation

  26. The sequence diagram description clarifies the order of service calls during the checkout process.

    La descripción del diagrama de secuencia aclara el orden de las llamadas de servicio durante el proceso de compra.

    Cuándo usarla: Explaining what a sequence diagram communicates in system architecture documentation

  27. The migration guide covers backward-incompatible changes and provides code snippets for each fix.

    La guía de migración cubre cambios incompatibles y proporciona fragmentos de código para cada corrección.

    Cuándo usarla: Describing a comprehensive migration document for a major library update

  28. Document the retry behavior and timeout values for each third-party integration.

    Documenta el comportamiento de reintento y los valores de timeout para cada integración con terceros.

    Cuándo usarla: Requesting documentation of resilience configuration for external service calls

  29. We adopted Diátaxis as our documentation framework, separating tutorials from reference material.

    Adoptamos Diátaxis como nuestro marco de documentación, separando tutoriales del material de referencia.

    Cuándo usarla: Explaining the organizational framework used for structuring documentation

  30. The architecture documentation uses C4 model diagrams to show system context, containers, and components.

    La documentación de arquitectura usa diagramas del modelo C4 para mostrar el contexto del sistema, contenedores y componentes.

    Cuándo usarla: Describing the visualization approach used in architecture documentation

  31. The API versioning strategy and sunset policy are clearly outlined in the developer portal.

    La estrategia de versionado de la API y la política de descontinuación están claramente descritas en el portal de desarrolladores.

    Cuándo usarla: Pointing to documentation about API lifecycle management

  32. The data flow diagram in the architecture docs should show how events propagate through the message queue.

    El diagrama de flujo de datos en la documentación de arquitectura debe mostrar cómo los eventos se propagan a través de la cola de mensajes.

    Cuándo usarla: Requesting specific technical detail in architecture documentation

  33. The OpenAPI specification file serves as both the contract and the documentation for our REST endpoints.

    El archivo de especificación OpenAPI sirve tanto como contrato como documentación para nuestros endpoints REST.

    Cuándo usarla: Explaining how the API specification doubles as documentation

  34. We should document the expected behavior when the circuit breaker opens for downstream services.

    Deberíamos documentar el comportamiento esperado cuando el circuit breaker se abre para los servicios downstream.

    Cuándo usarla: Requesting documentation about resilience patterns in the system architecture

  35. The contributing guidelines now require a documentation impact assessment for each feature pull request.

    Las pautas de contribución ahora requieren una evaluación de impacto en la documentación para cada pull request de funcionalidad.

    Cuándo usarla: Introducing a new process to ensure documentation stays current with feature development

  36. The webhook documentation must specify the payload format, retry policy, and expected response codes.

    La documentación de webhooks debe especificar el formato del payload, la política de reintentos y los códigos de respuesta esperados.

    Cuándo usarla: Defining completeness requirements for webhook integration documentation

  37. The ADR should capture the context, the decision itself, and the consequences both positive and negative.

    El ADR debe capturar el contexto, la decisión en sí y las consecuencias tanto positivas como negativas.

    Cuándo usarla: Explaining the proper structure of an Architecture Decision Record

  38. We embedded runnable code examples in our documentation using interactive code playgrounds.

    Incorporamos ejemplos de código ejecutables en nuestra documentación usando entornos de código interactivos.

    Cuándo usarla: Describing an advanced documentation feature for developer experience

  39. Before shipping the breaking change, we need to send a deprecation email and update the migration docs.

    Antes de lanzar el cambio incompatible, necesitamos enviar un correo de deprecación y actualizar la documentación de migración.

    Cuándo usarla: Planning communication around a breaking change in a public API

  40. Documentation should be treated as a first-class deliverable, not an afterthought tacked on at the end of a sprint.

    La documentación debe tratarse como un entregable de primera clase, no como algo añadido al final de un sprint.

    Cuándo usarla: Advocating for prioritizing documentation work during sprint planning

  41. The architecture decision record explains why we chose this approach

    El registro de decisión de arquitectura explica por qué elegimos este enfoque

    Cuándo usarla: Referencing ADRs

  42. The migration guide should cover breaking changes step by step

    La guía de migración debería cubrir los cambios que rompen paso a paso

    Cuándo usarla: Writing upgrade documentation

  43. The runbook describes how to handle production incidents

    El runbook describe cómo manejar incidentes en producción

    Cuándo usarla: Operations documentation

  44. We need to document the authentication flow with examples

    Necesitamos documentar el flujo de autenticación con ejemplos

    Cuándo usarla: Security documentation

  45. The deployment guide covers all the steps from staging to production

    La guía de despliegue cubre todos los pasos desde staging hasta producción

    Cuándo usarla: Deployment process documentation

  46. We should document the retry policy for failed API calls

    Deberíamos documentar la política de reintento para llamadas de API fallidas

    Cuándo usarla: Documenting resilience patterns

  47. The documentation should explain the rationale behind each design decision

    La documentación debería explicar la justificación detrás de cada decisión de diseño

    Cuándo usarla: Documenting the why, not just the what

  48. The API versioning strategy is explained in the developer guide

    La estrategia de versionamiento de la API se explica en la guía del desarrollador

    Cuándo usarla: Referencing versioning docs

  49. The security documentation should cover threat models and mitigations

    La documentación de seguridad debería cubrir modelos de amenazas y mitigaciones

    Cuándo usarla: Security-focused documentation

  50. The performance benchmarks should be documented for each release

    Los benchmarks de rendimiento deben documentarse para cada lanzamiento

    Cuándo usarla: Tracking performance metrics in docs

  51. I documented the caching strategy and invalidation rules

    Documenté la estrategia de caché y las reglas de invalidación

    Cuándo usarla: Cache architecture documentation

  52. The monitoring and alerting setup is documented in the ops guide

    La configuración de monitoreo y alertas está documentada en la guía de operaciones

    Cuándo usarla: Operations documentation

  53. The SLA documentation specifies uptime and response time guarantees

    La documentación de SLA especifica garantías de uptime y tiempo de respuesta

    Cuándo usarla: Service level agreement documentation

  54. We should document the backup and recovery procedures

    Deberíamos documentar los procedimientos de respaldo y recuperación

    Cuándo usarla: Disaster recovery documentation

  55. The error handling guide documents how errors propagate through layers

    La guía de manejo de errores documenta cómo los errores se propagan por las capas

    Cuándo usarla: Error handling architecture documentation

  56. The network layer documentation explains the request pipeline

    La documentación de la capa de red explica el pipeline de solicitudes

    Cuándo usarla: Documenting network architecture

  57. The infrastructure as code templates are documented in the DevOps guide

    Las plantillas de infraestructura como código están documentadas en la guía de DevOps

    Cuándo usarla: Infrastructure documentation

  58. The compliance documentation tracks all regulatory requirements we meet

    La documentación de cumplimiento rastrea todos los requisitos regulatorios que cumplimos

    Cuándo usarla: Regulatory compliance docs

  59. The load testing results should be attached to the documentation

    Los resultados de pruebas de carga deben adjuntarse a la documentación

    Cuándo usarla: Performance test documentation

  60. Can you document the data retention policy for user information?

    ¿Puedes documentar la política de retención de datos para información del usuario?

    Cuándo usarla: Privacy policy documentation

  61. I created a decision matrix for the technology selection

    Creé una matriz de decisión para la selección de tecnología

    Cuándo usarla: Technology evaluation documentation

  62. We should include network topology diagrams in the infrastructure docs

    Deberíamos incluir diagramas de topología de red en los docs de infraestructura

    Cuándo usarla: Network architecture documentation

  63. The incident postmortem should be documented with root cause analysis

    El postmortem del incidente debería documentarse con análisis de causa raíz

    Cuándo usarla: Post-incident documentation

  64. The event bus documentation should list all published and consumed events

    La documentación del event bus debería listar todos los eventos publicados y consumidos

    Cuándo usarla: Event-driven architecture docs

  65. The rollback procedure is documented in case we need to revert

    El procedimiento de rollback está documentado en caso de que necesitemos revertir

    Cuándo usarla: Rollback documentation

  66. Let's add a diagram showing the microservices communication patterns

    Agreguemos un diagrama mostrando los patrones de comunicación de los microservicios

    Cuándo usarla: Microservices architecture docs

  67. The capacity planning document estimates resource needs for scaling

    El documento de planificación de capacidad estima las necesidades de recursos para escalar

    Cuándo usarla: Scaling documentation

  68. The schema migration documentation should explain how to rollback each step

    La documentación de migración de schema debería explicar cómo revertir cada paso

    Cuándo usarla: Database migration docs

  69. The documentation should include a section on error recovery procedures

    La documentación debería incluir una sección sobre procedimientos de recuperación de errores

    Cuándo usarla: Error recovery documentation

  70. I added a section on how to handle sensitive data according to our policy

    Agregué una sección sobre cómo manejar datos sensibles de acuerdo con nuestra política

    Cuándo usarla: Data handling documentation

  71. The observability documentation covers logging, metrics, and tracing

    La documentación de observabilidad cubre logging, métricas y tracing

    Cuándo usarla: Observability stack documentation

  72. I documented all the third-party service integrations and their SLAs

    Documenté todas las integraciones con servicios de terceros y sus SLAs

    Cuándo usarla: Third-party service documentation

  73. I created a documentation health dashboard to track coverage and freshness

    Creé un dashboard de salud de la documentación para rastrear cobertura y frescura

    Cuándo usarla: Documentation metrics

  74. We documented the queue processing logic with throughput expectations

    Documentamos la lógica de procesamiento de colas con expectativas de throughput

    Cuándo usarla: Queue system documentation

  75. We should document the database indexing strategy for query optimization

    Deberíamos documentar la estrategia de indexación de la base de datos para optimización de consultas

    Cuándo usarla: Database optimization documentation

  76. The documentation clearly explains how to extend the plugin system

    La documentación explica claramente cómo extender el sistema de plugins

    Cuándo usarla: Plugin architecture documentation

  77. We should document the event sourcing patterns used in the system

    Deberíamos documentar los patrones de event sourcing usados en el sistema

    Cuándo usarla: Event sourcing documentation

  78. Can you document the message queue consumer retry behavior?

    ¿Puedes documentar el comportamiento de reintento del consumidor de la cola de mensajes?

    Cuándo usarla: Message queue documentation

  79. The documentation should explain the caching invalidation strategy we use

    La documentación debería explicar la estrategia de invalidación de caché que usamos

    Cuándo usarla: Cache invalidation documentation

  80. We need to document the graceful shutdown procedure for the service

    Necesitamos documentar el procedimiento de apagado gracioso del servicio

    Cuándo usarla: Service lifecycle documentation

  81. We documented the input sanitization rules to prevent injection attacks

    Documentamos las reglas de sanitización de entrada para prevenir ataques de inyección

    Cuándo usarla: Security best practices documentation

Otras situaciones del día a día de un dev

← Inglés para programadores

Llévalo en el celular

En la app Devlingo recibes 10 frases nuevas al día, cada una con contexto real, pronunciación y ejemplos, y el widget muestra la frase del día en la pantalla de inicio del iPhone.

Preguntas frecuentes

Lo que más se pregunta sobre el tema, respondido con la fuente.

¿Cómo escribo un README en inglés?
Secciones fijas: Overview, Installation, Usage, Configuration y Contributing, con una frase inicial que diga qué hace el proyecto.
¿Qué tiempo verbal uso en la documentación en inglés?
Presente para describir (returns, accepts) e imperativo para instrucciones (install, run).
DevlingoAprende frases y fluidez
Usar sin instalarDescargar