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:
- TheGoodDocsProject
- Redator técnico:
- Loquacidade
- Nome do projeto:
- Guia de arquitetura da informação
- Duração do projeto:
- Duração padrão (3 meses)
Project description
Plano do guia de arquitetura da informação
Este documento abrange o planejamento de um guia de arquitetura da informação para o projeto Good Docs. Ele foi preparado como parte de um envio da temporada de documentos do Google 2020. Ele descreve o caso de uso do guia proposto e esboça um plano da estrutura desse guia, para fins de planejamento.
A arquitetura da informação (AI) diz respeito à forma como o conteúdo é organizado. Ele abrange a estrutura do conteúdo sem definir o estilo ou as palavras usadas nele. Por exemplo, um plano de AI consideraria quem é o leitor, como ele aborda o conteúdo e o ambiente em que está lendo. Ele consideraria uma estrutura apropriada para o conteúdo que atenderia melhor a esses requisitos do leitor.
Em um mundo perfeito, a documentação é projetada começando com uma estratégia de conteúdo, que usa metas de negócios para definir os objetivos da documentação. A estratégia de conteúdo é então usada para criar uma AI, que define o layout e a estrutura da documentação. Depois disso, é possível escolher conjuntos de ferramentas e gravar o conteúdo. A realidade da maioria dos projetos de código aberto é que a estratégia de conteúdo é tão simples quanto "escrever uma documentação para que as pessoas saibam como usar o projeto", mas mesmo essa estratégia simples é suficiente para definir uma AI eficaz.
A intenção deste guia é fornecer uma ferramenta simplificada para escritores não profissionais desenvolver uma AI que seja suficiente para determinar quais modelos devem usar. Ela deve ser simples o suficiente para ser concluída por um ser humano comum em uma tarde e deve priorizar a ação em vez da educação. O ideal é introduzir conceitos de forma sucinta, orientar o leitor a considerar esses conceitos em relação ao projeto e usar o resultado para passar ao próximo conceito.
Como suporte para este projeto, são necessárias algumas atualizações no README do projeto para que os leitores entendam como começar o projeto Good Docs e possam usar o guia de AI efetivamente para orientar suas escolhas de modelos.
Público principal
Todas as pessoas que desejam usar os modelos do The Good Docs Project para criar documentação para seus projetos
Casos de uso: esta seção foi projetada para explorar como os leitores abordam o guia de AI. Isso pode nos ajudar a identificar como o guia deve ser estruturado para atender melhor esses leitores.
Cenário:
uma pessoa está trabalhando em um projeto de código aberto com pouca ou nenhuma documentação, ou um pacote de documentação mal organizado ou escrito. Ele decide usar o projeto The Good Docs para organizar a documentação, mas não sabe por onde começar. Ele segue o README para saber como começar a usar os modelos e segue o Information Architecture Guide para desenvolver a estratégia de conteúdo e planejar a aparência do pacote de documentação.
Proposta
Atualize o README para orientar o novo leitor de forma mais clara pelo projeto, incluindo primeiras etapas claras. Um dos primeiros passos é ler e responder às perguntas de um novo Guia de AI. Esse guia convidaria o leitor a considerar o público-alvo, o esquema do conteúdo, as matrizes de usuário/tarefa etc. sem sobrecarregar o leitor de aprender/entender o que são essas coisas no sentido acadêmico. Depois que essa tarefa for concluída, o leitor vai saber quais modelos são necessários e a melhor forma de preenchê-los.
Pesquisa
Para embasar isso com a pesquisa, eu confio bastante no livro de Abby Covert (http://www.howtomakesenseofanymess.com/), em parte porque estou muito familiarizado com ele e ele criou a base de muitos conteúdos que já escrevi e vou fazer uso, mas também porque é muito fácil para as pessoas novas da AI conhecerem e lerem. É um pouco de um medicamento de entrada da IA, nesse sentido.
Resumo do rascunho
LEIA-ME:
-- Introduction to The Good Docs Project |_ Quem deve usar os modelos |_ Como os modelos funcionam |_ Como contribuir para o projeto -- Os modelos |_ Lista de todos os modelos atuais |_ Como escolher quais modelos usar |_ Antes de começar -- Antes de começar a escrever |_ Quem lê os documentos? |_ Por que eles leem os documentos? |_ Como escrever para seus leitores
Guia da arquitetura da informação:
-- Introdução |_ O que é uma AI? |_ Por que eu deveria me importar? -- Identifique a bagunça -- Diga sua intenção -- Realidade do rosto -- Escolha uma direção -- Meça a distância -- Brinque com a estrutura - Prepare-se para ajustar