Style Guide Tutorials

content/hacking/01.software/ArduinoStyleGuide/ArduinoStyleGuide.md → content/learn/08.contributions/00.arduino-writing-style-guide/arduino-writing-style-guide.md

@@ -1,13 +1,15 @@
 ---
-title: 'Arduino Style Guide'
+title: 'Arduino Style Guide for Writing Content'
 description: 'Learn how to write clear Arduino examples that can be read by beginners and advanced users alike.'
 tags: 
-  - Style Guide
+  - Styleguide
   - Guidelines
 ---
 
 
-This is a guide for writing clear Arduino examples that can be read by beginners and advanced users alike. You don't have to code this way, but it helps if you want your code to be clear to all levels of users. This is not a set of hard and fast rules, it's a set of guidelines. Some of these guidelines might even conflict with each other. Use your judgment on when they're best followed, and if you're not sure, ask someone who'll be learning from what you write what makes the most sense. You might also be interested in the API Style Guide for Arduino.
+This is a guide for writing clear Arduino examples that can be read by beginners and advanced users alike. You don't have to code this way, but it helps if you want your code to be clear to all levels of users. This is not a set of hard and fast rules, it's a set of guidelines. Some of these guidelines might even conflict with each other. Use your judgment on when they're best followed, and if you're not sure, ask someone who'll be learning from what you write what makes the most sense. You might also be interested in the [Arduino Style Guide for Creating Libraries](/learn/contributions/arduino-library-style-guide).
+
+If you want to contribute with content for the Arduino Documentation website, please find instructions in the contribution-templates folder in the [Arduino Documentation repository](https://github.com/arduino/docs-content).
 
 ## Writing a tutorial
 

content/learn/08.contributions/01.arduino-library-style-guide/arduino-library-style-guide.md

@@ -0,0 +1,74 @@
+---
+title: 'Arduino Style Guide for Creating Libraries'
+description: 'Learn how to write library APIs in an Arduino style.'
+tags: 
+  - Styleguide
+  - Guidelines
+---
+
+This is a style guide to writing library APIs in an Arduino style. Some of these run counter to professional programming practice. We’re aware of that, but it’s what’s made it possible for so many beginners to get started with Arduino easily. So please code with these principles in mind. If you have suggestions on how to make Arduino libraries clearer for that core audience, please jump in the discussion.
+
+**Be kind to the end user.** Assume you are writing an API for an intelligent person who has not programmed before. Come up with a clear mental model of the concept you’re working with, and the terms and functions you will use.
+
+**Match your API to the underlying capabilities.** You don’t want to expose implementation details to the user but you also don’t want an API that suggests an inaccurate mental model of the possibilities. For example, if there are only a few possible options for a particular setting, don’t use a function that takes an int, as it implies you can use any value you want.
+
+**Organize your public functions around the data and functionality that the user wants.** Quite often, the command set for a particular electronic module is overly complicated for the most common uses, or can be re-organized around higher level functionality. Think about what the average person thinks the thing does, and try to organise your API functions around that. Adafruit's [BMP085 library](https://github.com/adafruit/Adafruit-BMP085-Library) is a good example. The `readPressure()` function performs all the necessary steps to get the final pressure. The library wraps this commonly executed series of functions into a high-level single command which returns the value the user's looking for in a format she expects. It abstracts away not only the low-level I2C commands, but also the mid-level temperature and pressure calculations, while still offering those mid-level functions as public functions for those who want them.
+
+**Use full, everyday words.** Don’t be terse with your function names or variables. Use everyday terms instead of technical ones. Pick terms that correspond to popular perception of the concept at hand. Don’t assume specialized knowledge. For example, this is why we used `analogWrite()` rather than `pwm()`. Abbreviations are acceptable, though, if they’re in common use or are the primary name for something. For example, “HTML” is relatively common and “SPI” is effectively the name of that protocol (“serial-peripheral interface” is probably too long). (“Wire” was probably a mistake, as the protocol it uses is typically called “TWI” or “I2C”.)
+
+**Avoid words that have different meanings to the general public.** For example, to programmers, an error is a notification that something happened. To the general public, errors are bad things.
+
+**When you have to use a domain-specific term, write a sentence or two describing it to the general public FIRST.** You’ll likely come across a better term, and if not, you’ll have started the documentation on your library.
+
+**Document and comment as you go.** When writing examples and documentation, follow the [Writing Style Guide](/learn/contributions/arduino-writing-style-guide)
+
+**Use the established core libraries and styles.**
+
+* Use `read()` to read inputs, and `write()` to write to outputs, e.g. `digitalRead()`, `analogWrite()`, etc.
+* Use the `Stream` and `Print` classes when dealing with byte streams. If it’s not appropriate, at least try to use its API as a model. For more on this, see below
+* For network applications, use the `Client` and `Server` classes as the basis.
+* Use `begin()` to initialize a library instance, usually with some settings. Use `end()` to stop it.
+* Use camel case function names, not underscore. For example, **analogRead**, not **analog_read**. Or **myNewFunction**, not **my_new_function**. We've adopted this from Processing.org for readability's sake.
+
+**LONG_CONSTANT_NAMES_FULL_OF_CAPS are hard to read.** Try to simplify when possible, without being terse.
+
+**Try to avoid boolean arguments.** Instead, consider providing two different functions with names the describe the differences between them.
+
+**Don’t assume knowledge of pointers.** Beginning users of C find this the biggest roadblock, and get very confused by `&` and `*`, so whenever you can avoid having them hanging out in the API, do so. One way is to pass by reference using array notation rather than `*` notation, for example.
+
+```arduino
+void printArray(char* array);
+```
+
+can be replaced by
+
+```arduino
+void printArray(char[] array);
+```
+
+Though there are some libraries where we pass pointers by using structures like const chars, avoid anything that requires the user to pass them. For example,rather than:
+
+```arduino
+  foo.readAccel(&x, &y, &z);
+```
+
+use something like this:
+
+```arduino
+  xAxis = adxl.readX();
+  yAxis = adxl.readY();
+  zAxis = adxl.readZ();
+```
+
+When using serial communication, allow the user to specify any `Stream` object, rather than hard-coding `Serial`. This will make your library compatible with all serial ports on boards with multiple (e.g., Mega), and can also use alternate interfaces like SoftwareSerial. The Stream object can be passed to your library's constructor or to a `begin()` function (as a reference, not a pointer). See [Firmata 2.3](http://www.firmata.org/wiki/Main_Page) or [XBee 0.4](https://github.com/andrewrapp/xbee-arduino) for examples of each approach.
+
+When writing a library that provides byte-stream communication, inherit Arduino's `Stream` class, so your library can be used with all other libraries that accept `Stream` objects. If possible, buffer incoming data, so that `read()` immediately accesses the buffer but does not wait for more data to arrive. If possible, your `write()` method should store data to a transmit buffer, but `write()` must wait if the buffer does not have enough space to immediately store all outgoing data. The `yield()` function should be called while waiting.
+
+Here are a few libraries that are exemplary from Adafruit. She breaks the functions of the devices down into their high-level activities really well. 
+
+* https://github.com/adafruit/Adafruit-BMP085-Library 
+* https://github.com/adafruit/DHT-sensor-library 
+
+This does a nice job of abstracting from the Wire (I2C) library: https://github.com/adafruit/RTClib 
+
+The text of the Arduino reference is licensed under a [Creative Commons Attribution-ShareAlike 3.0 License](http://creativecommons.org/licenses/by-sa/3.0/). Code samples in the reference are released into the public domain.