| source-git-commit | workflow-type | source-wordcount | ht-degree |
|---|---|---|---|
437dad5fffe71592b6f9f9b4099a253e3a55b0c8 |
tm+mt |
712 |
47% |
Os usuários do Adobe Experience Manager trabalham em ambientes extremamente competitivos, esforçando-se para criar experiências digitais que as destaquem de seus concorrentes. Portanto, quando o Adobe oferece novas ferramentas avançadas no AEM, essas ferramentas são complementadas com documentação precisa e transparente para permitir que os clientes apliquem imediatamente seu investimento no AEM e maximizem o ROI.
O objetivo é colocar a documentação do AEM nas mãos de seus usuários assim que possível. Portanto, é criada uma documentação precisa e utilizável, que é continuamente atualizada e aprimorada.
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 pull requests ou problemas, as melhorias na documentação podem ser correções, esclarecimentos, expansões e mais exemplos.
As contribuições são bem-vindas à documentação do AEM. Qualquer contribuição para a documentação do, na forma de um pull request ou um problema, deve estar em conformidade com os padrões de contribuição e documentação do Adobe.
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 essa razão, os bugs, seus efeitos e soluções alternativas não são documentados.
As exceções a essa regra aplicam-se às notas de versão, nas quais problemas conhecidos podem ser listados com possíveis soluções que foram aprovadas pelo Gerenciamento de produtos do AEM.
Quaisquer ideias para melhorar a documentação do AEM são bem-vindas como contribuições. No entanto, comentários, problemas e pull requests destinam-se a contribuições somente. Elas não têm a intenção de responder suas perguntas sobre como usar o AEM, implementar seu projeto AEM ou resolver problemas técnicos.
Quaisquer dúvidas sobre o uso do AEM ou erros técnicos devem ser notificados por meio do processo normal de suporte pelo portal Experience Cloud Enterprise Support ou discutidas na comunidade do Experience Manager.
As contribuições à documentação do AEM não substituem o Atendimento ao cliente do Adobe e quaisquer contribuições que buscam respostas para perguntas relacionadas a suporte são rejeitadas.
Se você criar um problema para sugerir melhorias na documentação, deverá incluir links para as páginas afetadas. Se você criar um problema usando a variável Editar esta página em uma página de documentação, o problema é criado automaticamente com um link para a página.
Isso não se aplica a pull requests, que já fazem referência à página ou páginas afetadas.
Quaisquer contribuições à documentação do devem seguir determinadas diretrizes de estilo.
Seguir essas diretrizes facilita a revisão de sua contribuição, o que agiliza a integração à documentação.
- 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.
Lembre-se de que os leitores da documentação do AEM estão espalhados ao redor do mundo, e não espera-se que sejam falantes nativos ou fluentes em inglês. Evite linguagem coloquial, mantendo-a a mais clara e simples possível.
Manual de estilo da Microsoft® O é um guia de estilo disponível gratuitamente. Ele 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 usadas com critério e somente quando uma descrição textual for insuficiente.
Marcadores ou outras anotações em capturas de tela (como quadros vermelhos, setas ou texto) não devem ser usados. Dessa forma, as capturas de tela são mais fáceis de reutilizar ou replicar 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. Isso torna a documentação mais flexível e extensível para versões futuras.
Sempre use o nome completo do produto Adobe Experience Manager pela primeira vez num artigo, a seguir, pode ser referido como AEM.
Não se deve usar Day, Day Software, CQ e CRX, exceto quando for inevitável, como em nomes de classe ou em referência ao histórico do AEM.