---
title: "Recordar"
description: "Relembrar informações que não foi possível memorizar, de parâmetros a códigos de erro."
doc_version: "2025-01-09"
last_updated: "2026-08-24"
canonical_url: "https://7act.org/pt-br/actions/remember/"
language: "pt-BR"
license: "CC BY 4.0"
---

# Recordar

Uma das coisas que mantém a documentação viva depois de anos e anos de uso é o seu valor como material de referência. Percorremos as páginas dos manuais para recordar — relembrar, recuperar, procurar — informações que não conseguimos memorizar, de parâmetros e códigos de erro a valores aceitáveis.

Exemplos de documentação que atende à necessidade de recordar são a [referência do Dockerfile da Docker](https://docs.docker.com/reference/dockerfile/) e a [referência da sintaxe YAML de CI/CD do GitLab](https://docs.gitlab.com/ee/ci/yaml/). Apresentam informações facilmente pesquisáveis e altamente estruturadas sobre os fragmentos que o usuário precisa relembrar para executar os seus vários encantamentos.

A documentação de referência é a base da usabilidade de um produto no longo prazo. Embora a documentação criada para atender a outras ações possa ser lida uma vez e assimilada, o material de referência mantém o seu valor permanentemente à medida que os usuários aprofundam os seus conhecimentos e enfrentam implementações cada vez mais sofisticadas.


## O que o usuário quer fazer

O material de referência mantém a documentação viva depois de anos de uso. Os usuários consultam manuais para recordar, relembrar, recuperar ou procurar informações que não conseguiram memorizar.

## Sinais de que a documentação não atende a essa necessidade

- Os usuários procuram um parâmetro ou código de erro e não encontram nada.
- O material de referência está espalhado por posts de blog e históricos de conversas.
- Não existe uma referência estruturada e pesquisável para a sintaxe ou as configurações do produto.

## Dois exemplos reais

- [Dockerfile reference](https://docs.docker.com/reference/dockerfile/)
- [GitLab CI/CD YAML syntax reference](https://docs.gitlab.com/ee/ci/yaml/)

## Tipos de conteúdo comuns

- DITA: <reference>, <refsyn>, <properties>
- Diataxis: Referência
- Good Docs Project: Referência, Glossário

## Uma métrica

taxa de acerto das consultas — Proporção das consultas ao material de referência que retornam a página certa.

## Sitemap

- [Modelo de documentação de sete ações](https://7act.org/pt-br/index.md)
- [Introdução](https://7act.org/pt-br/rationale/index.md)
- [Ações](https://7act.org/pt-br/actions/index.md)
- [Avaliar](https://7act.org/pt-br/actions/appraise/index.md)
- [Compreender](https://7act.org/pt-br/actions/understand/index.md)
- [Explorar](https://7act.org/pt-br/actions/explore/index.md)
- [Praticar](https://7act.org/pt-br/actions/practice/index.md)
- [Recordar](https://7act.org/pt-br/actions/remember/index.md)
- [Desenvolver](https://7act.org/pt-br/actions/develop/index.md)
- [Resolver](https://7act.org/pt-br/actions/troubleshoot/index.md)
- [Glossário](https://7act.org/pt-br/glossary/index.md)
- [Skill do modelo de documentação de sete ações](https://7act.org/pt-br/skill/index.md)