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:
- 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. Escrevo documentação de software de alta qualidade, guias do usuário, manuais, análise de algoritmo, documentação de projetos, trabalho de pesquisa há mais de três anos. Neste projeto, vou documentar todas as bibliotecas de terceiros. Meu objetivo é documentar as bibliotecas criadas pelo Arduino e que tenham contribuído 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. Os recursos, a compatibilidade, os exemplos e os aplicativos precisam ser adicionados à documentação para os colaboradores. O uso já foi mencionado na documentação, e isso pode ser ainda melhor. O Nbiot-arduino é uma biblioteca Arduino para acessar módulos NBIoT. A documentação pode ser melhorada ampliando as opções de uso, build e teste, depuração. Exemplos com snippets de código também precisam ser incluídos. A biblioteca mais famosa do Arduino, ArduinoJson, é bem documentada com 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 grava 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 cuja documentação precisa ser aprimorada e ampliada. Por ter experiência na área de Internet das Coisas (IoT), 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, programação. Quero muito aprender e aprimorar minhas habilidades e conhecimentos.
Vou usar o Markdown para estilizar toda a minha escrita devido à sua sintaxe fácil de usar e ao amplo conjunto de recursos.
Modelo
Esse é um dos modelos que podem ser usados para a 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
Darei mais de 45 horas por semana, mas, em caso de problemas, compensarei essas horas nos fins de semana.Durante o período de vínculo com a comunidade, discuto os meios de comunicação e finalizo as reuniões semanais, meios e tempo para essas reuniões com meu mentor. Vou manter meu mentor atualizado sobre meu trabalho e compartilhar os detalhes de trabalho por e-mail com ele. Prefiro o Team Viewer para a comunicação, já que é fácil de usar e com muitos recursos como telas de compartilhamento, etc.
Planos futuros
Meus planos futuros estão muito claros depois do GSoD de 2019. Vou continuar contribuindo com a organização em outros projetos também. Vou tentar fazer com que ele seja perfeito em todos os aspectos, da perspectiva da documentação à segurança. Se eu tiver uma oportunidade, com certeza participarei de qualquer reunião da organização.
Termos e Condições
Eu 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 este projeto para que eu possa fornecer o melhor trabalho.
Agradecemos por ler toda a proposta. Entre em contato se tiver outras dúvidas.