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:
- LibreOffice
- Redator técnico:
- Krezhairo (em espanhol)
- Nome do projeto:
- Referência das funções de cálculo e guia do usuário
- Duração do projeto:
- Duração padrão (3 meses)
Project description
SOLICITAÇÃO DE PROJETO
Posso facilmente dedicar de 30 a 35 horas por semana durante a fase técnica de escrita e de 10 a 12 horas na fase de pré-escrita para aprender qualquer adição na habilidade necessária para o projeto. Gostaria de informar que atualmente moro na minha universidade(no meu país de origem), onde tenho acesso à Internet rápida e a qualquer recurso adicional necessário para o projeto. Vou continuar de universidade por toda a duração do projeto, já que estamos na COVID-19. A situação da minha universidade não começa em breve e, mesmo se isso acontecer, eu só estaria no último ano em um projeto que não deveria participar de cinco horas em qualquer semana.
INTRODUÇÃO
O LibreOffice Calc tem uma extensa lista (+ de 500) de funções em muitas categorias para as quais a documentação é bastante superficial (mas, mesmo assim, precisa) na Ajuda. O assistente de funções integrado do Calc também fornece ao usuário informações resumidas sobre a finalidade e os parâmetros de cada função. Uma estrutura foi criada na wiki da The Document Foundation para capturar informações de referência mais detalhadas sobre as funções do Calc.
OBJETIVO
Para preencher a estrutura do wiki escrevendo conteúdo mais detalhado para cada uma das funções do Calc, foi útil sinalizar a adesão ao padrão ODFF, incluindo ilustrações e diagramas, fornecendo um ou dois exemplos para indicar casos extremos e exceções e fornecendo arquivos de amostra/exemplo.
PLANO DE TRABALHO DO PROJETO
Aprendi a ideia principal do projeto e estamos essencialmente tentando documentar o funcionamento de cada função no assistente de funções e com exemplos suficientes de cada uma abrangendo todos os aspectos das funções. Tente tornar a documentação o mais intuitiva possível para que um novo usuário possa consultar e, em questão de segundos, entender como usá-la.
Eu consideraria dividir essas funções por categorias:
• Database: This section deals with functions used with data organized as one row of data for one record.
• Date & Time: These spreadsheet functions are used for inserting and editing dates and times.
• Financial: This category contains the mathematical finance functions of LibreOffice Calc.
• Information: This category contains Information functions.
• Logical: This category contains Logical functions.
• Mathematical: This category contains the Mathematical functions for Calc.
• Array: This category contains the array functions.
• Statistical: This category contains Statistics functions.
• Spreadsheet: This section contains descriptions of the Spreadsheet functions together with an example.
• Text: This section contains descriptions of the Text functions.
• Add-in: The following describes and lists some of the available add-in functions.
Cada um tem cerca de 20 a 50 funções, com poucas categorias tendo mais. A maioria inclui uma descrição superficial com sintaxe e um exemplo.
Eu gostaria de adicionar conteúdos mais detalhados para cada uma das funções do Calc, sinalizando a adesão ao padrão ODFF, incluindo ilustrações e diagramas sempre que útil, fornecendo um ou dois exemplos para indicar casos especiais e exceções na forma de comentários, e fornecendo arquivos de amostra/exemplo. Adicionar também uma seção importante sempre que for útil. Vou considerar usar essas funções em formato categórico, ou seja, escolher uma, trabalhar verticalmente e depois mover para outra categoria durante o período de redação técnica. Além disso, considere me acostumar com o ambiente de trabalho durante o período de vínculo com a comunidade para facilitar a escrita. De acordo com minha experiência, descobrir todos os pequenos momentos de "pegadinha" da documentação desses tipos de aplicativos exige um investimento de tempo. Em termos de planejamento, no início, abordaria o projeto executando essas 11 categorias para trabalhar. É claro, algumas vão precisar de mais assistência e, portanto, exigirão mais tempo do que outras, mas essas coisas podem ser resolvidas durante o trabalho. Como já existe uma documentação e estou escrevendo sobre ela, vou considerar a revisão após o término das tarefas de cada semana, já que não é bom deixar para a última semana.
Portanto, abaixo está um cronograma aproximado para organizar o projeto dentro dos limites de tempo.
- Semana 1:(14 de setembro) • Banco de dados
- Semana 2:(21 de setembro) • Data e hora
- Semana 3:(28 de setembro) • Finanças
- Semana 4:(5 de outubro) • Informações
- Semana 5:(12 de outubro) • Lógica
- Semana 6:(19 de outubro) • Matemática
- Semana 7:(26 de outubro) • Matriz
- Semana 8:(2 de nov.) • Estatística
- Semana 9:(9 de nov.) • Planilha
- Semana 10:(16 nov) • Mensagem de texto
- Semana 11:(23 nov) • Complemento
- Semana 12:(30 nov. a 5 dez.)(final)
Documentar o trabalho feito e a experiência adquirida com o projeto e o trabalho em pequenas coisas incluíram a segunda etapa de revisão/edição, se necessário, para preparar a documentação para envio.