Telescope (core)
Como descrever corretamente os campos de uma interface?
ADS.FAQ-39001
Caso não informado, os campos das interfaces utilizam a mesma descrição que foi utilizada no respectivo atributo.
Muitas vezes, este descrição é perfeita e não é necessário fazer mais nada para que a interface fique devidamente documentada. No entanto, existem muitas situações onde esta descrição deve ser revisada contextualizando-a corretamente para o caso específico.
Algumas observações importantes:
- Várias "lookups" para a mesma entidade deve sem contextualizadas. Por exemplo, um pedido tem vários relacionamentos para pessoas (fornecedor, cliente, transportador, etc.). Neste caso, os textos devem ser ajustados para cada caso, informando, por exemplo, "Código do cliente que receberá as mercadorias", "Código da pessoa ou empresa que transportará os produtos", etc.
- Listas de opções de valores. Quando o sistema popula uma lista de opções para o usuário selecionar, é muito importante deixar claro quais as opções são apresentadas. Isso é especialmente importante quando as opções são dependentes de condições variadas. Por exemplo: "Apenas os tipos de pedidos de venda liberados para o estabelecimento são apresentados".