designing documentation for developer products
DESCRIPTION
These slides belong to the original blog post on: http://blog.codeship.io/2014/09/11/designing-documentation-for-developer-products.html There are a few extremely important things to focus on when designing a Documentation for a Developer Product. Getting the correct information to the reader as quickly as possible is key. These slides by Codeship Support Engeneer Marko Locher explain how to create a quickly accessible, very readable and easily digestible documentation.TRANSCRIPT
Codeship Documentationhttps://codeship.io/documentation/
Who is Marko?» Support Deckhand
@Codeship
» @mlocher on both, Twitter and GitHub
» Likes sailing, skiing and volleyball
Old vs New
Problems with old» Lots of visual clutter
» Search is hidden at the top
» Content doesn't stand out
Goals» Use the search, Luke ;)
» Frictionless design
» Easy to contribute to
Use the search, Luke» Quickly find specific content
» Available on every page
» powered by Swiftype
No Distractions» Content is king!
» No unnecessary elements, sidebars…
» Focus on readability
Technology Stack» Jekyll, a static site generator by the
folks at GitHub
» Rig, a CSS framework by Codeship
» Markdown
» Codeship, what else, for testing, building & deploying
OpenSource» https://github.com/codeship/
documentation/
» MIT Licensed
See something that needs my attention? Message @mlocher on Twitter
“Always keep shipping!”