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

# Recordar

Uma das coisas que mantém a documentação viva após anos e anos de utilização é 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, desde parâmetros e códigos de erro até valores admissíveis.

Exemplos de documentação que responde à 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/). Ambos apresentam informações facilmente pesquisáveis e altamente estruturadas sobre os fragmentos que o utilizador precisa de relembrar para executar diversos encantamentos.

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


## O que o utilizador quer fazer

O material de referência mantém a documentação viva após anos de utilização. Os utilizadores consultam os manuais para recordar, relembrar, recuperar ou procurar informações que não conseguiram memorizar.

## Sinais de que a documentação não responde a esta necessidade

- Os utilizadores procuram um parâmetro ou código de erro e não encontram nada.
- O material de referência está disperso por artigos de blogues e históricos de conversas.
- Não existe uma referência estruturada e pesquisável para a sintaxe ou as definiçõ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 sucesso das consultas — Percentagem das consultas ao material de referência que devolvem a página certa.

## Sitemap

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