Esta página contém os detalhes de um projeto de redação técnica aceito para a Google Season of Docs.
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 (três meses)
Project description
Durante a fase de inscrição de redatores técnicos do GSOD-2020, tive várias interações com Hugo Solar, mentor do projeto de documentação do tema base do WordPress Creative Commons.
No meu primeiro contato com ele, busquei ajuda para entender os objetivos da criação do guia de uso do tema base do WordPress. Ele foi muito prestativo e rapidamente me fez participar do projeto. Todas as interações consecutivas que tivemos depois disso foram para refinar os objetivos da documentação do tema Base do WordPress em CC.
Quando cheguei a um estágio, senti que entendi os requisitos e objetivos do projeto, então criei um rascunho de proposta para o Guia de uso do tema básico do WordPress para CC.
A proposta foi criada usando o modelo oficial da Creative Commons para candidaturas de estágio. Ele fornece informações sobre a sinopse do projeto, a estrutura proposta e o layout da nova documentação do tema básico do WordPress, bem como informações sobre cronogramas e resultados para a fase de criação do documento.
Hugo Solar analisou meu rascunho de proposta e me deu feedback para fazer melhorias. Durante todo esse processo, ele esteve sempre disponível para responder a perguntas sobre o projeto.
Implementei o feedback recebido, e minha proposta final para a documentação do selo de D&I está disponível no link abaixo como um documento do Google.
https://docs.google.com/document/d/1XmIsMTLstbhRRSaNFP538YOXJiS0G5QrN6EzuqJfRy4/edit?usp=sharing
Confira abaixo um breve resumo da minha proposta:
Creative Commons - Guia de uso do tema base do WordPress Uma proposta preparada por Jacqueline Binya, 28 de junho de 2020
Sinopse do projeto O objetivo final deste projeto é criar uma documentação rica, intuitiva, envolvente e bem apresentada para a comunidade do tema base do WordPress do Creative Commons.
Plano do projeto O problema Atualmente, o tema base do WordPress do Creative Commons não tem documentação, o que dificulta a utilização eficaz do tema na comunidade. Meu objetivo é criar um guia de uso completo para o tema e implementar abstrações na base de código atual do tema do WP Base para facilitar o uso dele.
A solução Crie documentos futuristas usando frameworks modernos como o Gatsby. O Gatsby tem inicializadores que podemos usar para inicializar a nova documentação do tema base do WordPress. Um exemplo de starter é o gatsby-gitbook-starter, que já vem com suporte para otimização de mecanismos de pesquisa (SEO), Markdown e Algolia ( uma ferramenta usada para integrar a 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, minha intenção é torná-la o mais intuitiva possível: - escrevendo os documentos de maneira fácil de entender e tomando cuidado para evitar ambiguidade e o uso excessivo de jargões técnicos complexos. - incorporando ilustrações gráficas e mídia na documentação para uso como ajudas visuais para aprendizagem. - usando exemplos que demonstram como executar tarefas comuns, por exemplo, personalizações.
As abstrações que pretendo implementar vão incluir a garantia de que a maioria das funcionalidades principais do tema base do WP, como os hooks, possam ser aproveitadas pelos usuários no painel administrativo do WordPress. Além disso, gostaria de criar um tema filho inicial para o tema base do WP em um repositório separado. Ter um tema filho inicial proporcionaria uma experiência de integração mais fácil e rápida para novos usuários. Depois que a documentação for concluída e aprovada, ela será publicada e hospedada on-line.
A estrutura proposta do guia de uso do tema base do WordPress do CC - A documentação proposta será dividida em diferentes seções listadas abaixo. Os itens da sublista em cada seção proposta fornecem mais detalhes sobre o conteúdo que será encontrado nas respectivas seções.
Seção de visão geral: descreva a definição, as intenções e os recursos do tema base do WordPress do Creative Commons(CC). * Definição: descreva brevemente o tema base do CC WP. * Intents: definir os objetivos/ intenções do tema base do WP do CC * Recursos: descrever os recursos do tema base do WP do CC
Seção "Noções básicas" - Requisitos * Defina os requisitos para instalar o tema base do WordPress do CC, por exemplo: - Versão do WordPress - Versão do PHP - Composer etc. - Guia de instalação * Defina como os usuários podem usar o zip para instalar o tema do WordPress do CC * Defina como os usuários podem começar a clonar o tema base do WP do GitHub. * Defina como os usuários podem instalar dependências no projeto. * Explique como os usuários podem configurar a dependência Queulat. * Explicar como os usuários podem ativar o tema no ambiente de desenvolvimento local do WordPress.
Guia de uso - Visão geral * Explique o termo "tema filho" * Apresente as vantagens de usar um tema filho. * Informar aos usuários que a maneira recomendada de editar o tema Base do WP é 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.
Como usar um tema filho - Explique como os usuários podem criar um tema filho do tema base do WP usando um modelo. Use um vídeo para explicar como os usuários podem criar um tema filho a partir do inicial.
Personalização Nas subseções abaixo, descrevemos como os usuários podem usar o Personalizador e o Painel administrativo do WordPress para fazer personalizações. Também vamos incorporar o uso de ilustrações gráficas para tornar nossas descrições mais intuitivas. - Personalizar a descrição ou a tag do site. - Menus de navegação personalizados - Personalizar CSS - Adicionar páginas - Adicionar postagens - Widgets - Adicionar e remover widgets do painel administrativo do WordPress - Adicionar widgets usando o Customizer com visualização em tempo real
Seção "Personalizações avançadas" - Seção "Como personalizar 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) a localização dos arquivos sass na estrutura do projeto; (ii) os scripts npm que podem ser usados para criar e observar sass. * Explicar como os usuários podem personalizar os estilos do sass no tema filho, ou seja, por meio da instalação de dependências npm específicas. * Explicar como a classe do componente (class-component.php) é usada para personalizar os estilos de componentes específicos.
- Seção de ganchos
Visão geral
- Explicar o termo ganchos
- Explique por que os usuários precisariam aproveitar os ganchos.
- Descreva os tipos de ganchos disponíveis.
Como usar as ações
- Listar as ações disponíveis no tema WP Base e o posicionamento delas
- Explique como essas ações podem ser implementadas.
*Como usar filtros - Liste os filtros disponíveis no tema e explique como eles podem ser implementados
Seção "Como atualizar o tema" - Explique como os usuários podem atualizar o tema.
Seção de licenciamento * Explique a licença do projeto e o que ela significa para as pessoas que podem querer usar o tema CC WP Base em projetos pessoais.
Seção "Como contribuir" * Adicionar um guia detalhado para colaboradores * Descrever o código de conduta * Comunidade: fornecer informações sobre os canais da comunidade do Creative Commons e como os colaboradores podem participar etc.