Inglês para devs · Documentação

Documentação em inglês: frases para README e docs

Resposta rápida

Escrever documentação em inglês fica mais fácil com frases-modelo: como instalar, como usar, o que cada parâmetro faz, o que mudou na versão. Selecionamos 300 frases do app Devlingo para README, docs de API, comentários e changelog, com tradução, contexto e áudio.

Atualizado em

Documentação em inglês usa frases curtas no imperativo para passos (Run the following command) e no presente para descrever (This function returns…). Evite simply e just: o que é simples para você pode não ser para quem lê.

Frases fáceis (94)

  1. Please refer to the README for setup instructions.

    Consulte o README para instruções de configuração.

    Quando usar: Directing someone to the project README file

  2. This function returns a list of active users.

    Esta função retorna uma lista de usuários ativos.

    Quando usar: Writing an inline comment describing a function's return value

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

    Veja o changelog para uma lista de atualizações recentes.

    Quando usar: Pointing someone to the changelog file

  4. Make sure to update the docs before merging.

    Certifique-se de atualizar a documentação antes de fazer o merge.

    Quando usar: Reminding a teammate to keep documentation in sync with code changes

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

    Este endpoint aceita um corpo JSON com os seguintes campos.

    Quando usar: Documenting an API endpoint's request format

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

    Adicione uma breve descrição das suas alterações no pull request.

    Quando usar: Asking someone to document their PR properly

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

    Vou adicionar comentários no código para explicar a lógica de negócio.

    Quando usar: Committing to document complex business rules in the code

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

    A API retorna o código de status 404 se o recurso não for encontrado.

    Quando usar: 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 rodar o projeto localmente, certifique-se de ter o Node.js 18 ou superior instalado.

    Quando usar: Writing prerequisites in an onboarding or setup guide

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

    O arquivo de configuração suporta hot reloading, então as alterações entram em vigor sem reiniciar a aplicação.

    Quando usar: Documenting hot reload capabilities in configuration docs

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

    Precisamos atualizar o README com as novas instruções de configuração.

    Quando usar: 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, adicione um comentário no código explicando por que escolhemos essa abordagem.

    Quando usar: During code review when a non-obvious implementation decision lacks explanation

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

    Eu escrevi um guia de integração para que novos desenvolvedores possam começar rapidamente.

    Quando usar: 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.

    Não esqueça de atualizar o changelog antes de criarmos a tag da release.

    Quando usar: 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.

    Vamos adicionar diagramas de arquitetura na documentação para que novos desenvolvedores entendam o sistema rapidamente.

    Quando usar: Proposing visual documentation to improve system understanding

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

    As instruções de configuração do ambiente precisam ser testadas em uma máquina limpa.

    Quando usar: When verifying that setup documentation works for someone starting from scratch

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

    Nosso wiki interno ficou desatualizado e precisa de uma revisão abrangente.

    Quando usar: When recognizing that internal documentation has fallen behind the actual system state

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

    Todo pull request que altere a API deve incluir atualizações na documentação.

    Quando usar: 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.

    Comentários devem explicar por que o código faz algo, não o que ele faz.

    Quando usar: Giving feedback during code review about the quality of code comments

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

    Adicionei documentação inline para todos os métodos públicos do SDK.

    Quando usar: 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, mantenha o README conciso e faça links para a documentação detalhada de configuração avançada.

    Quando usar: Advising on README structure to avoid overwhelming new users

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

    Evite usar comentários TODO como substituto para um rastreamento adequado de tarefas.

    Quando usar: 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.

    Adicione um índice ao README, pois ele cresceu para mais de cinquenta seções.

    Quando usar: When a README has become too long to navigate without an index

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

    Documentação desatualizada é pior do que nenhuma documentação porque engana os desenvolvedores.

    Quando usar: Arguing for the importance of keeping documentation up to date

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

    Escreva a tabela de códigos de erro para que os engenheiros de suporte possam identificar problemas rapidamente.

    Quando usar: Creating reference documentation that maps error codes to their meanings

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

    O guia prático deve incluir armadilhas comuns e suas soluções.

    Quando usar: Improving a how-to guide with troubleshooting information

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

    Escrevi um tutorial passo a passo sobre como integrar nosso sistema de webhooks.

    Quando usar: Creating educational content for a developer platform

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

    Adicione uma seção de pré-requisitos ao guia de configuração listando as versões de software necessárias.

    Quando usar: Improving setup documentation with dependency information

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

    A página do wiki sobre nossa estratégia de cache não é atualizada desde o ano passado.

    Quando usar: Identifying stale internal documentation that needs attention

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

    Toda função pública deve ter um comentário de documentação descrevendo seus parâmetros e valor de retorno.

    Quando usar: Enforcing documentation standards in a code review checklist

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

    Vamos adicionar um glossário à documentação definindo todos os termos específicos do domínio que usamos.

    Quando usar: 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, atualize a documentação de variáveis de ambiente para incluir a nova feature flag.

    Quando usar: 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.

    Uma boa documentação é um investimento que se paga ao reduzir chamados de suporte e tempo de integração.

    Quando usar: Advocating for documentation investment during a team planning meeting

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

    Adicionamos uma página de perguntas frequentes com base nas solicitações de suporte mais comuns.

    Quando usar: 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 documentação porque renderiza bem no GitHub e é fácil de comparar.

    Quando usar: Explaining the rationale behind the documentation format choice

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

    Novos membros da equipe devem completar a caça ao tesouro de documentação durante a primeira semana.

    Quando usar: 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.

    Movi as instruções de configuração legadas para uma página de arquivo para que não confundam novos usuários.

    Quando usar: Cleaning up documentation by separating outdated content from current content

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

    Remova as capturas de tela desatualizadas da documentação e substitua-as pelas atuais.

    Quando usar: 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.

    Percebi que o README ainda referencia o nome antigo do pacote que renomeamos três meses atrás.

    Quando usar: Finding outdated information in documentation during a routine check

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

    Mantemos guias de início separados para desenvolvedores mobile e desenvolvedores backend.

    Quando usar: Describing audience-specific documentation for different developer personas

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

    O badge do README mostra o status do build, cobertura de código e a versão do último release.

    Quando usar: Describing visual status indicators commonly placed in project README files

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

    A equipe de redação técnica revisa toda a documentação voltada ao público antes de ser publicada.

    Quando usar: Describing the quality assurance process for documentation publishing

  43. The README should include setup instructions for new developers

    O README deveria incluir instruções de configuração para novos desenvolvedores

    Quando usar: Onboarding documentation

  44. The changelog needs to be updated before the release

    O changelog precisa ser atualizado antes do lançamento

    Quando usar: Release documentation process

  45. This function is missing its documentation comment

    Essa função está sem o comentário de documentação

    Quando usar: Adding inline code documentation

  46. The glossary helps new team members understand our terminology

    O glossário ajuda novos membros da equipe a entender nossa terminologia

    Quando usar: Creating a project glossary

  47. Can you review the inline comments for accuracy?

    Pode revisar os comentários inline quanto à precisão?

    Quando usar: Reviewing code comments

  48. The user guide needs screenshots of the latest interface

    O guia do usuário precisa de capturas de tela da interface mais recente

    Quando usar: Updating visual documentation

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

    Adicionei uma seção de pré-requisitos no topo do guia

    Quando usar: Setting up documentation structure

  50. The contributing guide outlines how to submit pull requests

    O guia de contribuição descreve como enviar pull requests

    Quando usar: Open source contribution documentation

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

    Vamos criar uma seção de FAQ baseada nas perguntas mais frequentes

    Quando usar: Building FAQ documentation

  52. The style guide ensures consistency across the documentation

    O guia de estilo garante consistência em toda a documentação

    Quando usar: Documentation standards

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

    As notas de lançamento devem destacar novas funcionalidades e correções de bugs

    Quando usar: Writing release documentation

  54. The parameter description is missing from the function header

    A descrição do parâmetro está faltando no cabeçalho da função

    Quando usar: Completing function documentation

  55. The onboarding documentation should include common pitfalls

    A documentação de onboarding deveria incluir armadilhas comuns

    Quando usar: Helping new team members avoid mistakes

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

    Os badges do README mostram o status do build e cobertura de testes

    Quando usar: Adding status badges to documentation

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

    Vamos documentar as variáveis de ambiente necessárias para rodar o app

    Quando usar: Configuration documentation

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

    Vamos adicionar um sumário para facilitar a navegação no documento

    Quando usar: Improving documentation navigation

  59. Please update the installation instructions for the latest version

    Por favor atualize as instruções de instalação para a versão mais recente

    Quando usar: Keeping setup docs current

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

    Devemos adicionar referências cruzadas entre páginas de documentação relacionadas

    Quando usar: Linking documentation together

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

    O checklist de code review deveria fazer parte da documentação

    Quando usar: Standardizing review processes

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

    Vamos manter a linguagem da documentação simples e evitar jargão

    Quando usar: Writing accessible documentation

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

    Vamos adicionar uma seção de problemas conhecidos nas notas de lançamento

    Quando usar: Documenting known limitations

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

    Pode revisar a documentação quanto à gramática e ortografia?

    Quando usar: Documentation quality review

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

    Adicionei uma seção sobre como rodar o projeto localmente

    Quando usar: Local development documentation

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

    Pode adicionar uma tabela comparativa entre as funcionalidades free e premium?

    Quando usar: Feature comparison documentation

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

    Vamos criar um cheat sheet com os comandos mais comuns

    Quando usar: Quick reference documentation

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

    O documento de padrões de código deveria ser a primeira coisa que novos desenvolvedores leem

    Quando usar: Establishing coding conventions

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

    Vamos adicionar uma seção sobre o fluxo de desenvolvimento e estratégia de branches

    Quando usar: Git workflow documentation

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

    Vamos criar um vídeo tutorial para o processo de configuração complexo

    Quando usar: Creating video documentation

  71. The documentation template standardizes how we write new guides

    O template de documentação padroniza como escrevemos novos guias

    Quando usar: Documentation templates

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

    Pode adicionar números de sequência nos passos do workflow da API?

    Quando usar: Ordering documentation steps

  73. The documentation should specify which platforms are supported

    A documentação deveria especificar quais plataformas são suportadas

    Quando usar: Platform compatibility docs

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

    Pode escrever um breve resumo no topo de cada página de documentação?

    Quando usar: Documentation readability improvement

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

    A revisão da documentação faz parte da nossa definição de pronto

    Quando usar: Documentation as quality gate

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

    Adicionei um fluxograma de resolução de problemas para ajudar a diagnosticar problemas comuns

    Quando usar: Visual troubleshooting guides

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

    A documentação deveria explicar a diferença entre cada nível de log

    Quando usar: Logging documentation

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

    Vamos criar um guia visual para toda a jornada do usuário

    Quando usar: User experience documentation

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

    A documentação deveria linkar para os tickets do Jira relacionados para contexto

    Quando usar: Connecting docs to project management

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

    Pode adicionar uma seção explicando as convenções usadas em toda a documentação?

    Quando usar: Documentation meta-information

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

    A documentação da API distingue claramente entre campos obrigatórios e opcionais

    Quando usar: API field documentation

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

    A documentação da API deveria incluir exemplos com curl para teste rápido

    Quando usar: Adding practical API examples

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

    O portal de documentação deveria ter um mecanismo de feedback para os leitores

    Quando usar: Documentation feedback loop

  84. The documentation should include a system requirements section

    A documentação deveria incluir uma seção de requisitos do sistema

    Quando usar: System prerequisites documentation

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

    Devemos adicionar uma árvore de decisão para escolher o componente certo

    Quando usar: Component selection guide

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

    A documentação deveria incluir uma seção sobre como reportar problemas de segurança

    Quando usar: Security reporting documentation

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

    O portal de documentação tem um toggle de modo escuro para melhor legibilidade

    Quando usar: Documentation UX improvement

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

    Vamos adicionar uma lista de todas as variáveis de ambiente com suas descrições

    Quando usar: Environment variable reference

  89. The documentation uses consistent terminology throughout all sections

    A documentação usa terminologia consistente em todas as seções

    Quando usar: Documentation consistency

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

    Vamos criar um glossário de abreviações usadas no código

    Quando usar: Abbreviation reference documentation

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

    A documentação inclui uma matriz de compatibilidade para suporte de navegador e SO

    Quando usar: Compatibility documentation

  92. The API documentation should group endpoints by resource type

    A documentação da API deveria agrupar endpoints por tipo de recurso

    Quando usar: API documentation organization

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

    Criei um cartão de referência resumindo os valores de configuração mais importantes

    Quando usar: Quick reference documentation

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

    Pode adicionar timestamps nas páginas de documentação para mostrar quando foram atualizadas?

    Quando usar: Documentation freshness tracking

