Recentemente, há dois artigos, um centésimo artigo foi publicado em nosso hub corporativo. Em homenagem ao número da rodada, decidimos resumir um pouco a nossa experiência. Neste artigo, mostraremos como nossos desenvolvedores trabalham nos artigos, o que os ajuda a escrever e no que prestar atenção ao trabalhar no texto.
Para começar, basta responder a duas perguntas simples:
- Por que eu preciso disso?
- O que direi interessante e útil para a comunidade habra?
Então você pode pegar o plano deste artigo (ou criar o seu próprio) e fazê-lo.
Existem etapas criativas e técnicas. Este artigo é sobre criativo. Considere:
- Por que escrever artigos
- Onde obter o tópico para o artigo,
- Onde encontrar tempo para escrevê-lo,
- As principais etapas do trabalho sobre o texto,
- O que fazer se o artigo não for publicado,
- E por onde começar, se você nunca escreveu em Habr.
Esperamos que o texto seja útil para outros autores da Habr, inclusive os potenciais.
Motivação: por que eu, como desenvolvedor, escrevi em Habr
Não existe uma resposta única e não há uma bala de prata. Portanto, damos as respostas de nossos funcionários, onde todos podem se reconhecer e ouviremos com prazer, como você.
- Socialização
A empatia e o senso de comunidade motivam - quero compartilhar emoções e pensamentos sobre o processo de desenvolvimento com uma comunidade interessada. - Organize seu conhecimento
Gosto da ordem em minha mente e escrever um artigo ou o texto final em geral pode acelerar a busca por lacunas na compreensão e no conhecimento sobre o tópico. O artigo permite que você observe o tópico de diferentes ângulos, para descobrir completamente todos os momentos incompreensíveis, para realizar alguma coisa. - Interesse classificar o novo e compartilhar
Ele motiva a escrever sobre algo novo para si, sobre o que há de novo no mundo do desenvolvimento. Se eu estivesse realizando tarefas típicas, acho que não haveria nenhum tipo de exaustão disso. De maneira geral, a saída é uma instrução com ou sem piadas, que se assemelha a uma resposta detalhada com Stack Overflow sobre a pergunta / tópico solicitado no título do artigo. - Economize tempo no treinamento interno
O artigo é um compêndio para colegas que ainda precisam contar mais tarde. E assim ele escreveu - e enviou ou conduziu um seminário. - Obtendo feedback e comentários da empresa
É muito bom obter pontos de vista e vantagens na partida, pois melhora o carma. O karma aprimorado também o motiva a escrever mais. Nos comentários, você pode encontrar informações úteis para você, dos caras que seguiram o mesmo caminho e que já preencheram os requisitos. - Para o melhor
Ele é inspirado no desejo de acelerar o desenvolvimento da humanidade - se alguma atividade do autor poupar às pessoas mais tempo do que ele gastou - em média, é provável que a humanidade se beneficie no desenvolvimento, pois o tempo economizado provavelmente será gasto em atividades úteis.
A escolha de um assunto considerando a utilidade para Habr
Ao escolher tópicos, focamos em nossa experiência subjetiva e casos práticos, pelos quais passamos e testamos a nós mesmos. Obviamente, supõe-se que tenhamos estudado literatura com antecedência e não repetiremos o que já foi escrito. E de acordo com as regras da boa forma, sempre nos referimos a fontes úteis.
Bons tópicos
- Existem soluções sobre as quais os desenvolvedores dizem: "Não havia nenhuma documentação oficial sobre isso, também no Habré. Eu tive que mexer. " Se a decisão em si for decente, o artigo será bom.
- Alguns tópicos decorrem do desafio global colocado pelo projeto - por exemplo, fornecer alta disponibilidade e IC / CD transparente. Cada passo em direção a esse objetivo - migração para .Net Core, Docker e assim por diante - pode ser descrito em um artigo separado. Em comícios, uma piada "em um artigo!" Freqüentemente pula, ou seja, colegas como se sugerindo.
- Parte do tópico aparece quando você pesquisa ativamente um novo tópico. Há um sinal: se o desenvolvedor passou mais de 4 horas pesquisando no Google ou lendo outros artigos, vale a pena compilar pelo menos as informações encontradas ou talvez escrever algo novo.
- Alguns textos nascem depois de ler um livro interessante, participar de uma boa conferência ou até como documentação interna - quero compartilhar novos conhecimentos.
O que é benéfico é bom, economiza tempo no futuro para os leitores e fornece experiência prática, em vez de especulações filosóficas sobre a paz mundial.
Tópicos ruins
Existem muitos deles, mas mencionaremos alguns deles:
- Uma repetição de tudo o que é conhecido com o único objetivo de indexar por palavras-chave,
- Publicidade direta ou indireta de uma empresa ou cliente (veja com quem trabalho),
- Um artigo sobre nada ou um fluxo de pensamentos sem estrutura.
Em geral, tudo é ruim que não beneficia o leitor ou não o respeita.
As principais etapas do trabalho sobre o texto
Para o autor, o trabalho dos textos passa por 6 etapas criativas:
- Estabelecimento de metas: formular um tema, ideia e plano. Para encontrar um tópico, respondemos às perguntas “Que novos leitores aprenderão com este artigo”, “Para quem o escrevemos”, “O que exatamente queremos compartilhar”. Também é importante para nós que o artigo traga algo novo. Para fazer isso, examinamos as palavras-chave que já foram escritas sobre esse tópico e se estamos nos repetindo.
- Notas ou diário de laboratório. No decorrer do trabalho na tarefa, os desenvolvedores fazem anotações: salve links úteis, escreva lembretes para situações de emergência, para que você possa fazer engenharia reversa de anotações em texto legível. No que diz respeito ao texto, resta apenas reler o "diário do laboratório", reformular algumas anotações usando vocabulário mais ou menos aceito em geral e montá-las em uma ordem lógica.
Um de nossos autores usa o editor de remarcação on-line hackmd.io, onde ele corrige suas etapas no desenvolvimento do tópico. Essa ferramenta permite que você compartilhe texto, mostre o progresso no artigo e, o mais importante, faça antecipadamente. Como resultado, temos um texto no qual publicar no Habr é suficiente para adicionar um recorte e dar alguns pequenos traços. Isso é conveniente para controlar a estrutura e o layout do texto.
- Organize o texto. Escrevemos os pensamentos principais e analisamos sua utilidade e localização na estrutura do artigo. O índice é obtido, ou seja, o agrupamento de texto em blocos semânticos que podem ser percebidos sem a leitura de outras seções.
- Editamos e editamos para que um estranho "fora do assunto" entenda mais ou menos o significado do que foi dito. Você pode reler pelo menos uma vez por dia e editar o que não gosta. A edição requer várias iterações, assim como o trabalho no texto. Nesta fase, examinamos a linguagem e os erros - o texto não verificado é lido como se fosse escrito por um aluno de dois anos.
- Nós olhamos o texto através dos olhos de outras pessoas : o artigo está sendo lido por outro desenvolvedor ou gerente de projeto que é competente neste tópico. Um novo visual e críticas construtivas melhoram o produto.
- Estamos preparando o texto para impressão. Fazemos edições finais, pensamos em ilustrações, escolhemos os hubs apropriados - e imprimimos!
A sequência desses estágios não é rigorosa. Acontece que o autor primeiro elabora um plano, revela cada item e o detalha no nível desejado, depois corrige o texto em várias iterações. E acontece que, a princípio, o desenvolvedor esboça a solução para a tarefa de trabalho e, já com base nisso, nasce o texto para Habr. A qualquer momento, outros colegas podem participar do artigo para ajudar com uma ideia ou conselho.
E agora de planos para ação. Ou seja, para o texto.
Muitas tarefas: como encontrar tempo para trabalhar no texto
O trabalho em textos no estilo de "adiar todas as tarefas e deixar com a cabeça" não funciona para nós por causa do
fator ônibus . Portanto, os autores estão gradualmente envolvidos no artigo em segundo plano no restante do trabalho. Geralmente, o texto é um compêndio da tarefa de trabalho real.
Um de nossos autores comparou este trabalho com testes. A princípio, você acha que não há tempo para escrever testes. Então você incorpora essa atividade no processo - e acontece que há tempo. Textos, como testes, ajudam a entender o que está acontecendo. Mesmo se você alocar o artigo a cada hora por dia, ele funcionará. Claro, se é importante para uma pessoa.
Outro escreve estritamente de manhã. Primeira coisa primeiro. Sabendo que ele tem muito trabalho principal pela frente, ele pode gastar 20 minutos no texto desde o início do dia útil. Em tais circunstâncias, acaba por escrever de forma clara, concisa e sobre o caso.
Eu quero escrever um artigo sobre Habr e chegou a um tópico. Por onde começar?
Não há nada de novo nesse problema. Stephen King, George Orwell, Edgar Allan Poe, os camaradas Strugatsky, o dueto Henry Lyon Oldie, Richard Feynman e muitos outros autores de uma forma ou de outra disseram:
"Se você deseja começar algo (escrever um artigo, um livro ou uma carta para um amigo), mas ainda não consegue - não há tempo e situação melhores para fazer isso do que ... agora!"
Um de nós ajuda a abrir um editor de texto e coloca uma série de pensamentos sobre o assunto. O mais provável é que tudo esteja "errado", mas o primeiro passo foi dado - o trabalho no artigo já começou.
Existe outra maneira: encontrar outro funcionário e falar sobre o tópico do artigo. E para começar a história com as palavras: "Bem, em suma ...". E assim que os primeiros pensamentos vieram, gritando "Obrigado!" fuja para si mesmo e escreva com urgência sua história. Em palavras simples, com tapetes de produção, que você substitui por algo construtivo.
E para um lanche, o caminho do clássico é estritamente sob sua responsabilidade.
Estou escrevendo, estou escrevendo, estou preso. O que fazer
Existem três cenários que podem ser aplicados à situação:
- Tome uma xícara de chá e relaxe. Você certamente não precisa se forçar quando o texto "não vai" - nada de bom advém dessa superação. Aliás, não se trata apenas de escrever artigos.
Mas jogar um emprego não vale a pena. Assim que sentir que está mais ou menos relaxado - releia o que está escrito, com certeza algum outro pensamento virá à sua mente. Desenhe um contorno da estrutura do texto. Jogue texto para um colega.
Faça algo em torno do texto, mas não exorte as palavras. Então os próprios pensamentos começarão a se aglomerar e será necessário agarrá-los pela cauda - e colocá-los, como estão, no papel / em um editor de texto. - Coloque todo o material no lançamento do artigo "como está". Neste ponto, você deve terminar de escrever os pensamentos principais ou concluir logicamente com a conclusão de que existe. Se isso parecer bom, o restante poderá ser transferido para o próximo artigo.
- Um estupor profundo e prolongado pode significar que o tópico não está próximo e você não precisa escrever sobre ele. É melhor cortar esses tópicos na primeira etapa. Ou consulte um colega.
Se você tiver outras opções, como sair de um estupor criativo - compartilhe nos comentários.
Em conclusão
Escreva. Não ouça ninguém e escreva. Isso é bom E você escreverá bem - geralmente excelente. E então a habro-comunidade ficará inteligente, jurará e ficará rica.
Por fim, links úteis para este tópico:
Compartilhe suas receitas nos comentários, espere!