Esta página contém os detalhes de um projeto de redação técnica aceito para a temporada de documentos do 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 (3 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álise de algoritmos, documentação de projetos e artigos de pesquisa. Neste projeto, vou documentar todas as bibliotecas de terceiros. Meu objetivo é documentar as bibliotecas criadas e contribuídas com o Arduino para que todo o potencial delas seja exposto aos desenvolvedores. Vou realizar as seguintes tarefas:
Documentar o funcionamento da biblioteca Documentar como melhorar as bibliotecas para fazer com que elas atendam às necessidades necessárias
Por exemplo
A biblioteca NESController do Arduino precisa ser bem documentada. Seus recursos, compatibilidade, exemplos e aplicativos devem ser adicionados à documentação para seus colaboradores. O uso já foi mencionado na documentação, o que pode ser melhorado. O Nbiot-arduino é uma biblioteca do Arduino para acessar módulos NBIoT. A documentação pode ser melhorada estendendo as opções de uso, compilação e teste, depuração. Exemplos com snippets de código também precisam ser incluídos. A biblioteca mais estrelada do Arduino, ArduinoJson, é bem documentada como exemplos que mostram como usar a biblioteca em várias estações, a Referência da API com 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á incluído na documentação. Da mesma forma, documentação detalhada deve ser feita para todas as bibliotecas cuja documentação precise ser melhorada e estendida. Como tenho experiência na área de Internet das Coisas (IoT, na sigla em inglês), tenho o 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 o Arduino por meio das minhas habilidades técnicas de escrita e do conhecimento sobre eletrônicos, microcontroladores e programação. Quero muito aprender e desenvolver minhas habilidades.
Usarei o Markdown para estilizar toda a minha escrita devido à sintaxe fácil de usar e ao amplo conjunto de recursos.
Modelo
Esse é um dos modelos que podem ser usados na documentação. Ele pode ser modificado 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.
Tempo dedicado e comunicação
Farei mais de 45 horas por semana, mas, em caso de contratempo, compensarei essas horas nos fins de semana.Durante o período de vínculo comunitário, vou discutir meios de comunicação e finalizar reuniões semanais, meios e tempo para essas reuniões com meu mentor. Vou manter o mentor atualizado sobre meu trabalho e compartilhar os detalhes do trabalho por e-mail com ele. Prefiro o Team Viewer para comunicação, porque é fácil de usar e com muitos recursos como telas de compartilhamento etc.
Planos futuros
Meus planos para o futuro estão muito claros, depois do GSoD 2019. Vou continuar contribuindo com a organização em outros projetos também. Tentarei torná-lo perfeito em todos os aspectos, da perspectiva da documentação à perspectiva de segurança. Com certeza participarei de qualquer reunião da organização se tiver a oportunidade.
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 vou dedicar toda a minha temporada a ele para que eu possa fornecer o melhor trabalho.
Agradecemos por ler a proposta completa. Entre em contato se tiver outras dúvidas.