Frases intermediárias (125)

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

    Devemos documentar as variáveis de ambiente necessárias para rodar o projeto.

    Quando usar: Suggesting adding configuration documentation

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

    Cada parâmetro está descrito na tabela abaixo com seu tipo e valor padrão.

    Quando usar: Introducing a parameters table in API documentation

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

    Esta seção cobre os passos de migração da versão 2 para a versão 3.

    Quando usar: 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á removido na próxima versão principal. Use fetchData() em vez disso.

    Quando usar: Writing a deprecation notice in code documentation

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

    A arquitetura segue uma separação clara entre a camada de dados, camada de domínio e camada de apresentação.

    Quando usar: Describing the app architecture in a design document

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

    Por favor, inclua um exemplo de código mostrando como inicializar o SDK.

    Quando usar: Requesting a usage example in documentation

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

    Problema conhecido: A funcionalidade de busca pode retornar resultados duplicados sob carga pesada.

    Quando usar: Documenting a known bug in release notes or troubleshooting guide

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

    A autenticação é feita via tokens JWT passados no cabeçalho Authorization.

    Quando usar: Explaining the authentication mechanism in API docs

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

    A seção de solução de problemas aborda os problemas mais comumente relatados e suas soluções.

    Quando usar: 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 a conexão com o banco de dados, defina a variável de ambiente DATABASE_URL no seu arquivo .env.

    Quando usar: Explaining database configuration in setup documentation

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

    A documentação da API está sem exemplos para os endpoints de autenticação.

    Quando usar: When reviewing API documentation and finding incomplete sections

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

    Essa função é complexa o suficiente para justificar um docstring detalhado.

    Quando usar: During code review when a complex function lacks proper documentation

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

    Devemos documentar as mudanças no esquema do banco de dados no guia de migração.

    Quando usar: 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?

    Você pode escrever um guia de solução de problemas para os erros de deploy mais comuns?

    Quando usar: Asking a team member to create operational documentation for known issues

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

    A seção de perguntas frequentes deve cobrir questões sobre limitação de taxa e paginação.

    Quando usar: 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.

    O guia de migração deve incluir instruções passo a passo e um plano de rollback caso algo dê errado.

    Quando usar: 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.

    Precisamos documentar os limites de taxa da API para que os consumidores saibam quantas requisições podem fazer por minuto.

    Quando usar: Adding rate limit information to API documentation

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

    Nossas diretrizes de contribuição explicam como configurar o ambiente de desenvolvimento e enviar pull requests.

    Quando usar: 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.

    Precisamos adicionar um aviso de depreciação com a abordagem alternativa recomendada.

    Quando usar: 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.

    O tutorial orienta na construção de uma API REST do zero com autenticação.

    Quando usar: 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 versão deve destacar as mudanças que quebram compatibilidade no topo do documento.

    Quando usar: Setting standards for how release notes should be structured

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

    Usamos anotações JSDoc para gerar a documentação da nossa biblioteca TypeScript.

    Quando usar: 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.

    Criei um guia de início rápido que leva os desenvolvedores à sua primeira chamada de API em cinco minutos.

    Quando usar: Describing a new developer experience improvement in API documentation

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

    O caminho de atualização do sistema legado está documentado no guia de migração.

    Quando usar: Directing team members to existing documentation about a system migration

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

    Geramos nossa documentação de referência da API diretamente das anotações no código-fonte.

    Quando usar: Explaining the documentation generation pipeline to a new team member

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

    O Swagger UI permite que desenvolvedores testem endpoints da API interativamente a partir da documentação.

    Quando usar: Explaining the benefits of interactive API documentation

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

    O arquivo de configuração suporta doze parâmetros, e cada um está documentado com intervalos válidos.

    Quando usar: Describing thorough configuration documentation with validation details

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

    Configurei um linter de documentação para detectar links quebrados e problemas de formatação automaticamente.

    Quando usar: Implementing automated quality checks for documentation

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

    Precisamos versionar nossa documentação de API separadamente do código.

    Quando usar: 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 microsserviço tem seu próprio README explicando seu propósito, dependências e como executá-lo localmente.

    Quando usar: Describing documentation standards in a microservices architecture

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

    As notas de versão seguem o formato keep-a-changelog com seções de adicionado, alterado, corrigido e removido.

    Quando usar: Describing the structure used for organizing release notes

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

    Inclua exemplos curl junto com as amostras de código do SDK na referência da API.

    Quando usar: 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.

    A entrada do changelog deve ser escrita da perspectiva do usuário, não do desenvolvedor.

    Quando usar: 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.

    O guia de solução de problemas precisa de uma árvore de decisão para ajudar a identificar a causa raiz.

    Quando usar: Improving a troubleshooting document with a structured diagnostic approach

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

    A base de conhecimento interna deve ter uma seção dedicada a procedimentos de resposta a incidentes.

    Quando usar: Organizing operational documentation within a company knowledge management system

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

    Rastreamos a cobertura de documentação da mesma forma que rastreamos a cobertura de código.

    Quando usar: 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.

    Os headers de limite de taxa da API devem ser explicados na seção de autenticação da nossa documentação.

    Quando usar: 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.

    O runbook deve especificar os comandos exatos a serem executados, não apenas descrever o procedimento geral.

    Quando usar: Reviewing a runbook and requesting more actionable content

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

    A documentação do banco de dados deve incluir uma seção sobre procedimentos de backup e recuperação.

    Quando usar: 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.

    Devemos escrever um guia de estilo de código que documente as convenções da equipe para nomenclatura e formatação.

    Quando usar: Proposing documentation of coding standards for team consistency

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

    Certifique-se de fazer referências cruzadas entre páginas de documentação relacionadas para que os leitores encontrem contexto adicional.

    Quando usar: Improving documentation navigation through internal linking

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

    A referência de configuração lista cada opção com seu tipo, valor padrão e uma breve descrição.

    Quando usar: Describing a well-structured configuration documentation page

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

    Automatizamos o deploy do nosso site de documentação usando um pipeline de integração contínua.

    Quando usar: Describing the documentation deployment infrastructure

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

    O checklist de onboarding inclui ler a visão geral da arquitetura, configurar o ambiente local e executar a suíte de testes.

    Quando usar: Outlining the key steps in a developer onboarding process

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

    Evite escrever documentação que duplica o que o código já comunica através de boa nomenclatura.

    Quando usar: 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.

    A página de solução de problemas deve ser organizada por sintoma para que os usuários encontrem respostas com base no que observam.

    Quando usar: Structuring troubleshooting documentation for better usability

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

    O cronograma de depreciação dá aos usuários doze meses para migrar antes que a API antiga seja desativada.

    Quando usar: 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.

    O wiki deve ser pesquisável e cada página deve ter um responsável por mantê-la atualizada.

    Quando usar: Establishing governance practices for internal documentation

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

    Pode adicionar um exemplo de código nessa referência da API?

    Quando usar: Enhancing API documentation

  50. We should document the error codes and their meanings

    Devemos documentar os códigos de erro e seus significados

    Quando usar: Creating error reference documentation

  51. Please add the return type description to the docstring

    Por favor adicione a descrição do tipo de retorno na docstring

    Quando usar: Completing function documentation

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

    Escrevi uma seção de solução de problemas para os problemas mais comuns

    Quando usar: Creating self-service support docs

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

    A documentação do endpoint da API está desatualizada e precisa de uma atualização

    Quando usar: Updating stale documentation

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

    Vamos adicionar um diagrama de sequência para explicar esse fluxo de trabalho

    Quando usar: Using visual diagrams in documentation

  55. The configuration options should be documented with default values

    As opções de configuração devem ser documentadas com valores padrão

    Quando usar: Documenting configurable settings

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

    Precisamos adicionar avisos de depreciação nos métodos antigos da API

    Quando usar: Marking deprecated functionality

  57. The documentation should be versioned alongside the code

    A documentação deveria ser versionada junto com o código

    Quando usar: Documentation versioning strategy

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

    Devemos adicionar anotações de tipo para melhorar a clareza da documentação

    Quando usar: Using type information for documentation

  59. This technical specification needs peer review before publishing

    Essa especificação técnica precisa de revisão por pares antes de publicar

    Quando usar: Documentation review process

  60. I documented the data model relationships in a diagram

    Documentei os relacionamentos do modelo de dados em um diagrama

    Quando usar: Creating data model documentation

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

    Pode escrever um guia de início rápido para o SDK?

    Quando usar: Creating getting started documentation

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

    Vamos usar Swagger para gerar a documentação da API automaticamente

    Quando usar: Automated documentation tools

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

    Notei que os exemplos de código nos docs não compilam mais

    Quando usar: Maintaining documentation accuracy

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

    Devemos adicionar um dicionário de dados para as tabelas do banco

    Quando usar: Database documentation

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

    Os limites de taxa da API devem ser claramente documentados para os consumidores

    Quando usar: Documenting API constraints

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

    Criei um log de decisões para rastrear nossas escolhas arquiteturais

    Quando usar: Recording project decisions

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

    O diagrama de classes precisa ser atualizado após a refatoração

    Quando usar: Keeping diagrams in sync with code

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

    Pode adicionar exemplos de uso para cada método público?

    Quando usar: Creating comprehensive method documentation

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

    Escrevi um tutorial que guia pela construção de uma funcionalidade do zero

    Quando usar: Creating tutorial documentation

  70. The testing strategy document outlines our quality assurance approach

    O documento de estratégia de testes descreve nossa abordagem de garantia de qualidade

    Quando usar: QA documentation

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

    Adicionei exemplos mostrando os formatos de resposta de sucesso e erro

    Quando usar: Documenting API response formats

  72. The webhook documentation needs to include payload examples

    A documentação de webhooks precisa incluir exemplos de payload

    Quando usar: Documenting webhook integrations

  73. We documented the design system with component specifications

    Documentamos o design system com especificações de componentes

    Quando usar: Design system documentation

  74. The dependency list should include version requirements and licenses

    A lista de dependências deveria incluir requisitos de versão e licenças

    Quando usar: Documenting project dependencies

  75. The documentation should include accessibility guidelines for the UI

    A documentação deveria incluir diretrizes de acessibilidade para a UI

    Quando usar: Accessibility documentation

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

    Precisamos atualizar a visão geral da arquitetura após adicionar o novo serviço

    Quando usar: Maintaining system architecture docs

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

    O changelog da API rastreia todas as mudanças que quebram e que não quebram

    Quando usar: API change management documentation

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

    O guia de integração explica como conectar com serviços de terceiros

    Quando usar: Third-party integration documentation

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

    Vamos documentar as feature flags e como elas afetam o comportamento

    Quando usar: Feature flag documentation

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

    A documentação de fluxo de dados mostra como a informação se move pelo sistema

    Quando usar: System data flow documentation

  81. The API documentation should include request and response headers

    A documentação da API deveria incluir headers de requisição e resposta

    Quando usar: Complete API documentation

  82. I documented the localization workflow for adding new languages

    Documentei o fluxo de trabalho de localização para adicionar novos idiomas

    Quando usar: Internationalization process documentation

  83. We need inline documentation for the complex business logic

    Precisamos de documentação inline para a lógica de negócio complexa

    Quando usar: Documenting domain-specific code

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

    Pode atualizar o diagrama de entidade-relacionamento com as novas tabelas?

    Quando usar: Maintaining database diagrams

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

    A busca na documentação precisa ser indexada para melhor descoberta

    Quando usar: Improving documentation search

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

    Devemos manter um registro de toda a dívida técnica que identificamos

    Quando usar: Technical debt tracking docs

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

    A documentação do sandbox da API ajuda desenvolvedores a testar sem afetar produção

    Quando usar: Sandbox environment docs

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

    A documentação gerada automaticamente precisa de revisão manual para precisão

    Quando usar: Validating auto-generated docs

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

    A documentação de paginação da API deveria mostrar exemplos baseados em cursor e offset

    Quando usar: Pagination documentation

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

    Vamos adicionar exemplos de código interativos que os leitores podem executar diretamente

    Quando usar: Interactive documentation

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

    Documentei os design tokens usados na biblioteca de componentes

    Quando usar: Design token documentation

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

    Precisamos documentar as regras de validação de dados para cada campo de entrada

    Quando usar: Input validation documentation

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

    A documentação precisa ser acessível para stakeholders não técnicos

    Quando usar: Writing for mixed audiences

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

    Atualizei a documentação da API para refletir o novo formato de resposta

    Quando usar: Keeping API docs in sync

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

    Devemos documentar como os cron jobs são agendados e monitorados

    Quando usar: Scheduled jobs documentation

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

    O storybook de componentes serve como documentação viva para a UI

    Quando usar: UI component documentation

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

    Pode documentar as diferenças de configuração específicas por ambiente?

    Quando usar: Environment configuration docs

  98. The documentation should clearly state the supported authentication methods

    A documentação deveria declarar claramente os métodos de autenticação suportados

    Quando usar: Authentication documentation

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

    Precisamos manter as respostas do servidor mock da API sincronizadas com a documentação

    Quando usar: Mock server documentation consistency

  100. The documentation build system checks for broken links automatically

    O sistema de build da documentação verifica links quebrados automaticamente

    Quando usar: Documentation CI/CD

  101. I documented the notification system with all trigger conditions

    Documentei o sistema de notificações com todas as condições de disparo

    Quando usar: Notification system documentation

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

    Pode documentar as diferenças entre os builds de desenvolvimento e produção?

    Quando usar: Build configuration documentation

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

    Vamos consolidar a documentação espalhada em uma única fonte de verdade

    Quando usar: Documentation centralization

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

    A matriz de permissões mostra quais papéis podem acessar cada funcionalidade

    Quando usar: Access control documentation

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

    Precisamos de um diagrama claro das transições de estado nesse workflow

    Quando usar: State machine documentation

  106. The documentation versioning follows semantic versioning alongside the codebase

    O versionamento da documentação segue versionamento semântico junto com o código

    Quando usar: Version-aligned documentation

  107. The documentation should include performance optimization tips for developers

    A documentação deveria incluir dicas de otimização de performance para desenvolvedores

    Quando usar: Performance best practices docs

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

    Vamos documentar as convenções de nomenclatura de feature toggle para consistência

    Quando usar: Feature flag naming documentation

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

    A documentação de eventos de analytics mapeia cada evento ao seu propósito de negócio

    Quando usar: Analytics tracking documentation

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

    Devemos documentar os estágios do pipeline de CI e o que cada um valida

    Quando usar: CI/CD pipeline documentation

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

    Vamos documentar os códigos de erro com passos de resolução acionáveis

    Quando usar: Error resolution documentation

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

    A documentação da API inclui headers de rate limit nos exemplos de resposta

    Quando usar: Rate limit documentation details

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

    Documentei o processo de geração de dados de teste e scripts de seed

    Quando usar: Test data documentation

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

    Vamos documentar os casos extremos que a camada de validação trata

    Quando usar: Validation logic documentation

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

    A documentação deveria explicar como funciona a avaliação de feature flag

    Quando usar: Feature flag evaluation documentation

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

    Pode criar um mapeamento entre os endpoints antigos e novos da API?

    Quando usar: API migration mapping documentation

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

    Adicionei anotações ao diagrama de arquitetura explicando cada camada

    Quando usar: Annotated architecture diagrams

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

    A documentação do SDK inclui guias de início rápido para cada plataforma

    Quando usar: Multi-platform SDK docs

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

    A documentação deveria alertar sobre limitações conhecidas da implementação atual

    Quando usar: Limitation documentation

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

    Documentei os endpoints de health check e suas respostas esperadas

    Quando usar: Health check endpoint documentation

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

    A documentação deveria especificar o tamanho máximo de payload para cada endpoint

    Quando usar: API constraints documentation

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

    Vamos adicionar uma seção sobre como a funcionalidade foi projetada e por quê

    Quando usar: Design rationale documentation

  123. The documentation maps each microservice to its owning team

    A documentação mapeia cada microserviço para sua equipe responsável

    Quando usar: Service ownership documentation

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

    A documentação deveria incluir uma seção dedicada para comportamento específico de mobile

    Quando usar: Platform-specific documentation

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

    A documentação explica como configurar desenvolvimento local com Docker

    Quando usar: Docker setup documentation

