esta aula fornecerá muitas oportunidades para praticar a arte da redação técnica. Aqui estão algumas diretrizes simples que você pode usar para evitar problemas comuns.
nomeie o arquivo de ensaio de acordo com seu assunto (não sua data).
os arquivos de ensaio do modelo techfolio são nomeados com a data em que foram criados (ou seja 2015-08-26.md). não faça isso: nomeie cada arquivo de ensaio para refletir seu assunto. Por exemplo, você pode basear o nome do arquivo no título da sua redação. Se o seu ensaio título é “Inflamar o fogo”, em seguida o nome do arquivo pode ser “acendendo-o-de-fogo.md”.
não incluir espaços no nome do arquivo: use “acendendo-o-de-fogo.md”, não “acendendo o fogo.md”.
Se o navegador está baixando o arquivo em vez de exibi-lo, provavelmente porque o nome de arquivo não termina com “.md”.
nomenclatura Correta é importante para que o URL associado com a sua composição é de fácil leitura e fornece uma indicação da respectiva matéria.
nunca use “refletir” ou “reflexões” como parte do nome do seu arquivo.
crie um título interessante que atraia o leitor.
não nomeie seu ensaio com o nome do módulo (ou seja, “gerenciamento de configuração”) ou o nome da experiência (ou seja, “reflexões sobre Javascript”). Os mecanismos de pesquisa geralmente enfatizam o título das páginas. Você gostaria de ler um ensaio baseado em um título como esse? Com um pouco de pensamento, você pode criar algo pessoal (ou seja, “a catástrofe de gerenciamento de configuração que quase me custou meu trabalho”) ou inteligente (“você nem sempre pode git o que quiser”).
nunca use “refletir” ou “reflexões” como parte do seu título.
use ortografia e gramática apropriadas
não escreva incorretamente palavras. Use gramática apropriada. Se você não estiver confiante, aproveite as ferramentas on-line para verificar a ortografia e a gramática antes da publicação.
Escrever para o mundo, e não o professor
Embora muitos de seus ensaios serão baseadas em suas experiências fazendo casa de atribuições (por exemplo, experiências), não escrever o seu ensaio como se ele fosse um e-mail privado para o professor explicando a atribuição. Não crie seções para responder a cada uma das” perguntas ” no prompt. Se você fizer isso, quase certamente criará um ensaio chato que não é interessante de ler.
em vez disso, escreva-o “para o mundo”. Suponha que algum profissional técnico Aleatório tenha pesquisado no Google e seu ensaio tenha surgido. Torne o ensaio independente, autoexplicativo e útil para esse profissional Aleatório. Minimize as suposições que você faz sobre o histórico de engenharia de software dessa pessoa (muito menos seu histórico nesta classe!) Forneça links para o material de fundo, se útil.
Não só você deve escrevê-lo para uma variedade de pessoas, você deve escrevê-lo para uma variedade de vezes. Em outras palavras, tente escrever seu ensaio de forma que, se alguém o ler em um ano, ele ainda forneça informações de valor. Se você é um novato no assunto, escreva-o para fornecer informações e compreensão a outros novatos.
para tornar um ensaio atraente, geralmente é útil “contar uma história”. Crie uma narrativa, não responda apenas a perguntas.
formate o código apropriadamente
certifique-se de que o código seja exibido corretamente em sua postagem. Você consegue isso usando blocos de código cercados e realce de sintaxe. Aqui está um exemplo de destaque de código javascript :
function getTotalCost() { let cost = 0; for (let drink of this.drinks) { cost += drink.price; } return cost;}pense cuidadosamente antes de incluir grandes trechos de código (além, digamos, 50 linhas). Como regra geral, mantenha trechos de código com um comprimento razoável e certifique-se de que todo o código esteja diretamente relacionado ao assunto do seu ensaio.
Use títulos internos para estruturar seu ensaio
bons ensaios têm algum tipo de estrutura interna. Ajude o leitor a entender essa estrutura fornecendo títulos internos. Não comece com H1 (ou seja, # no Markdown), pois isso é reservado para o título da sua postagem. Em vez disso, comece com H2 (## em markdown) e crie subseções dentro dessa seção com H3 (### em markdown), etc.
da mesma forma, use listas discriminadas ou enumeradas, tabelas, etc, conforme apropriado.
formate e atribua citações
você ocasionalmente desejará citar outro escritor em seus ensaios técnicos. Isso é bom, desde que você não apresente essas palavras como suas.
se você está apenas citando uma ou duas frases, você pode simplesmente usar itálico, aspas e fornecer o nome do autor. Por exemplo:
conforme observado por Steve Jobs, ” Design não é apenas o que parece e parece. Design é como funciona.”
para aspas mais longas, use o ambiente < blockquote >junto com <rodapé>. Por exemplo:
um jovem cínico é quase a visão mais triste de se ver, porque isso significa que ele ou ela passou de não saber nada para não acreditar em nada.
inclua imagens ou outras mídias
como se costuma dizer, ” uma imagem vale mais que mil palavras.”É muito fácil incluir fotos e vídeos em seus ensaios. Se o significado do seu ensaio for comunicado com mais clareza com as imagens, reserve um tempo para encontrá-las e incluí-las. Consulte a seção formatação do Guia do usuário do TechFolio para obter instruções sobre como incluir imagens e vídeos.
não seja chato, não seja inapropriado
só porque o ensaio é de natureza técnica, não precisa ser chato. Tente injetar sua personalidade em sua escrita. Você pode ter títulos “inteligentes”, referências à cultura pop e assim por diante.
por outro lado, não exagere na inteligência. Pergunte a si mesmo: eu ficaria envergonhado se minha mãe lesse este ensaio? (Porque ela pode.) Eu ficaria envergonhado se um potencial empregador lesse este ensaio? (Porque ela pode.)
o objetivo é ser criativo, mostrar alguma personalidade e tornar o ensaio divertido de ler e informativo.
não escreva no último minuto
a qualidade de seus ensaios aumentará substancialmente se você os Desenvolver da seguinte forma:
- escreva o primeiro rascunho.
- faça outra coisa por 4 horas.
- volte e faça um passe de edição sobre o primeiro rascunho.
o passe de edição normalmente terá muitos problemas e permitirá que você refine seus pensamentos significativamente, desde que você se afaste do ensaio por um tempo suficiente para se permitir vê-lo com “olhos novos”. A melhor maneira de fazer isso é dormir durante a noite, mas se você não tiver muito tempo, pelo menos faça algo diferente por algumas horas. Isso permite que seu subconsciente trabalhe no material.
revise o conteúdo e a aparência da sua postagem
depois de escrevê-la e publicá-la, recupere-a em um navegador e veja como ela se parece.
um parágrafo não é suficiente
escrever um ensaio de duas ou três frases na esperança de obter algum crédito parcial não é uma boa estratégia. Por um lado, tal ensaio reflete mais mal em sua personalidade profissional do que nenhum ensaio. Por outro lado, tendemos a atribuir zero pontos por ensaios que refletem muito pouco esforço.
faça uso do centro de Escrita Uh Manoa
o centro de Escrita UHM fornece consultores que são treinados para ajudar em todas as fases do processo de escrita; se você está apenas começando, revisando um rascunho, ou em algum ponto no meio.
você pode agendar até dois compromissos por semana, bem como três compromissos walk-in por semana.