PLANEJANDO O ESCOPO E DESENVOLVENDO O CRONOGRAMA DE UM

PROJETO

Título do Projeto: Guia de Estilo Editorial para Base de Conhecimento Empresa

Desenvolvedora de Software.

Justificativa do projeto:
O projeto de criação do Guia de Estilo para a Base de Conhecimento possui uma
justificativa sólida baseada nas necessidades das empresas que desenvolvem
aplicações e enfrentam desafios na criação de documentação de software de
qualidade. O resultado esperado é a implementação de um guia que estabeleça
diretrizes claras e precisas para a criação de documentação de alta qualidade,
trazendo benefícios significativos para a empresa e seus usuários.
A importância desse projeto pode ser resumida nos seguintes pontos:
1. Garantia de qualidade: O Guia de Estilo tem como objetivo principal
estabelecer um padrão de qualidade para a documentação de software.
Isso assegura que todos os profissionais envolvidos na criação da
documentação sigam diretrizes consistentes, resultando em materiais
claros, objetivos e de alta qualidade. A padronização da linguagem e a
utilização adequada de elementos visuais contribuem para a criação de
uma documentação acessível e de fácil entendimento.
2. Facilidade de manutenção e atualização: Ao seguir as diretrizes do Guia
de Estilo, a equipe de documentação terá mais facilidade na manutenção
e atualização dos materiais. A padronização da estrutura e organização
dos conteúdos torna a busca e a localização de informações mais
eficientes para os usuários. Além disso, o guia promove a interconexão
dos conteúdos, facilitando sua manutenção e atualização.
3. Eficiência na busca por informações relevantes: A organização adequada
dos conteúdos contribui para reduzir o tempo gasto pelos usuários na
busca por informações relevantes. Quando a documentação é bem
estruturada e fácil de navegar, os usuários podem encontrar rapidamente
o que precisam, resultando em maior eficiência e satisfação.
4. Eliminação de inconsistências: O Guia de Estilo estabelece diretrizes
claras e precisas para todos os profissionais envolvidos na criação da
documentação. Isso ajuda a eliminar inconsistências que podem surgir
quando diferentes profissionais trabalham simultaneamente no projeto. A
consistência na documentação contribui para uma melhor experiência do
usuário e para evitar confusões ou erros causados por diferentes estilos
ou abordagens.

1
 5. Flexibilidade na adaptação: O guia é concebido como um documento vivo,
que deve ser atualizado regularmente para acompanhar as mudanças no
processo e nas necessidades dos usuários. A flexibilidade adequada na
aplicação do guia de estilo é importante para permitir que a equipe de
documentação possa adaptar-se a diferentes situações e contextos de
uso, garantindo a relevância contínua da documentação ao longo do
tempo.
Além desses benefícios mencionados, a padronização da linguagem utilizada na
documentação pode ser um diferencial para a empresa, contribuindo para a
satisfação dos usuários e a reputação da marca.
Em resumo, o projeto de criação do Guia de Estilo para a Base de Conhecimento
Invent Software é essencial para garantir a qualidade, consistência e eficiência
da documentação de software, atendendo às necessidades dos usuários e
fortalecendo a reputação da empresa.

O levantamento de Requisitos do projeto:

O levantamento de requisitos do projeto do Guia de Estilo para a Base de
Conhecimento Invent Software inclui as necessidades dos futuros usuários ou
partes interessadas do projeto. A listagem dos detalhes do resultado esperado é
a seguinte:
I. Introdução:
• Objetivo: Explicar o propósito do Guia de Estilo e sua importância na
criação de conteúdo claro e consistente para a base de conhecimento.
• Público-alvo: Identificar o público para o qual o guia foi desenvolvido, ou
seja, os profissionais envolvidos na criação da documentação de
software.
• Como utilizar: Orientar os usuários sobre como utilizar o guia de estilo de
forma eficiente para obter os melhores resultados na criação de conteúdo.
II. Estrutura do conteúdo:
• Arquétipo textual: Definir os diferentes tipos de conteúdo que podem ser
encontrados na documentação, como tutoriais, guias, FAQs, etc.
• Estrutura do texto: Estabelecer diretrizes para a estruturação e
organização do conteúdo, incluindo introdução, desenvolvimento e
conclusão.
• Linguagem e gramática: Definir as diretrizes para o uso adequado da
linguagem e a correção gramatical na documentação.
• Conectivos textuais: Orientar o uso de conectivos textuais para melhorar
a coesão e a clareza do conteúdo.
2
 • Tipografia: Disponibilizar recomendações sobre o uso adequado de