Frases avançadas (81)

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

    Mudança incompatível: O formato de resposta do endpoint /users foi atualizado para incluir metadados de paginação.

    Quando usar: Writing a breaking change entry in the changelog

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

    O módulo exporta uma instância singleton que deve ser inicializada uma vez durante a inicialização da aplicação.

    Quando usar: 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.

    O limite de requisições é de 100 por minuto por chave de API. Exceder esse limite retorna o código de status 429.

    Quando usar: Documenting rate limiting policies in API documentation

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

    O middleware intercepta as requisições recebidas e valida o token de sessão antes de encaminhar para o handler.

    Quando usar: 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 compatibilidade retroativa, o endpoint legado continuará disponível até dezembro de 2026, após o qual será permanentemente removido.

    Quando usar: 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.

    A estratégia de tratamento de erros usa um error boundary centralizado que captura exceções não tratadas e as registra no nosso serviço de monitoramento.

    Quando usar: Describing error handling architecture in technical docs

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

    Consulte o diagrama de sequência abaixo para uma visão geral visual do ciclo de vida de requisição e resposta.

    Quando usar: 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.

    Ao contribuir para este projeto, siga o guia de estilo de código e garanta que todos os testes passem antes de enviar um pull request.

    Quando usar: 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 versão inclui melhorias de desempenho, correções de bugs e uma nova camada de cache que reduz o tempo médio de resposta em 40%.

    Quando usar: Writing release notes summarizing changes

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

    Garanta que todos os métodos públicos tenham comentários de documentação adequados, incluindo descrições de parâmetros, tipos de retorno e possíveis exceções.

    Quando usar: Setting documentation standards in a contributing guide

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

    Vamos criar um Registro de Decisão Arquitetural para a estratégia de migração do banco de dados.

    Quando usar: 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.

    O runbook precisa de uma seção sobre como lidar com failover do banco de dados.

    Quando usar: When updating operational documentation for incident response

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

    Eu documentei a decisão de design de usar event sourcing em vez de CRUD tradicional.

    Quando usar: When recording an important architectural choice for future reference

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

    O diagrama de sequência mostra como o fluxo de pagamento interage com o serviço de notificações.

    Quando usar: Describing a technical diagram in architectural documentation

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

    A documentação gerada automaticamente a partir do OpenAPI spec está sem exemplos de resposta.

    Quando usar: When reviewing automatically generated API documentation for completeness

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

    O ADR documenta as compensações entre usar uma arquitetura monolítica e microsserviços.

    Quando usar: Explaining the content of a specific Architecture Decision Record

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

    O runbook inclui instruções passo a passo para escalar o cluster durante picos de tráfego.

    Quando usar: 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.

    O diagrama entidade-relacionamento na nossa documentação precisa refletir as novas restrições de chave estrangeira.

    Quando usar: 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.

    O documento de onboarding explica nossa estratégia de branches, processo de revisão de código e pipeline de deploy.

    Quando usar: Describing comprehensive onboarding documentation for new hires

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

    Mantemos um registro de decisões para que futuros desenvolvedores entendam por que certas compensações foram feitas.

    Quando usar: Explaining the purpose of keeping architectural decision records

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

    A documentação do esquema do banco de dados deve incluir tipos de colunas, restrições e definições de índices.

    Quando usar: 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.

    Nossa abordagem de documentação como código significa que a documentação vive no mesmo repositório que o código-fonte.

    Quando usar: Explaining the team's documentation philosophy to a new team member

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

    O relatório de postmortem deve ser adicionado à nossa base de conhecimento de resposta a incidentes.

    Quando usar: 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.

    O guia de contribuição exige que todos os exemplos de código na documentação sejam testados na integração contínua.

    Quando usar: 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.

    Código autodocumentado reduz a necessidade de comentários, mas não elimina a necessidade de documentação de alto nível.

    Quando usar: Discussing the balance between code readability and written documentation

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

    A descrição do diagrama de sequência esclarece a ordem das chamadas de serviço durante o processo de checkout.

    Quando usar: 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.

    O guia de migração cobre mudanças incompatíveis e fornece trechos de código para cada correção.

    Quando usar: Describing a comprehensive migration document for a major library update

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

    Documente o comportamento de retry e os valores de timeout para cada integração com terceiros.

    Quando usar: Requesting documentation of resilience configuration for external service calls

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

    Adotamos Diátaxis como nosso framework de documentação, separando tutoriais de material de referência.

    Quando usar: Explaining the organizational framework used for structuring documentation

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

    A documentação de arquitetura usa diagramas do modelo C4 para mostrar contexto do sistema, contêineres e componentes.

    Quando usar: Describing the visualization approach used in architecture documentation

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

    A estratégia de versionamento da API e a política de descontinuação estão claramente descritas no portal do desenvolvedor.

    Quando usar: 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.

    O diagrama de fluxo de dados na documentação de arquitetura deve mostrar como os eventos se propagam pela fila de mensagens.

    Quando usar: Requesting specific technical detail in architecture documentation

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

    O arquivo de especificação OpenAPI serve tanto como contrato quanto como documentação para nossos endpoints REST.

    Quando usar: Explaining how the API specification doubles as documentation

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

    Devemos documentar o comportamento esperado quando o circuit breaker abre para serviços downstream.

    Quando usar: Requesting documentation about resilience patterns in the system architecture

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

    As diretrizes de contribuição agora exigem uma avaliação de impacto na documentação para cada pull request de funcionalidade.

    Quando usar: 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.

    A documentação de webhooks deve especificar o formato do payload, a política de retry e os códigos de resposta esperados.

    Quando usar: Defining completeness requirements for webhook integration documentation

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

    O ADR deve capturar o contexto, a decisão em si e as consequências tanto positivas quanto negativas.

    Quando usar: Explaining the proper structure of an Architecture Decision Record

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

    Incorporamos exemplos de código executáveis na nossa documentação usando playgrounds de código interativos.

    Quando usar: 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 lançar a mudança que quebra compatibilidade, precisamos enviar um email de depreciação e atualizar a documentação de migração.

    Quando usar: 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.

    Documentação deve ser tratada como um entregável de primeira classe, não como um adendo ao final de uma sprint.

    Quando usar: Advocating for prioritizing documentation work during sprint planning

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

    O registro de decisão de arquitetura explica por que escolhemos essa abordagem

    Quando usar: Referencing ADRs

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

    O guia de migração deveria cobrir as mudanças que quebram passo a passo

    Quando usar: Writing upgrade documentation

  43. The runbook describes how to handle production incidents

    O runbook descreve como lidar com incidentes em produção

    Quando usar: Operations documentation

  44. We need to document the authentication flow with examples

    Precisamos documentar o fluxo de autenticação com exemplos

    Quando usar: Security documentation

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

    O guia de deploy cobre todos os passos do staging até a produção

    Quando usar: Deployment process documentation

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

    Devemos documentar a política de retry para chamadas de API falhas

    Quando usar: Documenting resilience patterns

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

    A documentação deveria explicar a justificativa por trás de cada decisão de design

    Quando usar: Documenting the why, not just the what

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

    A estratégia de versionamento da API é explicada no guia do desenvolvedor

    Quando usar: Referencing versioning docs

  49. The security documentation should cover threat models and mitigations

    A documentação de segurança deveria cobrir modelos de ameaças e mitigações

    Quando usar: Security-focused documentation

  50. The performance benchmarks should be documented for each release

    Os benchmarks de performance devem ser documentados para cada lançamento

    Quando usar: Tracking performance metrics in docs

  51. I documented the caching strategy and invalidation rules

    Documentei a estratégia de cache e as regras de invalidação

    Quando usar: Cache architecture documentation

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

    A configuração de monitoramento e alertas está documentada no guia de operações

    Quando usar: Operations documentation

  53. The SLA documentation specifies uptime and response time guarantees

    A documentação de SLA especifica garantias de uptime e tempo de resposta

    Quando usar: Service level agreement documentation

  54. We should document the backup and recovery procedures

    Devemos documentar os procedimentos de backup e recuperação

    Quando usar: Disaster recovery documentation

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

    O guia de tratamento de erros documenta como os erros se propagam pelas camadas

    Quando usar: Error handling architecture documentation

  56. The network layer documentation explains the request pipeline

    A documentação da camada de rede explica o pipeline de requisições

    Quando usar: Documenting network architecture

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

    Os templates de infraestrutura como código são documentados no guia de DevOps

    Quando usar: Infrastructure documentation

  58. The compliance documentation tracks all regulatory requirements we meet

    A documentação de conformidade rastreia todos os requisitos regulatórios que atendemos

    Quando usar: Regulatory compliance docs

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

    Os resultados de testes de carga devem ser anexados à documentação

    Quando usar: Performance test documentation

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

    Pode documentar a política de retenção de dados para informações do usuário?

    Quando usar: Privacy policy documentation

  61. I created a decision matrix for the technology selection

    Criei uma matriz de decisão para a seleção de tecnologia

    Quando usar: Technology evaluation documentation

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

    Devemos incluir diagramas de topologia de rede nos docs de infraestrutura

    Quando usar: Network architecture documentation

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

    O postmortem do incidente deveria ser documentado com análise de causa raiz

    Quando usar: Post-incident documentation

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

    A documentação do event bus deveria listar todos os eventos publicados e consumidos

    Quando usar: Event-driven architecture docs

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

    O procedimento de rollback está documentado caso precisemos reverter

    Quando usar: Rollback documentation

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

    Vamos adicionar um diagrama mostrando os padrões de comunicação dos microserviços

    Quando usar: Microservices architecture docs

  67. The capacity planning document estimates resource needs for scaling

    O documento de planejamento de capacidade estima necessidades de recursos para escalabilidade

    Quando usar: Scaling documentation

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

    A documentação de migração de schema deveria explicar como reverter cada passo

    Quando usar: Database migration docs

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

    A documentação deveria incluir uma seção sobre procedimentos de recuperação de erros

    Quando usar: Error recovery documentation

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

    Adicionei uma seção sobre como lidar com dados sensíveis de acordo com nossa política

    Quando usar: Data handling documentation

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

    A documentação de observabilidade cobre logging, métricas e tracing

    Quando usar: Observability stack documentation

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

    Documentei todas as integrações com serviços de terceiros e seus SLAs

    Quando usar: Third-party service documentation

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

    Criei um dashboard de saúde da documentação para rastrear cobertura e atualidade

    Quando usar: Documentation metrics

  74. We documented the queue processing logic with throughput expectations

    Documentamos a lógica de processamento de filas com expectativas de throughput

    Quando usar: Queue system documentation

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

    Devemos documentar a estratégia de indexação do banco de dados para otimização de queries

    Quando usar: Database optimization documentation

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

    A documentação explica claramente como estender o sistema de plugins

    Quando usar: Plugin architecture documentation

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

    Devemos documentar os padrões de event sourcing usados no sistema

    Quando usar: Event sourcing documentation

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

    Pode documentar o comportamento de retry do consumidor da fila de mensagens?

    Quando usar: Message queue documentation

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

    A documentação deveria explicar a estratégia de invalidação de cache que usamos

    Quando usar: Cache invalidation documentation

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

    Precisamos documentar o procedimento de desligamento gracioso do serviço

    Quando usar: Service lifecycle documentation

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

    Documentamos as regras de sanitização de entrada para prevenir ataques de injeção

    Quando usar: Security best practices documentation

Outras situações do dia a dia de dev

← Inglês para devs

Guias com mais contexto

Leve para o celular

No app Devlingo você recebe 10 frases novas por dia, cada uma com contexto real, pronúncia e exemplos, e o widget mostra a frase do dia na Tela de Início do iPhone.

Perguntas frequentes

O que mais perguntam sobre o assunto, respondido com a fonte.

Como escrever um README em inglês?
Seções fixas: Overview, Installation, Usage, Configuration e Contributing, com uma frase de abertura dizendo o que o projeto faz.
Qual tempo verbal usar na documentação em inglês?
Presente para descrever (returns, accepts) e imperativo para instruções (install, run).
DevlingoFrases técnicas e fluência
Usar sem baixarBaixar