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:
- LibreOffice
- Redator técnico:
- Krezhairo
- Nome do projeto:
- Referência e guia do usuário das funções de cálculo
- Duração do projeto:
- Duração padrão (três meses)
Project description
SOLICITAÇÃO DE PROJETO
Posso dedicar facilmente de 30 a 35 horas por semana durante a fase de redação técnica e de 10 a 12 horas na fase de pré-escrita para aprender qualquer habilidade adicional necessária para o projeto. Gostaria de informar que, atualmente, estou na minha universidade(no meu país de origem), onde tenho acesso à Internet rápida e a qualquer recurso complementar necessário para o projeto. Vou continuar na minha universidade durante toda a duração do projeto, já que estamos em uma situação de COVID-19.
INTRODUÇÃO
O LibreOffice Calc tem uma lista extensa (+ 500) de funções em muitas categorias, para as quais a documentação é bastante superficial (mas precisa) na Ajuda. O Assistente de função 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 no wiki da 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, sinalizando a adesão ao padrão ODFF, incluindo ilustrações e diagramas, foi útil fornecer um ou dois exemplos para indicar casos extremos e exceções e fornecer arquivos de exemplo.
PLANO DE TRABALHO DO PROJETO
Eu me aprofundei com a ideia central do projeto e estamos essencialmente tentando documentar o funcionamento de cada função no assistente de funções e com exemplos suficientes para cada uma abrangendo todos os aspectos das funções e tento tornar a documentação o mais intuitiva possível para que um novo usuário possa pesquisar 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 uma tem cerca de 20 a 50 funções, com algumas categorias tendo mais. A maioria deles inclui uma descrição superficial com sintaxe e um exemplo.
Gostaria de adicionar conteúdo mais detalhado 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 extremos e exceções na forma de observações e fornecendo arquivos de exemplo. Também adicionar uma seção importante quando for útil. Vou considerar essas funções em formato categórico, ou seja, escolher uma e trabalhar verticalmente e, em seguida, passar para outra categoria durante o período de redação técnica. Além disso, eu consideraria me acostumar com o ambiente de trabalho durante o período de integração com a comunidade para facilitar as coisas durante a fase de escrita. Por experiência própria, é preciso investir tempo para descobrir todos os vários momentos de "pegadinha!" da documentação desses tipos de aplicativos. Em termos de planejamento, no início, eu abordaria o projeto concorrendo em 11 categorias para trabalhar. É claro que algumas vão precisar de mais assistência e, portanto, exigir mais tempo do que outras, mas essas questões podem ser abordadas enquanto você trabalha. Como já existe alguma documentação e estou escrevendo sobre ela, vou considerar a revisão após a conclusão de cada tarefa da semana, já que não é bom deixar para a última semana.
Portanto, abaixo está um cronograma bruto 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) • Financeiro
- Semana 4 (05 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 novembro) • Estatística
- Semana 9:(9 de novembro) • Planilha
- Semana 10:(16 de novembro) • Texto
- Semana 11: 23 de novembro • Complemento
- Semana 12:(30 de novembro a 5 de dezembro)(final)
Documentar o trabalho realizado e a experiência adquirida com esse projeto e trabalhar em coisas menores, incluindo a segunda revisão/edição, se necessário, para deixar a documentação pronta para envio.