fontes, tamanhos e estilos para melhorar a legibilidade do texto.6
• Referências e conexões entre artigos: Explicar como estabelecer
referências e links entre os diferentes artigos para facilitar a navegação e
a busca de informações relacionadas.
• Nomenclatura de Interface e Comandos: Definir diretrizes para a
padronização da nomenclatura de interfaces e comandos utilizados na
documentação.
• Termos e definições: Estabelecer uma lista de termos e suas definições
para garantir uma compreensão consistente dos conceitos abordados.
• Imagens: Orientar a inclusão e o uso adequado de imagens ilustrativas
para auxiliar na compreensão do conteúdo.
III. Ferramentas e plataforma:
• Plataforma Movidesk: Descrever a plataforma Movidesk como a
plataforma recomendada para a criação e publicação da documentação.
• Ferramentas recomendadas para a criação de conteúdo: Listar as
ferramentas recomendadas para auxiliar na criação e edição do conteúdo
da documentação.
IV. Gestão de conteúdo:
• Revisão: Estabelecer diretrizes para a revisão do conteúdo antes da
publicação, visando a garantia da qualidade e consistência.
• Publicação de artigos: Descrever o processo de publicação de artigos na
base de conhecimento, incluindo etapas e responsabilidades.
• Atualização e manutenção de artigos: Orientar sobre as práticas para
atualização e manutenção contínua dos artigos, levando em consideração
as mudanças no software e nas necessidades dos usuários.
• Procedimento padrão: Definir um procedimento padrão a ser seguido pela
equipe de documentação em relação à criação, revisão, publicação e
atualização dos artigos.
V. Conclusão:
• Melhores práticas para criação de conteúdo de sucesso: Fornecer uma
conclusão com as melhores práticas a serem seguidas para a criação de
conteúdo de alta qualidade e eficácia na base de conhecimento.
Esses requisitos foram identificados com base na necessidade de estabelecer
diretrizes claras e precisas para a criação de documentação de software de alta
qualidade, garantindo a consistência, clareza, eficiência e satisfação dos
usuários.

3
A EAP (Estrutura Analítica do Projeto): A Estrutura Analítica do Projeto (EAP)
para o Guia de Estilo da Base de Conhecimento, pode ser representada da
seguinte forma:
1.1. Planejamento e Iniciação do Projeto
1.1.1. Definição dos objetivos e escopo do guia
1.1.2. Identificação das partes interessadas
1.1.3. Levantamento de requisitos do guia
1.2. Desenvolvimento de Conteúdo
1.2.1. Introdução
1.2.2. Estrutura do conteúdo
1.2.3. Linguagem e gramática
1.2.4. Conectivos textuais
1.2.5. Tipografia
1.2.6. Referências e conexões entre artigos
1.2.7. Nomenclatura de Interface e Comandos
1.2.8. Termos e definições
1.2.9. Imagens
1.3. Plataforma e Ferramentas
1.3.1. Avaliação e seleção da plataforma Movidesk
1.3.2. Pesquisa e escolha de ferramentas adequadas para criação de conteúdo
1.4. Gestão do Projeto
1.4.1. Definição do processo de revisão do conteúdo
1.4.2. Estabelecimento do procedimento de publicação de artigos
1.4.3. Implementação de mecanismos de atualização e manutenção dos artigos
1.5. Encerramento do Projeto
1.5.1. Revisão final do Guia de Estilo
1.5.2. Preparação para a entrega do guia
1.5.3. Documentação de lições aprendidas

4
5