documentação embutida

adicionar e visualizar documentação em tempo real nas páginas. Nomes alternativos para este módulo podem ser “documentação Contextual “ou” documentação em tempo real”, mas inline tem um bom toque e corresponde à maneira como a documentação é colocada no código.

este módulo criará um tipo de conteúdo “documentação embutida” e adicionará um botão azul redondo ao canto inferior direito de cada página. Este botão alterna um painel que contém uma lista dos nós de documentação embutidos.

a documentação é a chave para fácil manutenção ou transferência de projetos. No entanto, ninguém gosta de escrever documentação e ninguém gosta de ler documentação.

a documentação em linha tenta aliviar a carga de documentação de escrita simplesmente permitindo que o usuário adicione pequenos bits de documentação diretamente à página da web onde o leitor precisa dela. Isso diminui a necessidade de extensas páginas Wiki e documentos do Word.

navegue até a página em questão, clique no botão ‘Adicionar documentação’ e comece a escrever alguns documentos. Recomenda-se manter esses documentos curtos e simples, você pode adicionar quantos quiser a uma página e até anexá-los aos elementos DOM.

Deixe uma resposta

O seu endereço de email não será publicado.