Gustavo Niemeyer edited this page Oct 8, 2016 · 3 revisions


Welcome to the snapd documentation wiki!

Choose a topic on the right sidebar. =>

Writing guidelines

Please feel free to modify any of the documents here with updated or more insightful information. You don't need permission from anyone to do that. Go ahead and fix that typo, add a section, or even a new page. Others will join in and help finishing what you start, or reorganizing it if necessary.

Before creating a new page, please consider whether the content would fit well in an existing page, and try not to make super specific pages, but rather a section inside a more general one (Installing => Basics).

It's okay to be informal here - we're not writing an essay. The goal is providing insight in a pleasant form to produce and consume, and to be pragmatic enough for people to feel encouraged to maintain this documentation opportunistically.

That said, please try to make the content pleasant to read, with proper punctuation and capitalization. Being terse rather than verbose tends to be a good idea as well, as it forces the writer to focus on the point being made. Assume you're explaining something to an intelligent reader.

If you are adding information about a feature that is still in development, please remember to tag it with with the appropriate version in which it will become valid, in the format (snapd 2.15+), so that readers know when they can start using it.

When you're in a rush but would like to hint at something that is coming, tag the section/example/etc with (WRITE ME).

Have fun, and if you need anything, please get in touch via snapcraft@snapcraft.io or #snappy in Freenode.