| source-git-commit | workflow-type | source-wordcount | ht-degree |
|---|---|---|---|
2a25b0482800d4c5428a5595c9699dceed327043 |
ht |
714 |
100% |
Os usuários do Adobe Experience Manager trabalham em ambientes extremamente competitivos, esforçando-se para criar experiências digitais para se destacar de seus concorrentes. Portanto, quando a Adobe fornece ferramentas avançadas no AEM, essas ferramentas são complementadas com documentação clara e precisa. Ela permite que os clientes aproveitem imediatamente seu investimento no AEM e maximizem o retorno do investimento.
O objetivo é disponibilizar a documentação do AEM aos usuários o quanto antes. Portanto, a Adobe prioriza uma documentação precisa e utilizável, e busca atualizá-la e aprimorá-la continuamente.
Para melhorar continuamente a documentação do AEM, toda a comunidade de usuários do AEM é bem-vinda para contribuir em sua elaboração. Seja por meio de solicitações de pull ou tópicos, as melhorias na documentação envolvem correções, esclarecimentos, expansões, entre outros exemplos.
Embora a Adobe aceite contribuições para a documentação do AEM, sejam na forma de solicitações de pull ou tópicos, elas precisam estar em conformidade com os padrões de contribuição e documentação.
As contribuições que não cumprirem esses padrões poderão ser rejeitadas.
A documentação do AEM abrange casos de uso padrão. Casos de uso que não se enquadrarem no escopo de instalação e de uso padrão do produto não farão parte da documentação do AEM.
A documentação do AEM abrange casos de uso padrão. Por esse motivo, bugs, efeitos causados por bugs e soluções alternativas para bugs não são documentados.
As exceções a esta regra se aplicam às notas de versão, em que os problemas conhecidos podem ser listados com possíveis soluções aprovadas pelo gerenciamento de produtos.
Quaisquer ideias para melhorar a documentação do AEM são bem-vindas como contribuições. No entanto, comentários, tópicos e solicitações de pull devem ser realizados apenas como contribuições. Eles não devem envolver perguntas sobre como usar o AEM, implementar o projeto do AEM ou resolver problemas técnicos.
Você pode relatar qualquer dúvida sobre o uso do AEM ou erros técnicos. Use o processo normal de suporte por meio do Portal de suporte corporativo da Experience Cloud ou o processo discutido na comunidade do Experience Manager.
As contribuições para a documentação do AEM não substituem o atendimento ao cliente da Adobe, e quaisquer contribuições que busquem respostas a perguntas relacionadas ao suporte serão rejeitadas.
Se você criar um problema para sugerir melhorias na documentação, deverá incluir links para as páginas afetadas. Caso crie um tópico por meio de um link Editar esta página na documentação, o tópico será criado automaticamente com um link para a página.
Esse processo não se aplica a solicitações de pull, uma vez que, por sua natureza, fazem referência às páginas afetadas.
Solicitamos que qualquer contribuição para a documentação siga certas diretrizes de estilo.
Seguir essas diretrizes facilita a revisão da sua contribuição, o que agiliza a integração à documentação da Adobe.
- A documentação do AEM foi criada e mantida em inglês americano.
- Mantenha as sentenças o mais simples possível.
- Use linguagem clara e concisa.
Observe que os(as) leitores(as) da documentação do AEM estão espalhados pelo mundo, e não se espera que sejam falantes nativos ou fluentes em inglês. Evite linguagem coloquial e utilize um vocabulário claro e simples.
O Manual de Estilo da Microsoft® é um guia de estilo gratuito que se concentra na documentação de softwares, e a documentação do AEM o segue sempre que possível.
| Item | Estilo |
|---|---|
| Elemento ou opção da interface do usuário | negrito |
| Nome do arquivo, caminho, entrada do usuário, valores de parâmetro | monospaced |
| Código, linha de comando | Code Block |
As capturas de tela devem ser utilizadas com critério e somente quando uma descrição textual for insuficiente.
Não utilize marcadores ou outras anotações em capturas de tela (como quadros vermelhos, setas ou texto). Dessa forma, as capturas de tela são mais facilmente reutilizadas ou replicadas em versões localizadas da documentação.
Evite referências diretas a uma versão específica em todo o conteúdo da documentação, sempre que possível. Esta recomendação torna a documentação mais flexível e extensível para versões futuras.
Em um artigo, sempre use o nome completo do produto Adobe Experience Manager na primeira vez em que for utilizado. Posteriormente, pode ser referido como AEM.
Não utilize Day, Day Software, CQ e CRX, exceto quando isso for inevitável, como em nomes de classe ou em referência ao histórico do AEM.