Esta página contém os detalhes de um projeto de escrita técnica aceito para o Temporada dos Documentos Google.
Resumo do projeto
- Organização de código aberto:
- Arduino
- Redator técnico:
- AghaSaad04
- Nome do projeto:
- Documentar bibliotecas de terceiros
- Duração do projeto:
- Duração padrão (três meses)
Project description
Sou um escritor técnico experiente. Há mais de três anos, escrevo documentação de software de alta qualidade, guias do usuário, manuais, análises de algoritmos, documentação de projetos e artigos de pesquisa. Neste projeto, vou documentar todas as bibliotecas de terceiros. Meu objetivo é documentar as bibliotecas que foram criadas e contribuídas pelo Arduino para expor todo o potencial delas aos desenvolvedores. As seguintes tarefas serão realizadas:
Documentar o funcionamento da biblioteca Documentar como melhorar as bibliotecas para que elas atendam às necessidades necessárias
Por exemplo
A biblioteca NESController do Arduino precisa ser bem documentada. Os recursos, a compatibilidade, os exemplos e as aplicações precisam ser adicionados à documentação para os colaboradores. O uso já foi mencionado na documentação e pode ser melhorado. O nbiot-arduino é uma biblioteca Arduino para acessar módulos NBIoT. A documentação pode ser melhorada estendendo as opções de uso, build e teste e depuração. Exemplos com snippets de código também precisam ser incluídos. A biblioteca ArduinoJson, que tem mais estrelas no Arduino, tem uma documentação bem detalhada, com exemplos mostrando como usar a biblioteca em várias estações, a referência da API, que contém a descrição de cada classe e função, perguntas frequentes que respondem a praticamente todas as perguntas e o AduinoJson Assistant, que escreve programas para os usuários, estão incluídos na documentação. Da mesma forma, a documentação detalhada precisa ser feita para todas as bibliotecas que precisam de melhorias e extensões. Tenho experiência na área de Internet das Coisas (IoT) e conhecimento básico sobre microcontroladores. Tenho proficiência em várias linguagens de programação, incluindo Python, Java, C, C++, HTML5, JavaScript e C#. Estou muito interessado e disposto a contribuir com a Arduino por meio das minhas habilidades técnicas de escrita e do conhecimento sobre eletrônicos, microcontroladores e programação. Estou ansiosa para aprender mais e aprimorar minhas habilidades e conhecimentos.
Vou usar o Markdown para estilizar todos os meus textos devido à sintaxe fácil de usar e ao amplo conjunto de recursos.
Modelo
Esse é um dos modelos que podem ser usados para a documentação. Ela pode ser modificada e novas seções podem ser adicionadas de acordo com os requisitos do documento.
$projectName/Library Name
--------
In this section, I will give background information of the library,
what does this library use, on what languages and framework it is based on,
what are the dependencies of this library/project where it will be used
Features
--------
I will add features of the project here like
- this library creates connection between server and client
- Make things faster
Installation
------------
In this section I will add the installation procedure and dependencies that
needs to be installed.
Install $project by running:
install project
Contribute
----------
For the contributors, I will add this section in documentation.
- Issue Tracker: github.com/$project/$project/issues
- Source Code: github.com/$project/$project
Support
-------
This section can also be added
If you are having issues, please let us know.
We have a mailing list located at: project@google-groups.com
License
-------
This section will tell about the license of the project.
This project is licensed under the BSD.
Compromisso com o tempo e comunicação
Darei mais de 45 horas por semana, mas, em caso de problemas, compensarei por elas nos fins de semana.Durante o período de vínculo com a comunidade, discutirei os meios de comunicação e finalizarei as reuniões semanais, os meios e o tempo para essas reuniões com meu mentor. Vou manter meu mentor atualizado sobre meu trabalho e compartilhar os detalhes por e-mail. Prefiro o Team Viewer para me comunicar, já que é fácil de usar com muitos recursos como telas de compartilhamento etc.
Planos futuros
Meus planos futuros estão muito claros, depois do GSoD'19. Vou continuar contribuindo com a organização em outros projetos também. Vou tentar aperfeiçoar todos os aspectos, desde a documentação até a segurança. Com certeza, vou participar de qualquer reunião da organização se tiver a chance.
Termos e Condições
Concordo solenemente que trabalharei da mesma maneira que expliquei acima e, em caso de aborto, serei responsabilizado. Entendo a dedicação necessária para este projeto e garanto que estou dedicando toda a minha temporada a ele para oferecer o melhor trabalho.
Agradeço por ler toda a proposta. Entre em contato se tiver mais dúvidas.