GithubHelp home page GithubHelp logo

isabella232 / season-of-docs-1 Goto Github PK

View Code? Open in Web Editor NEW

This project forked from arduino/season-of-docs

0.0 0.0 0.0 31 KB

Arduino and Google's Season of Docs 2019

Home Page: https://developers.google.com/season-of-docs/

season-of-docs-1's Introduction

Arduino and Google's Season of Docs 2019

(Excerpt from Google's Season of Docs introduction)

The goal of Season of Docs is to provide a framework for technical writers and open source projects to work together towards the common goal of improving an open source project's documentation. For technical writers who are new to open source, the program provides an opportunity to gain experience in contributing to open source projects. For technical writers who're already working in open source, the program provides a potentially new way of working together. Season of Docs also gives open source projects an opportunity to engage more of the technical writing community. During the program, technical writers spend a few months working closely with an open source community. They bring their technical writing expertise to the project's documentation, and at the same time learn about the open source project and new technologies. The open source projects work with the technical writers to improve the project's documentation and processes. Together they may choose to build a new documentation set, or redesign the existing docs, or improve and document the open source community's contribution procedures and onboarding experience.

Together, we raise public awareness of open source docs, of technical writing, and of how we can work together to the benefit of the global open source community.

Read more on Season Of Docs' official website.

We are all about content.

Well, we also make impeccable boards, great software, and fabulous speeches โ€ฆ but the content is what glues all of the others together. We need to continue to produce nice examples, flawless technical docs, clean translations, and readable code-comments.

How far will this take us?

Making the best for our users, helping them reach their goals, whether it is prototypes, industrial machines, a Jedi sword, or laboratory-grade equipment, it is only possible because of documentation. Good libraries help people add new devices to our boards, good documentation helps people improve their results. The question is, how can we enroll others to make this work in a systemic-planned way? Being part of the Season of Docs initiative is a good opportunity for us to formulate what needs to be done and get some help in documenting parts of our open source projects.

Project ideas

Project ideas are suggestions from Arduino for projects that a technical writer can complete in collaboration with a mentor during Season of Docs. The list is published here.

Project mentors

Contact us

Many things are still in the making, but you can reach out to Arduino's Team via e-mail at any time: <[email protected]>.

season-of-docs-1's People

Contributors

animeshsrivastava24 avatar kn-neelalohitha avatar kylelobo avatar per1234 avatar simonepda avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.