Esta página contém os detalhes de um projeto de escrita técnica aceito para a temporada de documentos do Google.
Resumo do projeto
- Organização de código aberto:
- Creative Commons
- Redator técnico:
- JackieBinya
- Nome do projeto:
- Guia de uso do tema base do WordPress
- Duração do projeto:
- Duração padrão (3 meses)
Project description
Durante a fase de inscrição do redator técnico do GSOD-2020, tive várias interações com Hugo Solar, que é mentor do projeto de documentação sobre temas base do Creative Commons para WordPress.
No meu contato inicial com ele, busquei ajuda para entender os objetivos da criação do guia de uso do tema base do WordPress. Ele foi muito útil e me levou rapidamente ao projeto. Todas as interações consecutivas que tivemos depois disso foram sobre refinar os objetivos da documentação do tema base do WordPress em CC.
Quando cheguei a um ponto, percebi que entendi os requisitos e objetivos do projeto. Depois, criei um rascunho de proposta para o Guia de uso do tema base do WordPress em CC.
A proposta foi criada usando o modelo oficial da Creative Commons para inscrições de estagiários. Ele fornece informações sobre o resumo do projeto, a estrutura do projeto proposto e o layout da nova documentação do Tema Base do WordPress, bem como informações sobre cronogramas e resultados para a fase de criação do documento.
Depois, o Hugo Solar analisou o rascunho da proposta e deu feedback para fazer melhorias. Ao longo desse processo, ele sempre esteve disponível para responder a perguntas sobre o projeto.
Implementei o feedback enviado, e minha proposta final para a documentação do selo de criação e desenvolvimento está disponível no link abaixo como um documento Google.
https://docs.google.com/document/d/1XmIsMTLstbhRRSaNFP538YOXJiS0G5QrN6EzuqJfRy4/edit?usp=sharing
Se preferir, veja abaixo um breve resumo da minha proposta:
Creative Commons - Guia de uso de temas base do WordPress Uma proposta preparada por Jacqueline Binya, 28 de junho de 2020
Resumo do projeto O objetivo final deste projeto é criar uma documentação rica, intuitiva, envolvente e bem apresentada para a comunidade para o tema base do WordPress no Creative Commons.
Plano do projeto O problema Atualmente, o tema base do Creative Commons para WordPress não tem documentação. Isso age como uma barreira para a utilização eficaz do tema na comunidade. Meu objetivo é criar um guia de uso completo para o tema e também implementar abstrações na base de código atual do tema WP Base para facilitar o uso.
A solução Crie documentos futuristas usando frameworks modernos, como o Gatsby. O Gatsby tem opções que podem ser usadas para inicializar a nova documentação do Tema Base do WordPress. Um exemplo de ativação é o gatsby-gitbook-starter, que vem pronto para uso com suporte para otimização de mecanismos de pesquisa (SEO), markdown e Algolia ( uma ferramenta usada para integração para pesquisa em sites estáticos). Além disso, qualquer site gerado pelo Gatsby pode ser facilmente otimizado para integrar internacionalização e acessibilidade. Ao criar a documentação, minhas intenções são torná-la o mais intuitiva possível: - Escrever os documentos de uma maneira fácil de entender e tomar cuidado para evitar ambiguidade e o uso de jargão técnico complexo demais. - incorporar ilustrações gráficas e mídia na documentação para usar como recursos visuais na aprendizagem; - usando exemplos que demonstram como executar tarefas comuns, como personalizações;
As abstrações que espero implementar incluirão a garantia de que a maioria das funcionalidades principais do tema base do WP, como hooks, possa ser aproveitada pelos usuários no painel do administrador do WordPress. Além disso, eu adoraria criar um tema filho inicial para o tema base do WP em um repositório separado. Um tema filho inicial proporcionaria uma experiência de integração mais suave e rápida para novos usuários. Depois que a documentação estiver completa e aprovada, ela será publicada e hospedada on-line.
Estrutura proposta do guia de uso do tema base do WordPress CC: a documentação proposta será dividida em diferentes seções listadas abaixo. Os itens da sub-lista em cada seção proposta fornecem mais detalhes sobre o conteúdo real que será encontrado nas respectivas seções.
Seção de visão geral - Descrever a definição, as intenções e os recursos do tema base do WordPress para Creative Commons(CC). * Definição: descrever brevemente o tema base do WP do CC. * Intenções: descrever os objetivos/ as intenções do tema base do WP do CC * Recursos: descrever os recursos do tema base do WP do CC.
Seção para começar - Requisitos * Descrever os requisitos para instalar o tema base do WordPress em CC, ou seja, - Versão do WordPress - Versão do PHP - Composer etc. - Guia de instalação * Descrever como os usuários podem usar o ZIP para instalar o tema CC do WordPress * Descrever como os usuários podem começar clonando o tema base do WP no GitHub. * Descrever como os usuários podem instalar dependências no projeto. * Explicar como os usuários podem configurar o Queulat de dependências. * Explicar como os usuários podem ativar o tema no ambiente de desenvolvimento local do WordPress.
Guia de uso - Visão geral * Explicar o termo tema filho * Mencionar as vantagens de usar um tema filho. * Informe aos usuários que a maneira recomendada de editar o tema do WP Base é usar um tema filho. * Destaque o fato de que o tema base do WP precisa ser instalado e ativado antes que os usuários possam criar um tema filho.
Usar um tema filho - Explicar como os usuários podem criar um tema filho do tema base do WP usando uma ativação. Use um vídeo para explicar como os usuários podem criar um tema filho desde o início.
Personalização Nas subseções listadas abaixo, descrevemos como os usuários podem usar o Personalizador do WordPress e o Painel do Administrador do WordPress para fazer personalizações. Também vamos incorporar o uso de ilustrações gráficas para tornar as descrições mais intuitivas. - Personalize a descrição do site ou a linha de slogan. - Menus de navegação personalizados - Personalizar CSS - Adicionar páginas - Adicionar postagens - Widgets - Adicionar e remover widgets no painel de administração do WordPress - Adicionar widgets usando o Personalizador com visualização em tempo real
Seção "Personalizações avançadas" - Seção "Como personalizar o CSS" * Descreva os componentes que constituem o estilo do tema: - Vocabulário do CC - Bulma - Sass * Explique como o Sass é configurado no projeto. A explicação precisa incluir informações sobre: (i) o local dos arquivos sass na estrutura do projeto; (ii) os scripts npm que podem ser usados para criar e controlar o sass. * Explicar como os usuários podem personalizar os estilos de sass no tema filho, ou seja, por meio da instalação de dependências de npm específicas. * Explicar como a classe de componentes (class-component.php) é usada para personalizar os estilos de componentes específicos.
- Seção de ganchos
Informações gerais
- Explicar o termo ganchos
- Explique por que os usuários precisam usar os ganchos.
- Defina os tipos de ganchos disponíveis.
Como usar as ações
- Listar as ações disponíveis no tema base do WP e o posicionamento dele
- Explique como essas ações podem ser implementadas.
*Usando filtros: liste os filtros disponíveis no tema e explique como eles podem ser implementados
Atualização da seção do tema: explique como os usuários podem atualizar o tema.
Seção de licenciamento * Explique o licenciamento do projeto e o que ele significa para pessoas que queiram usar o tema base do CC WP nos projetos pessoais.
Seção "Contribuições" * Adicione um guia de contribuição detalhado * Descrever o código de conduta * Comunidade: forneça informações sobre os canais da comunidade Creative Commons e sobre como os colaboradores podem participar.