Get best of the week

Como fazer com que seu artigo ou documentação seja compreendido com rapidez e precisão

Não apenas o conteúdo, mas também a estrutura do texto deve ser significativa.

Portanto, se estamos falando de um texto técnico ou científico, por exemplo, um artigo ou documentação, o formulário deve ajudar a entender rápida e facilmente o conteúdo. Para mim, no caso do artigo, isso significa que a estrutura deve ser algo como isto:

  • Título
  • A essência do artigo
    Com base nessas poucas frases, juntamente com o título, o leitor deve entender se está interessado em ler mais este artigo.
  • Resumo
    Aqui, na forma mais concisa, tese, mas com a precisão e a integridade necessárias, a essência deste artigo deve ser refletida - de várias frases a várias páginas. Alguém profundo no assunto pode ser suficiente para entender o artigo inteiro. Mas, em qualquer caso, é útil que o leitor apresente da forma mais geral sobre o que é este artigo e que conclusões ele receberá no final.
  • A lógica do artigo
    Se o artigo for longo, contiver muitas seções e lógica complexa, este capítulo também poderá ser útil. Este é essencialmente um índice estendido. Aqui, brevemente, em uma ou duas páginas, a lógica do raciocínio é declarada, secamente, sem detalhes. Novamente, isso será suficiente para alguém entender tudo. Se for difícil, o leitor pode pular isso (como um índice) e continuar lendo.
  • Apresentação simplificada
    Se o artigo for bastante complicado, muitos ficarão à vontade para entender primeiro conceitualmente o que o autor quer dizer. Portanto, é bom declarar tudo como se você estivesse dizendo aos alunos, perdendo evidências complexas e talvez não em uma linguagem formal e rigorosa. Para muitos, esse nível de apresentação pode ser suficiente e eles param por aqui.
  • Apresentação estrita
    Aqui está uma apresentação estritamente profissional.

Obviamente, a estrutura não precisa ser apenas isso. Por exemplo, dependendo da complexidade e do comprimento do texto, algumas seções podem ser redundantes ou, inversamente, adicionadas, mas a estrutura deve ser apropriada para a finalidade. Nesse caso, a abordagem declarada permite ao leitor entender o conteúdo de um artigo complexo o mais rápido possível e com o grau de profundidade necessário. Eu apliquei essa abordagem ao escrever o artigo Equações Diferenciais Não Lineares, a discrição do espaço-tempo e do produto epsilon . Você verá todos os itens, exceto o último.

Eu tenho que ler muita documentação técnica. Na minha opinião, a organização geralmente aceita do texto é inconveniente. Não tenho tempo (e desejo) para desfrutar do desenvolvimento consistente do enredo e da beleza da sílaba, não é "Guerra e paz", preciso apenas de informações e, quanto mais rápido, melhor. Portanto, no caso de um tópico novo e complexo, primeiro preciso digitalizar o texto várias vezes em busca de significados, conclusões e lógica, e só então posso percebê-lo adequadamente. De fato, sigo a abordagem descrita, mas de uma maneira muito inconveniente e demorada, e seria muito mais conveniente para mim se as informações fossem imediatamente organizadas de acordo.

More articles:


All Articles